QGIS API Documentation  3.17.0-Master (a035f434f4)
Signals | Public Member Functions | Protected Member Functions | List of all members
QgsTemporalControllerWidget Class Reference

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

#include <qgstemporalcontrollerwidget.h>

Inheritance diagram for QgsTemporalControllerWidget:
Inheritance graph
[legend]

Signals

void exportAnimation ()
 Triggered when an animation should be exported. 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

 QgsTemporalControllerWidget (QWidget *parent=nullptr)
 Constructor for QgsTemporalControllerWidget, with the specified parent widget. More...
 
QgsTemporalControllertemporalController ()
 Returns the temporal controller object used by this object in navigation. 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...
 
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

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. 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...
 
- 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 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 32 of file qgstemporalcontrollerwidget.cpp.

Member Function Documentation

◆ exportAnimation

void QgsTemporalControllerWidget::exportAnimation ( )
signal

Triggered when an animation should be exported.

◆ keyPressEvent()

void QgsTemporalControllerWidget::keyPressEvent ( QKeyEvent *  e)
overrideprotected

Definition at line 177 of file qgstemporalcontrollerwidget.cpp.

◆ temporalController()

QgsTemporalController * 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 479 of file qgstemporalcontrollerwidget.cpp.


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