QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Protected Slots | Protected Member Functions | List of all members
QgsLayoutMapWidget Class Reference

Input widget for the configuration of QgsLayoutItemMap. More...

#include <qgslayoutmapwidget.h>

Inheritance diagram for QgsLayoutMapWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutMapWidget (QgsLayoutItemMap *item, QgsMapCanvas *mapCanvas)
 constructor More...
 
void setDesignerInterface (QgsLayoutDesignerInterface *iface) override
 Sets the the layout designer interface in which the widget is being shown. More...
 
void setMasterLayout (QgsMasterLayoutInterface *masterLayout) override
 Sets the master layout associated with the item. More...
 
void setReportTypeString (const QString &string) override
 Sets the string to use to describe the current report type (e.g. More...
 
- Public Member Functions inherited from QgsLayoutItemBaseWidget
 QgsLayoutItemBaseWidget (QWidget *parent SIP_TRANSFERTHIS, QgsLayoutObject *layoutObject)
 Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject. More...
 
QgsLayoutObjectlayoutObject ()
 Returns the layout object associated with this widget. More...
 
virtual void setDesignerInterface (QgsLayoutDesignerInterface *iface)
 Sets the the layout designer interface in which the widget is being shown. More...
 
bool setItem (QgsLayoutItem *item)
 Sets the current item to show in the widget. More...
 
virtual void setMasterLayout (QgsMasterLayoutInterface *masterLayout)
 Sets the master layout associated with the item. 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...
 
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. 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...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. 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 Slots

void populateDataDefinedButtons ()
 Initializes data defined buttons to current atlas coverage layer. More...
 

Protected Member Functions

bool setNewItem (QgsLayoutItem *item) override
 Attempts to update the widget to show the properties for the specified item. More...
 
- Protected Member Functions inherited from QgsLayoutItemBaseWidget
QgsVectorLayercoverageLayer () const
 Returns the current layout context coverage layer (if set). More...
 
QgsLayoutAtlaslayoutAtlas () 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 QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 

Detailed Description

Input widget for the configuration of QgsLayoutItemMap.

Note
This class is not a part of public API
Since
QGIS 3.12

Definition at line 45 of file qgslayoutmapwidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutMapWidget()

QgsLayoutMapWidget::QgsLayoutMapWidget ( QgsLayoutItemMap item,
QgsMapCanvas mapCanvas 
)
explicit

constructor

Definition at line 42 of file qgslayoutmapwidget.cpp.

Member Function Documentation

◆ populateDataDefinedButtons

void QgsLayoutMapWidget::populateDataDefinedButtons ( )
protectedslot

Initializes data defined buttons to current atlas coverage layer.

Definition at line 270 of file qgslayoutmapwidget.cpp.

◆ setDesignerInterface()

void QgsLayoutMapWidget::setDesignerInterface ( QgsLayoutDesignerInterface iface)
overridevirtual

Sets the the layout designer interface in which the widget is being shown.

Since
QGIS 3.6

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 232 of file qgslayoutmapwidget.cpp.

◆ setMasterLayout()

void QgsLayoutMapWidget::setMasterLayout ( QgsMasterLayoutInterface masterLayout)
overridevirtual

Sets the master layout associated with the item.

Since
QGIS 3.10

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 214 of file qgslayoutmapwidget.cpp.

◆ setNewItem()

bool QgsLayoutMapWidget::setNewItem ( QgsLayoutItem item)
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 238 of file qgslayoutmapwidget.cpp.

◆ setReportTypeString()

void QgsLayoutMapWidget::setReportTypeString ( const QString &  string)
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 220 of file qgslayoutmapwidget.cpp.


The documentation for this class was generated from the following files: