A widget for configuring QgsTextFormat tab positions. More...

#include <qgstabpositionwidget.h>

Inheritance diagram for QgsTabPositionWidget:

[legend]

Signals
void	positionsChanged (const QList< QgsTextFormat::Tab > &positions)
	Emitted when positions are changed in the widget.

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
	QgsTabPositionWidget (QWidget *parent=nullptr)
	Constructor for QgsTabPositionWidget, with the specified parent widget.

QList< QgsTextFormat::Tab >	positions () const
	Returns the tab positions defined in the widget.

void	setPositions (const QList< QgsTextFormat::Tab > &positions)
	Sets the tab positions to show in the widget.

void	setUnit (Qgis::RenderUnit unit)
	Sets the unit type used for the tab positions (used to update interface labels).

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.

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

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.

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

Detailed Description

A widget for configuring QgsTextFormat tab positions.

Since: QGIS 3.42

Definition at line 33 of file qgstabpositionwidget.h.

Constructor & Destructor Documentation

◆ QgsTabPositionWidget()

QgsTabPositionWidget::QgsTabPositionWidget ( QWidget * parent = nullptr )

Constructor for QgsTabPositionWidget, with the specified parent widget.

Definition at line 24 of file qgstabpositionwidget.cpp.

Member Function Documentation

◆ positions()

QList< QgsTextFormat::Tab > QgsTabPositionWidget::positions ( ) const

Returns the tab positions defined in the widget.

See also: setPositions()

Definition at line 52 of file qgstabpositionwidget.cpp.

◆ positionsChanged

void QgsTabPositionWidget::positionsChanged ( const QList< QgsTextFormat::Tab > & positions )

signal

Emitted when positions are changed in the widget.

◆ setPositions()

void QgsTabPositionWidget::setPositions ( const QList< QgsTextFormat::Tab > & positions )

Sets the tab positions to show in the widget.

See also: positions()

Definition at line 39 of file qgstabpositionwidget.cpp.

◆ setUnit()

void QgsTabPositionWidget::setUnit ( Qgis::RenderUnit unit )

Sets the unit type used for the tab positions (used to update interface labels).

Definition at line 73 of file qgstabpositionwidget.cpp.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/labeling/qgstabpositionwidget.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/labeling/qgstabpositionwidget.cpp

Signals

Public Member Functions

Additional Inherited Members