A base class for property widgets for annotation items. More...

#include <qgsannotationitemwidget.h>

Inheritance diagram for QgsAnnotationItemBaseWidget:

[legend]

Public Slots
virtual void	focusDefaultWidget ()
	Focuses the default widget for the page.

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
void	itemChanged ()
	Emitted when the annotation item definition in the widget is changed by the user.

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
	QgsAnnotationItemBaseWidget (QWidget *parent)
	Constructor for QgsAnnotationItemBaseWidget.

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

virtual QgsAnnotationItem *	createItem ()=0
	Creates a new item matching the settings defined in the widget.

QString	itemId () const
	Returns the associated annotation item id.

QgsAnnotationLayer *	layer ()
	Returns the associated annotation map layer.

virtual void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

bool	setItem (QgsAnnotationItem *item)
	Sets the current item to show in the widget.

void	setItemId (const QString &id)
	Sets the associated annotation item id.

virtual void	setLayer (QgsAnnotationLayer *layer)
	Sets the associated annotation map layer.

virtual void	updateItem (QgsAnnotationItem *item)=0
	Updates an existing item to match the settings defined 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 Member Functions
const QgsRenderedAnnotationItemDetails *	renderedItemDetails ()
	Retrieve rendered annotation details for the associated annotation, if available.

virtual bool	setNewItem (QgsAnnotationItem *item)
	Attempts to update the widget to show the properties for the specified item.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Protected Attributes
QgsSymbolWidgetContext	mContext
	Context in which widget is shown.

QString	mItemId

QPointer< QgsAnnotationLayer >	mLayer

Additional Inherited Members
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.

Detailed Description

A base class for property widgets for annotation items.

All annotation item widgets should inherit from this base class.

Since: QGIS 3.22

Definition at line 37 of file qgsannotationitemwidget.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemBaseWidget()

QgsAnnotationItemBaseWidget::QgsAnnotationItemBaseWidget ( QWidget * parent )

Constructor for QgsAnnotationItemBaseWidget.

Definition at line 23 of file qgsannotationitemwidget.cpp.

Member Function Documentation

◆ context()

QgsSymbolWidgetContext QgsAnnotationItemBaseWidget::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 59 of file qgsannotationitemwidget.cpp.

◆ createItem()

virtual QgsAnnotationItem * QgsAnnotationItemBaseWidget::createItem ( )

pure virtual

Creates a new item matching the settings defined in the widget.

◆ focusDefaultWidget

void QgsAnnotationItemBaseWidget::focusDefaultWidget ( )

virtualslot

Focuses the default widget for the page.

Definition at line 64 of file qgsannotationitemwidget.cpp.

◆ itemChanged

void QgsAnnotationItemBaseWidget::itemChanged ( )

signal

Emitted when the annotation item definition in the widget is changed by the user.

◆ itemId()

QString QgsAnnotationItemBaseWidget::itemId ( ) const

Returns the associated annotation item id.

See also: setItemId()

Since: QGIS 3.40

Definition at line 49 of file qgsannotationitemwidget.cpp.

◆ layer()

QgsAnnotationLayer * QgsAnnotationItemBaseWidget::layer ( )

Returns the associated annotation map layer.

See also: setLayer()

Since: QGIS 3.40

Definition at line 39 of file qgsannotationitemwidget.cpp.

◆ renderedItemDetails()

const QgsRenderedAnnotationItemDetails * QgsAnnotationItemBaseWidget::renderedItemDetails ( )

protected

Retrieve rendered annotation details for the associated annotation, if available.

Since: QGIS 3.40

Definition at line 73 of file qgsannotationitemwidget.cpp.

◆ setContext()

void QgsAnnotationItemBaseWidget::setContext ( const QgsSymbolWidgetContext & context )

virtual

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

See also: context()

Definition at line 54 of file qgsannotationitemwidget.cpp.

◆ setItem()

bool QgsAnnotationItemBaseWidget::setItem ( QgsAnnotationItem * 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 29 of file qgsannotationitemwidget.cpp.

◆ setItemId()

void QgsAnnotationItemBaseWidget::setItemId ( const QString & id )

Sets the associated annotation item id.

See also: itemId()

Since: QGIS 3.40

Definition at line 44 of file qgsannotationitemwidget.cpp.

◆ setLayer()

void QgsAnnotationItemBaseWidget::setLayer ( QgsAnnotationLayer * layer )

virtual

Sets the associated annotation map layer.

See also: layer()

Since: QGIS 3.40

Definition at line 34 of file qgsannotationitemwidget.cpp.

◆ setNewItem()

bool QgsAnnotationItemBaseWidget::setNewItem ( QgsAnnotationItem * item )

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 68 of file qgsannotationitemwidget.cpp.

◆ updateItem()

virtual void QgsAnnotationItemBaseWidget::updateItem ( QgsAnnotationItem * item )

pure virtual

Updates an existing item to match the settings defined in the widget.

Member Data Documentation

◆ mContext

QgsSymbolWidgetContext QgsAnnotationItemBaseWidget::mContext

protected

Context in which widget is shown.

Definition at line 147 of file qgsannotationitemwidget.h.

◆ mItemId

QString QgsAnnotationItemBaseWidget::mItemId

protected

Definition at line 150 of file qgsannotationitemwidget.h.

◆ mLayer

QPointer< QgsAnnotationLayer > QgsAnnotationItemBaseWidget::mLayer

protected

Definition at line 149 of file qgsannotationitemwidget.h.

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

/build/qgis-3.39.0+git20240902+9ea1ddbe645+99sid/src/gui/annotations/qgsannotationitemwidget.h
/build/qgis-3.39.0+git20240902+9ea1ddbe645+99sid/src/gui/annotations/qgsannotationitemwidget.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsAnnotationItemBaseWidget()

Member Function Documentation

◆ context()

◆ createItem()

◆ focusDefaultWidget

◆ itemChanged

◆ itemId()

◆ layer()

◆ renderedItemDetails()

◆ setContext()

◆ setItem()

◆ setItemId()

◆ setLayer()

◆ setNewItem()

◆ updateItem()

Member Data Documentation

◆ mContext

◆ mItemId

◆ mLayer