QgsCalloutWidget Class Reference

Base class for widgets which allow control over the properties of callouts. More...

#include <qgscalloutwidget.h>

Inheritance diagram for QgsCalloutWidget:

Signals
void	changed ()
	Should be emitted whenever configuration changes happened on this symbol layer configuration.

Public Member Functions
	QgsCalloutWidget (QWidget *parent, QgsMapLayer *vl=nullptr)
	Constructor for QgsCalloutWidget.
virtual QgsCallout *	callout ()=0
	Returns the callout defined by the current settings in the widget.
QgsSymbolWidgetContext	context () const
	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
const QgsMapLayer *	layer () const
	Returns the vector layer associated with the widget.
virtual void	setCallout (const QgsCallout *callout)=0
	Sets the callout to show in the widget.
virtual void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
virtual void	setGeometryType (Qgis::GeometryType type)=0
	Sets the geometry type of the features to customize the widget accordingly.
Q_DECL_DEPRECATED const QgsVectorLayer *	vectorLayer () const
	Returns the vector layer associated with the widget.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Protected Member Functions
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsCallout::Property key)
	Registers a data defined override button.

Detailed Description

Base class for widgets which allow control over the properties of callouts.

Since

QGIS 3.10

Definition at line 34 of file qgscalloutwidget.h.

Constructor & Destructor Documentation

QgsCalloutWidget()

QgsCalloutWidget::QgsCalloutWidget ( QWidget *  parent, QgsMapLayer *  vl = nullptr  )

inline

Constructor for QgsCalloutWidget.

Parameters

vl	associated map layer
parent	parent widget

Definition at line 45 of file qgscalloutwidget.h.

Member Function Documentation

callout()

virtual QgsCallout * QgsCalloutWidget::callout ( )

pure virtual

Returns the callout defined by the current settings in the widget.

Ownership is not transferred, and the caller should clone the returned value.

See also

setCallout()

changed

void QgsCalloutWidget::changed ( )

signal

Should be emitted whenever configuration changes happened on this symbol layer configuration.

If the subsymbol is changed, symbolChanged() should be emitted instead.

context()

QgsSymbolWidgetContext QgsCalloutWidget::context

(

)

const

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

See also

setContext()

Definition at line 69 of file qgscalloutwidget.cpp.

createExpressionContext()

QgsExpressionContext QgsCalloutWidget::createExpressionContext ( ) const

overrideprotectedvirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 28 of file qgscalloutwidget.cpp.

layer()

const QgsMapLayer * QgsCalloutWidget::layer ( ) const

inline

Returns the vector layer associated with the widget.

Since

QGIS 3.40

Definition at line 88 of file qgscalloutwidget.h.

registerDataDefinedButton()

void QgsCalloutWidget::registerDataDefinedButton ( QgsPropertyOverrideButton *  button, QgsCallout::Property  key  )

protected

Registers a data defined override button.

Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

Definition at line 74 of file qgscalloutwidget.cpp.

setCallout()

virtual void QgsCalloutWidget::setCallout ( const QgsCallout *  callout )

pure virtual

Sets the callout to show in the widget.

Ownership is not transferred.

See also

callout()

setContext()

void QgsCalloutWidget::setContext ( const QgsSymbolWidgetContext &  context )

virtual

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

Parameters

context

symbol widget context

See also

context()

Definition at line 53 of file qgscalloutwidget.cpp.

setGeometryType()

virtual void QgsCalloutWidget::setGeometryType ( Qgis::GeometryType  type )

pure virtual

Sets the geometry type of the features to customize the widget accordingly.

vectorLayer()

Q_DECL_DEPRECATED const QgsVectorLayer * QgsCalloutWidget::vectorLayer ( ) const

inline

Returns the vector layer associated with the widget.

Deprecated:

QGIS 3.40. Use layer() instead.

Definition at line 81 of file qgscalloutwidget.h.

---

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

• /build/qgis-3.40.0+99sid/src/gui/callouts/qgscalloutwidget.h
• /build/qgis-3.40.0+99sid/src/gui/callouts/qgscalloutwidget.cpp