QGIS/python/gui/layout/qgslayoutnewitempropertiesdialog.sip

96 lines
2.8 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutnewitempropertiesdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemPropertiesDialog : QDialog
{
%Docstring
A dialog for configuring properties like the size and position of layout items.
2017-12-15 10:36:55 -04:00
This is usually used only when constructing new layout items, allowing users to precisely
enter their sizes and positions.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutnewitempropertiesdialog.h"
%End
public:
QgsLayoutItemPropertiesDialog( QWidget *parent = 0, Qt::WindowFlags flags = 0 );
%Docstring
2017-12-19 11:43:52 -04:00
Constructor for :py:class:`QgsLayoutNewItemPropertiesDialog`.
%End
void setItemPosition( QgsLayoutPoint position );
%Docstring
2017-12-15 10:36:55 -04:00
Sets the item ``position`` to show in the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`itemPosition()`
%End
QgsLayoutPoint itemPosition() const;
%Docstring
2017-12-15 10:36:55 -04:00
Returns the current item position defined by the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`setItemPosition()`
%End
int page() const;
%Docstring
2017-12-15 10:36:55 -04:00
Returns the page number for the new item.
%End
void setItemSize( QgsLayoutSize size );
%Docstring
2017-12-15 10:36:55 -04:00
Sets the item ``size`` to show in the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`itemSize()`
%End
QgsLayoutSize itemSize() const;
%Docstring
2017-12-15 10:36:55 -04:00
Returns the item size defined by the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`setItemSize()`
%End
QgsLayoutItem::ReferencePoint referencePoint() const;
%Docstring
2017-12-15 10:36:55 -04:00
Returns the item reference point defined by the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`setReferencePoint()`
%End
void setReferencePoint( QgsLayoutItem::ReferencePoint point );
%Docstring
2017-12-15 10:36:55 -04:00
Sets the item reference ``point`` defined to show in the dialog.
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`referencePoint()`
%End
void setLayout( QgsLayout *layout );
%Docstring
2017-12-15 10:36:55 -04:00
Sets the ``layout`` associated with the dialog. This allows the dialog
to retrieve properties from the layout and perform tasks like automatic
conversion of units.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutnewitempropertiesdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/