QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
A panel widget for customizing text formatting settings. More...
#include <qgstextformatwidget.h>
Public Member Functions | |
QgsTextFormatPanelWidget (const QgsTextFormat &format, QgsMapCanvas *mapCanvas=nullptr, QWidget *parent=nullptr, QgsMapLayer *layer=nullptr) | |
Constructor for QgsTextFormatPanelWidget. | |
QgsTextFormat | format () const |
Returns the current formatting settings defined by the widget. | |
void | setContext (const QgsSymbolWidgetContext &context) |
Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts. | |
void | setDockMode (bool dockMode) override |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. | |
void | setFormat (const QgsTextFormat &format) |
Sets the format to show in the widget. | |
![]() | |
QgsPanelWidgetWrapper (QWidget *widget, QWidget *parent=nullptr) | |
Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs. | |
QWidget * | widget () |
Returns the internal widget that is wrapped in this panel. | |
![]() | |
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. | |
void | setPanelTitle (const QString &panelTitle) |
Set the title of the panel when shown in the interface. | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
static QgsPanelWidget * | findParentPanel (QWidget *widget) |
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. | |
![]() | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. | |
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.
QgsTextFormatPanelWidget::QgsTextFormatPanelWidget | ( | const QgsTextFormat & | format, |
QgsMapCanvas * | mapCanvas = nullptr , |
||
QWidget * | parent = nullptr , |
||
QgsMapLayer * | layer = nullptr |
||
) |
Constructor for QgsTextFormatPanelWidget.
format | initial format settings to show in dialog |
mapCanvas | optional associated map canvas |
parent | parent widget |
layer | associated layer |
Definition at line 2252 of file qgstextformatwidget.cpp.
QgsTextFormat QgsTextFormatPanelWidget::format | ( | ) | const |
Returns the current formatting settings defined by the widget.
Definition at line 2263 of file qgstextformatwidget.cpp.
void QgsTextFormatPanelWidget::setContext | ( | const QgsSymbolWidgetContext & | context | ) |
Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
Definition at line 2275 of file qgstextformatwidget.cpp.
|
overridevirtual |
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
dockMode | true to enable dock mode. |
Reimplemented from QgsPanelWidget.
Definition at line 2280 of file qgstextformatwidget.cpp.
void QgsTextFormatPanelWidget::setFormat | ( | const QgsTextFormat & | format | ) |
Sets the format to show in the widget.
Definition at line 2268 of file qgstextformatwidget.cpp.