QgsTiledSceneRendererWidget Class Reference

Base class for tiled scene 2D renderer settings widgets. More...

#include <qgstiledscenerendererwidget.h>

Inheritance diagram for QgsTiledSceneRendererWidget:

Public Member Functions
	QgsTiledSceneRendererWidget (QgsTiledSceneLayer *layer, QgsStyle *style)
	Constructor for QgsTiledSceneRendererWidget, associated with the specified layer and style database.
QgsSymbolWidgetContext	context () const
	Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
const QgsTiledSceneLayer *	layer () const
	Returns the tiled scene layer associated with the widget.
virtual QgsTiledSceneRenderer *	renderer ()=0
	Returns a new instance of a renderer as defined by the settings in the widget.
virtual void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
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.

Protected Attributes
QgsSymbolWidgetContext	mContext
	Context in which widget is shown.
QgsTiledSceneLayer *	mLayer = nullptr
QgsStyle *	mStyle = nullptr

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.
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.
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

Base class for tiled scene 2D renderer settings widgets.

Since

QGIS 3.34

Definition at line 36 of file qgstiledscenerendererwidget.h.

Constructor & Destructor Documentation

QgsTiledSceneRendererWidget()

QgsTiledSceneRendererWidget::QgsTiledSceneRendererWidget	(	QgsTiledSceneLayer *	layer,
		QgsStyle *	style
	)

Constructor for QgsTiledSceneRendererWidget, associated with the specified layer and style database.

Definition at line 18 of file qgstiledscenerendererwidget.cpp.

Member Function Documentation

context()

QgsSymbolWidgetContext QgsTiledSceneRendererWidget::context

(

)

const

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

See also

setContext()

Definition at line 29 of file qgstiledscenerendererwidget.cpp.

layer()

const QgsTiledSceneLayer * QgsTiledSceneRendererWidget::layer ( ) const

inline

Returns the tiled scene layer associated with the widget.

Definition at line 69 of file qgstiledscenerendererwidget.h.

renderer()

virtual QgsTiledSceneRenderer * QgsTiledSceneRendererWidget::renderer ( )

pure virtual

Returns a new instance of a renderer as defined by the settings in the widget.

Caller takes ownership of the returned object.

setContext()

void QgsTiledSceneRendererWidget::setContext ( const QgsSymbolWidgetContext &  context )

virtual

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

See also

context()

Definition at line 24 of file qgstiledscenerendererwidget.cpp.

Member Data Documentation

mContext

QgsSymbolWidgetContext QgsTiledSceneRendererWidget::mContext

protected

Context in which widget is shown.

Definition at line 78 of file qgstiledscenerendererwidget.h.

mLayer

QgsTiledSceneLayer* QgsTiledSceneRendererWidget::mLayer = nullptr

protected

Definition at line 74 of file qgstiledscenerendererwidget.h.

mStyle

QgsStyle* QgsTiledSceneRendererWidget::mStyle = nullptr

protected

Definition at line 75 of file qgstiledscenerendererwidget.h.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/tiledscene/qgstiledscenerendererwidget.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/tiledscene/qgstiledscenerendererwidget.cpp