QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsAnnotationItemBaseWidget Class Referenceabstract

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

#include <qgsannotationitemwidget.h>

Inheritance diagram for QgsAnnotationItemBaseWidget:
Inheritance graph
[legend]

Public Slots

virtual void focusDefaultWidget ()
 Focuses the default widget for the page. More...
 
- 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

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

Public Member Functions

 QgsAnnotationItemBaseWidget (QWidget *parent)
 Constructor for QgsAnnotationItemBaseWidget. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts. More...
 
virtual QgsAnnotationItemcreateItem ()=0
 Creates a new item matching the settings defined in the widget. More...
 
virtual void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts. More...
 
bool setItem (QgsAnnotationItem *item)
 Sets the current item to show in the widget. More...
 
virtual void updateItem (QgsAnnotationItem *item)=0
 Updates an existing item to match the settings defined in the widget. 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 Member Functions

virtual bool setNewItem (QgsAnnotationItem *item)
 Attempts to update the widget to show the properties for the specified item. 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...
 

Protected Attributes

QgsSymbolWidgetContext mContext
 Context in which widget is shown. More...
 

Additional Inherited Members

- 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

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 35 of file qgsannotationitemwidget.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemBaseWidget()

QgsAnnotationItemBaseWidget::QgsAnnotationItemBaseWidget ( QWidget *  parent)

Constructor for QgsAnnotationItemBaseWidget.

Definition at line 18 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 34 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 39 of file qgsannotationitemwidget.cpp.

◆ itemChanged

void QgsAnnotationItemBaseWidget::itemChanged ( )
signal

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

◆ 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 29 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 24 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 43 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 106 of file qgsannotationitemwidget.h.


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