QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsTextFormatPanelWidget Class Reference

A panel widget for customizing text formatting settings. More...

#include <qgstextformatwidget.h>

Inheritance diagram for QgsTextFormatPanelWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsTextFormatPanelWidget (const QgsTextFormat &format, QgsMapCanvas *mapCanvas=nullptr, QWidget *parent=nullptr, QgsMapLayer *layer=nullptr)
 Constructor for QgsTextFormatPanelWidget. More...
 
QgsTextFormat format () const
 Returns the current formatting settings defined by the widget. More...
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts. More...
 
void setDockMode (bool dockMode) override
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setFormat (const QgsTextFormat &format)
 Sets the format to show in the widget. More...
 
- Public Member Functions inherited from QgsPanelWidgetWrapper
 QgsPanelWidgetWrapper (QWidget *widget, QWidget *parent=nullptr)
 Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs. More...
 
QWidget * widget ()
 Returns the internal widget that is wrapped in this panel. 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...
 

Additional Inherited Members

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

Detailed Description

A panel widget for customizing text formatting settings.

QgsTextFormatPanelWidget provides a panel widget for controlling the appearance of text rendered using QgsTextRenderer. The dialog includes all settings contained within a QgsTextFormat, including shadow, background and buffer.

Definition at line 384 of file qgstextformatwidget.h.

Constructor & Destructor Documentation

◆ QgsTextFormatPanelWidget()

QgsTextFormatPanelWidget::QgsTextFormatPanelWidget ( const QgsTextFormat format,
QgsMapCanvas mapCanvas = nullptr,
QWidget *  parent = nullptr,
QgsMapLayer layer = nullptr 
)

Constructor for QgsTextFormatPanelWidget.

Parameters
formatinitial format settings to show in dialog
mapCanvasoptional associated map canvas
parentparent widget
layerassociated layer

Definition at line 2204 of file qgstextformatwidget.cpp.

Member Function Documentation

◆ format()

QgsTextFormat QgsTextFormatPanelWidget::format ( ) const

Returns the current formatting settings defined by the widget.

Definition at line 2215 of file qgstextformatwidget.cpp.

◆ setContext()

void QgsTextFormatPanelWidget::setContext ( const QgsSymbolWidgetContext context)

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

Since
QGIS 3.10

Definition at line 2227 of file qgstextformatwidget.cpp.

◆ setDockMode()

void QgsTextFormatPanelWidget::setDockMode ( bool  dockMode)
overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters
dockModetrue to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 2232 of file qgstextformatwidget.cpp.

◆ setFormat()

void QgsTextFormatPanelWidget::setFormat ( const QgsTextFormat format)

Sets the format to show in the widget.

Since
QGIS 3.16

Definition at line 2220 of file qgstextformatwidget.cpp.


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