QGIS API Documentation 3.41.0-Master (cea29feecf2)
|
Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides. More...
#include <qgspropertyassistantwidget.h>
Public Member Functions | |
QgsPropertyAssistantWidget (QWidget *parent=nullptr, const QgsPropertyDefinition &definition=QgsPropertyDefinition(), const QgsProperty &initialState=QgsProperty(), const QgsVectorLayer *layer=nullptr) | |
Constructor for QgsPropertyAssistantWidget. | |
void | registerExpressionContextGenerator (QgsExpressionContextGenerator *generator) |
Register an expression context generator class that will be used to retrieve an expression context for the button when required. | |
void | setDockMode (bool dockMode) override |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. | |
void | setSymbol (std::shared_ptr< QgsSymbol > symbol) |
Sets a symbol which can be used for previews inside the widget. | |
void | updateProperty (QgsProperty &property) |
Updates a property in place to corresponding to the current settings shown in the widget. | |
Public Member Functions inherited from QgsPanelWidget | |
QgsPanelWidget (QWidget *parent=nullptr) | |
Base class for any widget that can be shown as a inline panel. | |
virtual bool | applySizeConstraintsToStack () const |
Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in. | |
bool | autoDelete () |
The the auto delete property on the widget. | |
void | connectChildPanel (QgsPanelWidget *panel) |
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. | |
void | connectChildPanels (const QList< QgsPanelWidget * > &panels) |
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. | |
bool | dockMode () |
Returns the dock mode state. | |
virtual QMenu * | menuButtonMenu () |
Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. | |
virtual QString | menuButtonTooltip () const |
Returns the (translated) tooltip text to use for the menu button for this panel. | |
QString | panelTitle () |
The title of the panel. | |
void | setAutoDelete (bool autoDelete) |
The the auto delete property on the widget. | |
void | setPanelTitle (const QString &panelTitle) |
Set the title of the panel when shown in the interface. | |
Additional Inherited Members | |
Public Slots inherited from QgsPanelWidget | |
void | acceptPanel () |
Accept the panel. | |
void | openPanel (QgsPanelWidget *panel) |
Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. | |
Signals inherited from QgsPanelWidget | |
void | panelAccepted (QgsPanelWidget *panel) |
Emitted when the panel is accepted by the user. | |
void | showPanel (QgsPanelWidget *panel) |
Emit when you require a panel to be show in the interface. | |
void | widgetChanged () |
Emitted when the widget state changes. | |
Static Public Member Functions inherited from QgsPanelWidget | |
static QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
Protected Member Functions inherited from QgsPanelWidget | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides.
Definition at line 106 of file qgspropertyassistantwidget.h.
QgsPropertyAssistantWidget::QgsPropertyAssistantWidget | ( | QWidget * | parent = nullptr , |
const QgsPropertyDefinition & | definition = QgsPropertyDefinition() , |
||
const QgsProperty & | initialState = QgsProperty() , |
||
const QgsVectorLayer * | layer = nullptr |
||
) |
Constructor for QgsPropertyAssistantWidget.
Aside from a parent widget, the constructor accepts a corresponding property definition from which it customizes 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.
Definition at line 34 of file qgspropertyassistantwidget.cpp.
void QgsPropertyAssistantWidget::registerExpressionContextGenerator | ( | QgsExpressionContextGenerator * | generator | ) |
Register an expression context generator class that will be used to retrieve an expression context for the button when required.
Definition at line 143 of file qgspropertyassistantwidget.cpp.
|
overridevirtual |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
dockMode | true to enable dock mode. |
Reimplemented from QgsPanelWidget.
Definition at line 172 of file qgspropertyassistantwidget.cpp.
|
inline |
Sets a symbol which can be used for previews inside the widget.
If not specified, default created symbols will be used instead.
Definition at line 137 of file qgspropertyassistantwidget.h.
void QgsPropertyAssistantWidget::updateProperty | ( | QgsProperty & | property | ) |
Updates a property in place to corresponding to the current settings shown in the widget.
Definition at line 149 of file qgspropertyassistantwidget.cpp.