QGIS API Documentation 3.39.0-Master (3783037d301)
|
Input widget for the configuration of QgsLayoutItemMap. More...
#include <qgslayoutmapwidget.h>
Public Member Functions | |
QgsLayoutMapWidget (QgsLayoutItemMap *item, QgsMapCanvas *mapCanvas) | |
constructor | |
void | setDesignerInterface (QgsLayoutDesignerInterface *iface) override |
Sets the the layout designer interface in which the widget is being shown. | |
void | setMasterLayout (QgsMasterLayoutInterface *masterLayout) override |
Sets the master layout associated with the item. | |
void | setReportTypeString (const QString &string) override |
Sets the string to use to describe the current report type (e.g. | |
Public Member Functions inherited from QgsLayoutItemBaseWidget | |
QgsLayoutItemBaseWidget (QWidget *parent SIP_TRANSFERTHIS, QgsLayoutObject *layoutObject) | |
Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject. | |
QgsLayoutObject * | layoutObject () |
Returns the layout object associated with this widget. | |
bool | setItem (QgsLayoutItem *item) |
Sets the current item to show 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. | |
virtual void | setDockMode (bool dockMode) |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. | |
void | setPanelTitle (const QString &panelTitle) |
Set the title of the panel when shown in the interface. | |
Protected Slots | |
void | populateDataDefinedButtons () |
Initializes data defined buttons to current atlas coverage layer. | |
Protected Member Functions | |
bool | setNewItem (QgsLayoutItem *item) override |
Attempts to update the widget to show the properties for the specified item. | |
Protected Member Functions inherited from QgsLayoutItemBaseWidget | |
QgsVectorLayer * | coverageLayer () const |
Returns the current layout context coverage layer (if set). | |
QgsLayoutAtlas * | layoutAtlas () const |
Returns the atlas for the layout (if available) | |
void | registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty property) |
Registers a data defined button, setting up its initial value, connections and description. | |
void | updateDataDefinedButton (QgsPropertyOverrideButton *button) |
Updates a previously registered data defined button to reflect the item's current properties. | |
Protected Member Functions inherited from QgsPanelWidget | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
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. | |
Input widget for the configuration of QgsLayoutItemMap.
Definition at line 45 of file qgslayoutmapwidget.h.
|
explicit |
constructor
Definition at line 42 of file qgslayoutmapwidget.cpp.
|
protectedslot |
Initializes data defined buttons to current atlas coverage layer.
Definition at line 271 of file qgslayoutmapwidget.cpp.
|
overridevirtual |
Sets the the layout designer interface in which the widget is being shown.
Reimplemented from QgsLayoutItemBaseWidget.
Definition at line 233 of file qgslayoutmapwidget.cpp.
|
overridevirtual |
Sets the master layout associated with the item.
Reimplemented from QgsLayoutItemBaseWidget.
Definition at line 215 of file qgslayoutmapwidget.cpp.
|
overrideprotectedvirtual |
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.
Reimplemented from QgsLayoutItemBaseWidget.
Definition at line 239 of file qgslayoutmapwidget.cpp.
|
overridevirtual |
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.
Reimplemented from QgsLayoutItemBaseWidget.
Definition at line 221 of file qgslayoutmapwidget.cpp.