QGIS API Documentation  2.99.0-Master (d55fa22)
Signals | Public Member Functions | List of all members
QgsEffectStackCompactWidget Class Reference

A small widget consisting of a check box for enabling/disabling an effect stack and a button for opening an effect stack customisation dialog. More...

#include <qgseffectstackpropertieswidget.h>

Inheritance diagram for QgsEffectStackCompactWidget:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted when the paint effect properties change. 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

 QgsEffectStackCompactWidget (QWidget *parent=0, QgsPaintEffect *effect=nullptr)
 QgsEffectStackCompactWidget constructor. More...
 
 ~QgsEffectStackCompactWidget ()
 
QgsPaintEffectpaintEffect () const
 Returns paint effect attached to the widget. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets paint effect attached to the widget,. More...
 
void setPreviewPicture (const QPicture &picture)
 Sets the picture to use for effect previews for the dialog. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=0)
 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 ()
 Return the dock mode state. 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...
 

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...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event)
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

A small widget consisting of a check box for enabling/disabling an effect stack and a button for opening an effect stack customisation dialog.

Since
QGIS 2.9
See also
QgsEffectStack
QgsEffectStackPropertiesWidget
QgsEffectStackPropertiesDialog

Definition at line 191 of file qgseffectstackpropertieswidget.h.

Constructor & Destructor Documentation

◆ QgsEffectStackCompactWidget()

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

QgsEffectStackCompactWidget constructor.

Parameters
parentparent widget
effectQgsPaintEffect 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 387 of file qgseffectstackpropertieswidget.cpp.

◆ ~QgsEffectStackCompactWidget()

QgsEffectStackCompactWidget::~QgsEffectStackCompactWidget ( )

Definition at line 416 of file qgseffectstackpropertieswidget.cpp.

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 446 of file qgseffectstackpropertieswidget.cpp.

◆ setPaintEffect()

void QgsEffectStackCompactWidget::setPaintEffect ( QgsPaintEffect effect)

Sets paint effect attached to the widget,.

Parameters
effectQgsPaintEffect 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 421 of file qgseffectstackpropertieswidget.cpp.

◆ setPreviewPicture()

void QgsEffectStackCompactWidget::setPreviewPicture ( const QPicture &  picture)

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

Parameters
picturepreview picture

Definition at line 451 of file qgseffectstackpropertieswidget.cpp.


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