A widget for controlling playback properties of a QgsTemporalController. More...

#include <qgstemporalcontrollerwidget.h>

Inheritance diagram for QgsTemporalControllerWidget:

[legend]

Signals
void	exportAnimation ()
	Triggered when an animation should be exported.

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

bool	applySizeConstraintsToStack () const override
	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.

QgsTemporalNavigationObject *	temporalController ()
	Returns the temporal controller object used by this object in navigation.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

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.

Protected Member Functions
void	keyPressEvent (QKeyEvent *e) override

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

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.

Detailed Description

A widget for controlling playback properties of a QgsTemporalController.

Since: QGIS 3.14

Definition at line 39 of file qgstemporalcontrollerwidget.h.

Constructor & Destructor Documentation

◆ QgsTemporalControllerWidget()

QgsTemporalControllerWidget::QgsTemporalControllerWidget ( QWidget * parent = nullptr )

Constructor for QgsTemporalControllerWidget, with the specified parent widget.

Definition at line 35 of file qgstemporalcontrollerwidget.cpp.

Member Function Documentation

◆ applySizeConstraintsToStack()

bool QgsTemporalControllerWidget::applySizeConstraintsToStack ( ) const

overridevirtual

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.

The default behavior is to return false.

Since: QGIS 3.20

Reimplemented from QgsPanelWidget.

Definition at line 209 of file qgstemporalcontrollerwidget.cpp.

◆ exportAnimation

void QgsTemporalControllerWidget::exportAnimation ( )

signal

Triggered when an animation should be exported.

◆ keyPressEvent()

void QgsTemporalControllerWidget::keyPressEvent ( QKeyEvent * e )

overrideprotected

Definition at line 214 of file qgstemporalcontrollerwidget.cpp.

◆ temporalController()

QgsTemporalNavigationObject * QgsTemporalControllerWidget::temporalController ( )

Returns the temporal controller object used by this object in navigation.

The dock widget retains ownership of the returned object.

Definition at line 531 of file qgstemporalcontrollerwidget.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgstemporalcontrollerwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgstemporalcontrollerwidget.cpp

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members