QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
Signals | Public Member Functions | List of all members
QgsCalloutPanelWidget Class Reference

A panel widget for configuration of callouts. More...

#include <qgscalloutpanelwidget.h>

Inheritance diagram for QgsCalloutPanelWidget:
Inheritance graph
[legend]

Signals

void calloutChanged ()
 Emitted when the callout defined by the widget changes.
 
- 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.
 

Public Member Functions

 QgsCalloutPanelWidget (QWidget *parent=nullptr, QgsMapLayer *layer=nullptr)
 Constructor for QgsCalloutPanelWidget, with the specified parent widget.
 
QgsCalloutcallout ()
 Returns a new callout, respecting the configuration from the widget.
 
QgsSymbolWidgetContext context () const
 Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
 
Qgis::GeometryType geometryType () const
 Returns the geometry type for the objects associated with the callouts.
 
void setCallout (const QgsCallout *callout)
 Sets the widget state to match the specified callout.
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
 
void setGeometryType (Qgis::GeometryType type)
 Sets the geometry type for the objects associated with the callouts.
 
- 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.
 

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.
 
- 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.
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget.
 

Detailed Description

A panel widget for configuration of callouts.

Since
QGIS 3.40

Definition at line 35 of file qgscalloutpanelwidget.h.

Constructor & Destructor Documentation

◆ QgsCalloutPanelWidget()

QgsCalloutPanelWidget::QgsCalloutPanelWidget ( QWidget *  parent = nullptr,
QgsMapLayer layer = nullptr 
)

Constructor for QgsCalloutPanelWidget, with the specified parent widget.

The optional layer argument can be set to an associated map layer.

Definition at line 23 of file qgscalloutpanelwidget.cpp.

Member Function Documentation

◆ callout()

QgsCallout * QgsCalloutPanelWidget::callout ( )

Returns a new callout, respecting the configuration from the widget.

See also
setCallout()

Definition at line 71 of file qgscalloutpanelwidget.cpp.

◆ calloutChanged

void QgsCalloutPanelWidget::calloutChanged ( )
signal

Emitted when the callout defined by the widget changes.

◆ context()

QgsSymbolWidgetContext QgsCalloutPanelWidget::context ( ) const

Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also
setContext()

Definition at line 56 of file qgscalloutpanelwidget.cpp.

◆ geometryType()

Qgis::GeometryType QgsCalloutPanelWidget::geometryType ( ) const
inline

Returns the geometry type for the objects associated with the callouts.

If the type is Qgis::GeometryType::Unknown then an attempt will be made to deduce the type from the associated map layer.

See also
setGeometryType()

Definition at line 66 of file qgscalloutpanelwidget.h.

◆ setCallout()

void QgsCalloutPanelWidget::setCallout ( const QgsCallout callout)

Sets the widget state to match the specified callout.

Ownership is not transferred.

See also
callout()

Definition at line 61 of file qgscalloutpanelwidget.cpp.

◆ setContext()

void QgsCalloutPanelWidget::setContext ( const QgsSymbolWidgetContext context)

Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also
context()

Definition at line 47 of file qgscalloutpanelwidget.cpp.

◆ setGeometryType()

void QgsCalloutPanelWidget::setGeometryType ( Qgis::GeometryType  type)

Sets the geometry type for the objects associated with the callouts.

If type is Qgis::GeometryType::Unknown then an attempt will be made to deduce the type from the associated map layer.

See also
geometryType()

Definition at line 42 of file qgscalloutpanelwidget.cpp.


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