A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog. More...

#include <qgseffectstackpropertieswidget.h>

Inheritance diagram for QgsEffectStackCompactWidget:

[legend]

Signals
void	changed ()
	Emitted when the paint effect properties change.

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
	QgsEffectStackCompactWidget (QWidget parent=nullptr, QgsPaintEffect effect=nullptr)
	QgsEffectStackCompactWidget constructor.

	~QgsEffectStackCompactWidget () override

QgsPaintEffect *	paintEffect () const
	Returns paint effect attached to the widget.

void	setPaintEffect (QgsPaintEffect *effect)
	Sets paint effect attached to the widget,.

void	setPreviewPicture (const QPicture &picture)
	Sets the picture to use for effect previews for the dialog.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an 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 small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog.

See also: QgsEffectStack; QgsEffectStackPropertiesWidget; QgsEffectStackPropertiesDialog

Definition at line 209 of file qgseffectstackpropertieswidget.h.

Constructor & Destructor Documentation

◆ QgsEffectStackCompactWidget()

QgsEffectStackCompactWidget::QgsEffectStackCompactWidget	(	QWidget *	parent = `nullptr`,
		QgsPaintEffect *	effect = `nullptr`
	)

QgsEffectStackCompactWidget constructor.

Parameters

parent	parent widget
effect	QgsPaintEffect for modification by the widget. If the effect is not a QgsEffectStack, it will be automatically converted to an effect stack consisting of the original effect

Definition at line 396 of file qgseffectstackpropertieswidget.cpp.

◆ ~QgsEffectStackCompactWidget()

QgsEffectStackCompactWidget::~QgsEffectStackCompactWidget ( )

overridedefault

Member Function Documentation

◆ changed

void QgsEffectStackCompactWidget::changed ( )

signal

Emitted when the paint effect properties change.

◆ paintEffect()

QgsPaintEffect * QgsEffectStackCompactWidget::paintEffect ( ) const

Returns paint effect attached to the widget.

Returns: QgsPaintEffect modified by the widget

See also: setPaintEffect

Definition at line 450 of file qgseffectstackpropertieswidget.cpp.

◆ setPaintEffect()

void QgsEffectStackCompactWidget::setPaintEffect ( QgsPaintEffect * effect )

Sets paint effect attached to the widget,.

Parameters

effect QgsPaintEffect for modification by the widget. If the effect is not a QgsEffectStack, it will be automatically converted to an effect stack consisting of the original effect

See also: paintEffect

Definition at line 425 of file qgseffectstackpropertieswidget.cpp.

◆ setPreviewPicture()

void QgsEffectStackCompactWidget::setPreviewPicture ( const QPicture & picture )

Sets the picture to use for effect previews for the dialog.

Parameters

picture preview picture

Definition at line 455 of file qgseffectstackpropertieswidget.cpp.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/effects/qgseffectstackpropertieswidget.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/effects/qgseffectstackpropertieswidget.cpp

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsEffectStackCompactWidget()

◆ ~QgsEffectStackCompactWidget()

Member Function Documentation

◆ changed

◆ paintEffect()

◆ setPaintEffect()

◆ setPreviewPicture()