|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
A base class for property widgets for layout items. More...
#include <qgslayoutitemwidget.h>
Public Member Functions | |
| QgsLayoutItemBaseWidget (QWidget *parent SIP_TRANSFERTHIS, QgsLayoutObject *layoutObject) | |
| Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject. More... | |
| QgsLayoutObject * | layoutObject () |
| Returns the layout object associated with this widget. More... | |
| bool | setItem (QgsLayoutItem *item) |
| Sets the current item to show in the widget. More... | |
| virtual void | setReportTypeString (const QString &string) |
| Sets the string to use to describe the current report type (e.g. More... | |
 Public Member Functions inherited from QgsPanelWidget | |
| QgsPanelWidget (QWidget *parent=nullptr) | |
| Base class for any widget that can be shown as a inline panel. More... | |
| bool | autoDelete () |
| The the auto delete property on the widget. More... | |
| 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. More... | |
| 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. More... | |
| bool | dockMode () |
| Returns the dock mode state. More... | |
| QString | panelTitle () |
| The title of the panel. More... | |
| void | setAutoDelete (bool autoDelete) |
| The the auto delete property on the widget. More... | |
| virtual void | setDockMode (bool dockMode) |
| Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More... | |
| void | setPanelTitle (const QString &panelTitle) |
| Set the title of the panel when shown in the interface. More... | |
Protected Member Functions | |
| QgsVectorLayer * | coverageLayer () const |
| Returns the current layout context coverage layer (if set). More... | |
| QgsLayoutAtlas * | layoutAtlas () const |
| Returns the atlas for the layout (if available) More... | |
| void | registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty property) |
| Registers a data defined button, setting up its initial value, connections and description. More... | |
| virtual bool | setNewItem (QgsLayoutItem *item) |
| Attempts to update the widget to show the properties for the specified item. More... | |
| void | updateDataDefinedButton (QgsPropertyOverrideButton *button) |
| Updates a previously registered data defined button to reflect the item's current properties. More... | |
| Protected Member Functions inherited from QgsPanelWidget | |
| void | keyPressEvent (QKeyEvent *event) override |
| Overridden key press event to handle the esc event on the widget. More... | |
Additional Inherited Members | |
| Public Slots inherited from QgsPanelWidget | |
| void | acceptPanel () |
| Accept the panel. More... | |
| 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. More... | |
| Signals inherited from QgsPanelWidget | |
| void | panelAccepted (QgsPanelWidget *panel) |
| Emitted when the panel is accepted by the user. More... | |
| void | showPanel (QgsPanelWidget *panel) |
| Emit when you require a panel to be show in the interface. More... | |
| void | widgetChanged () |
| Emitted when the widget state changes. More... | |
| 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. More... | |
A base class for property widgets for layout items.
All layout item widgets should inherit from this base class.
Definition at line 120 of file qgslayoutitemwidget.h.
| QgsLayoutItemBaseWidget::QgsLayoutItemBaseWidget | ( | QWidget *parent | SIP_TRANSFERTHIS, |
| QgsLayoutObject * | layoutObject | ||
| ) |
Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject.
Definition at line 144 of file qgslayoutitemwidget.cpp.
|
protected |
Returns the current layout context coverage layer (if set).
Definition at line 193 of file qgslayoutitemwidget.cpp.
|
protected |
Returns the atlas for the layout (if available)
Definition at line 203 of file qgslayoutitemwidget.cpp.
| QgsLayoutObject * QgsLayoutItemBaseWidget::layoutObject | ( | ) |
Returns the layout object associated with this widget.
Definition at line 152 of file qgslayoutitemwidget.cpp.
|
protected |
Registers a data defined button, setting up its initial value, connections and description.
The corresponding property key must be specified.
Definition at line 183 of file qgslayoutitemwidget.cpp.
| bool QgsLayoutItemBaseWidget::setItem | ( | QgsLayoutItem * | item | ) |
Sets the current item to show in the widget.
If true is returned, item was an acceptable type for display in this widget and the widget has been updated to match item's properties.
If false is returned, then the widget could not be successfully updated to show the properties of item.
Definition at line 157 of file qgslayoutitemwidget.cpp.
|
protectedvirtual |
Attempts to update the widget to show the properties for the specified item.
Subclasses can override this if they support changing items in place.
Implementations must return true if the item was accepted and the widget was updated.
Definition at line 198 of file qgslayoutitemwidget.cpp.
|
virtual |
Sets the string to use to describe the current report type (e.g.
"atlas" or "report"). Subclasses which display this text to users should override this and update their widget labels accordingly.
Definition at line 179 of file qgslayoutitemwidget.cpp.
|
protected |
Updates a previously registered data defined button to reflect the item's current properties.
Definition at line 188 of file qgslayoutitemwidget.cpp.
1.8.11
