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

A widget for configuring common properties for QgsAnnotationItems. More...

#include <qgsannotationitemcommonpropertieswidget.h>

Inheritance diagram for QgsAnnotationItemCommonPropertiesWidget:
Inheritance graph
[legend]

Signals

void itemChanged ()
 Emitted when the annotation item definition in the widget is changed by the user.
 

Public Member Functions

 QgsAnnotationItemCommonPropertiesWidget (QWidget *parent)
 Constructor for QgsAnnotationItemCommonPropertiesWidget.
 
 ~QgsAnnotationItemCommonPropertiesWidget () override
 
QgsSymbolWidgetContext context () const
 Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
 
void setItem (QgsAnnotationItem *item)
 Sets the item whose properties should be shown in the widget.
 
void updateItem (QgsAnnotationItem *item)
 Updates an item, setting the properties defined in the widget.
 

Detailed Description

A widget for configuring common properties for QgsAnnotationItems.

Since
QGIS 3.22

Definition at line 35 of file qgsannotationitemcommonpropertieswidget.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemCommonPropertiesWidget()

QgsAnnotationItemCommonPropertiesWidget::QgsAnnotationItemCommonPropertiesWidget ( QWidget *  parent)

◆ ~QgsAnnotationItemCommonPropertiesWidget()

QgsAnnotationItemCommonPropertiesWidget::~QgsAnnotationItemCommonPropertiesWidget ( )
overridedefault

Member Function Documentation

◆ context()

QgsSymbolWidgetContext QgsAnnotationItemCommonPropertiesWidget::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 82 of file qgsannotationitemcommonpropertieswidget.cpp.

◆ itemChanged

void QgsAnnotationItemCommonPropertiesWidget::itemChanged ( )
signal

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

◆ setContext()

void QgsAnnotationItemCommonPropertiesWidget::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 74 of file qgsannotationitemcommonpropertieswidget.cpp.

◆ setItem()

void QgsAnnotationItemCommonPropertiesWidget::setItem ( QgsAnnotationItem item)

Sets the item whose properties should be shown in the widget.

Definition at line 56 of file qgsannotationitemcommonpropertieswidget.cpp.

◆ updateItem()

void QgsAnnotationItemCommonPropertiesWidget::updateItem ( QgsAnnotationItem item)

Updates an item, setting the properties defined in the widget.

Definition at line 66 of file qgsannotationitemcommonpropertieswidget.cpp.


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