2017-07-17 17:59:14 +10:00
|
|
|
/************************************************************************
|
|
|
|
* This file has been generated automatically from *
|
|
|
|
* *
|
|
|
|
* src/gui/layout/qgslayoutnewitempropertiesdialog.h *
|
|
|
|
* *
|
|
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-07-18 12:02:55 +10:00
|
|
|
class QgsLayoutItemPropertiesDialog : QDialog
|
2017-07-17 17:59:14 +10:00
|
|
|
{
|
|
|
|
%Docstring
|
2018-05-26 14:10:30 +10:00
|
|
|
A dialog for configuring properties like the size and position of layout items.
|
2017-07-18 12:02:55 +10:00
|
|
|
|
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.
|
2017-07-18 12:02:55 +10:00
|
|
|
|
|
|
|
.. versionadded:: 3.0
|
2017-07-17 17:59:14 +10:00
|
|
|
%End
|
|
|
|
|
|
|
|
%TypeHeaderCode
|
|
|
|
#include "qgslayoutnewitempropertiesdialog.h"
|
|
|
|
%End
|
|
|
|
public:
|
|
|
|
|
2017-07-18 12:02:55 +10:00
|
|
|
QgsLayoutItemPropertiesDialog( QWidget *parent = 0, Qt::WindowFlags flags = 0 );
|
|
|
|
%Docstring
|
2017-12-19 11:43:52 -04:00
|
|
|
Constructor for :py:class:`QgsLayoutNewItemPropertiesDialog`.
|
2017-07-18 12:02:55 +10:00
|
|
|
%End
|
2017-07-17 17:59:14 +10:00
|
|
|
|
2017-07-18 12:02:55 +10:00
|
|
|
void setItemPosition( QgsLayoutPoint position );
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Sets the item ``position`` to show in the dialog.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`itemPosition`
|
2017-07-18 12:02:55 +10:00
|
|
|
%End
|
2017-07-17 17:59:14 +10:00
|
|
|
|
|
|
|
QgsLayoutPoint itemPosition() const;
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Returns the current item position defined by the dialog.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`setItemPosition`
|
2017-07-17 17:59:14 +10:00
|
|
|
%End
|
|
|
|
|
2017-10-27 15:14:35 +10:00
|
|
|
int page() const;
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Returns the page number for the new item.
|
2017-10-27 15:14:35 +10:00
|
|
|
%End
|
|
|
|
|
2017-07-18 12:02:55 +10:00
|
|
|
void setItemSize( QgsLayoutSize size );
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Sets the item ``size`` to show in the dialog.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`itemSize`
|
2017-07-18 12:02:55 +10:00
|
|
|
%End
|
|
|
|
|
2017-07-17 17:59:14 +10:00
|
|
|
QgsLayoutSize itemSize() const;
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Returns the item size defined by the dialog.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`setItemSize`
|
2017-07-17 17:59:14 +10:00
|
|
|
%End
|
|
|
|
|
2017-07-18 12:02:55 +10:00
|
|
|
QgsLayoutItem::ReferencePoint referencePoint() const;
|
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
Returns the item reference point defined by the dialog.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`setReferencePoint`
|
2017-07-18 12:02:55 +10:00
|
|
|
%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.
|
|
|
|
|
2018-01-09 17:26:37 -04:00
|
|
|
.. seealso:: :py:func:`referencePoint`
|
2017-07-18 12:02:55 +10:00
|
|
|
%End
|
|
|
|
|
2017-07-21 13:49:39 +10:00
|
|
|
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.
|
2017-07-21 13:49:39 +10:00
|
|
|
%End
|
|
|
|
|
2017-07-17 17:59:14 +10:00
|
|
|
};
|
|
|
|
|
|
|
|
/************************************************************************
|
|
|
|
* This file has been generated automatically from *
|
|
|
|
* *
|
|
|
|
* src/gui/layout/qgslayoutnewitempropertiesdialog.h *
|
|
|
|
* *
|
|
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
|
|
************************************************************************/
|