QGIS/python/gui/auto_generated/qgspropertyassistantwidget.sip.in

65 lines
2.5 KiB
Plaintext
Raw Normal View History

2017-06-08 11:26:03 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgspropertyassistantwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsPropertyAssistantWidget : QgsPanelWidget
2017-02-02 07:29:19 +10:00
{
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides.
2017-06-08 11:26:03 +02:00
.. versionadded:: 3.0
2017-02-02 07:29:19 +10:00
%End
2017-06-08 11:26:03 +02:00
%TypeHeaderCode
#include "qgspropertyassistantwidget.h"
%End
2017-02-02 07:29:19 +10:00
public:
2017-06-08 11:26:03 +02:00
QgsPropertyAssistantWidget( QWidget *parent /TransferThis/ = 0,
const QgsPropertyDefinition &definition = QgsPropertyDefinition(),
const QgsProperty &initialState = QgsProperty(),
const QgsVectorLayer *layer = 0 );
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsPropertyAssistantWidget. Aside from a ``parent`` widget, the constructor accepts a
corresponding property ``definition`` from which it customises the displayed options (eg a color based
property definition will show an assistant to allow creation of color based properties).
The ``initialState`` dictates the initial state to show in the widget. A corresponding ``layer``
can also be set to allow population of GUI widgets such as field selectors.
2017-06-08 11:26:03 +02:00
%End
2017-02-02 07:29:19 +10:00
void registerExpressionContextGenerator( QgsExpressionContextGenerator *generator );
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Register an expression context generator class that will be used to retrieve
an expression context for the button when required.
2017-06-08 11:26:03 +02:00
%End
2017-02-14 08:32:01 +10:00
void updateProperty( QgsProperty &property );
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Updates a ``property`` in place to corresponding to the current settings shown
in the widget.
2017-06-08 11:26:03 +02:00
%End
virtual void setDockMode( bool dockMode );
2017-02-02 07:29:19 +10:00
2017-02-14 08:32:01 +10:00
};
2017-06-08 11:26:03 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgspropertyassistantwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/