QGIS API Documentation
3.0.2-Girona (307d082)
|
A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack. More...
#include <qgseffectstackpropertieswidget.h>
Public Slots | |
void | addEffect () |
Adds a new effect to the stack. More... | |
void | changeEffect (QgsPaintEffect *newEffect) |
Updates the effect stack when the currently selected effect changes properties. More... | |
void | effectChanged () |
Updates the widget when the selected effect changes type. More... | |
void | moveEffectDown () |
Moves the currently selected effect down in the stack. More... | |
void | moveEffectUp () |
Moves the currently selected effect up in the stack. More... | |
void | removeEffect () |
Removes the currently selected effect from the stack. More... | |
void | updatePreview () |
Updates the effect preview icon. More... | |
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... | |
Public Member Functions | |
QgsEffectStackPropertiesWidget (QgsEffectStack *stack, QWidget *parent=nullptr) | |
QgsEffectStackPropertiesWidget constructor. More... | |
~QgsEffectStackPropertiesWidget () override | |
void | setPreviewPicture (const QPicture &picture) |
Sets the picture to use for effect previews for the dialog. More... | |
QgsEffectStack * | stack () |
Returns effect stack attached to the widget. 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 () |
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... | |
Protected Member Functions | |
EffectItem * | currentEffectItem () |
Returns the currently selected effect within the stack. More... | |
void | loadStack () |
Refreshes the widget to reflect the current state of the stack. More... | |
void | loadStack (QgsEffectStack *stack) |
Refreshes the widget to reflect the current state of a specified stack. More... | |
void | moveEffectByOffset (int offset) |
Moves the currently selected effect within the stack by a specified offset. More... | |
void | setWidget (QWidget *widget) |
Sets the effect properties widget. More... | |
void | updateUi () |
Enables or disables widgets depending on the selected effect within the stack. More... | |
Protected Member Functions inherited from QgsPanelWidget | |
void | keyPressEvent (QKeyEvent *event) override |
Overridden key press event to handle the esc event on the widget. More... | |
Protected Attributes | |
QStandardItemModel * | mModel = nullptr |
QWidget * | mPresentWidget = nullptr |
QPicture * | mPreviewPicture = nullptr |
QgsEffectStack * | mStack = nullptr |
Additional Inherited Members | |
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... | |
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. More... | |
A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.
Definition at line 49 of file qgseffectstackpropertieswidget.h.
QgsEffectStackPropertiesWidget::QgsEffectStackPropertiesWidget | ( | QgsEffectStack * | stack, |
QWidget * | parent = nullptr |
||
) |
QgsEffectStackPropertiesWidget constructor.
stack | QgsEffectStack to modify in the widget |
parent | parent widget |
Definition at line 96 of file qgseffectstackpropertieswidget.cpp.
|
override |
Definition at line 150 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Adds a new effect to the stack.
Definition at line 276 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Updates the effect stack when the currently selected effect changes properties.
newEffect | new effect to replace existing effect at selected position within the stack. |
Definition at line 345 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Returns the currently selected effect within the stack.
Definition at line 238 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Updates the widget when the selected effect changes type.
Definition at line 248 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Refreshes the widget to reflect the current state of the stack.
Definition at line 185 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Refreshes the widget to reflect the current state of a specified stack.
stack | QgsEffectStack for widget |
Definition at line 166 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Moves the currently selected effect within the stack by a specified offset.
Definition at line 320 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Moves the currently selected effect down in the stack.
Definition at line 310 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Moves the currently selected effect up in the stack.
Definition at line 315 of file qgseffectstackpropertieswidget.cpp.
|
slot |
Removes the currently selected effect from the stack.
Definition at line 289 of file qgseffectstackpropertieswidget.cpp.
void QgsEffectStackPropertiesWidget::setPreviewPicture | ( | const QPicture & | picture | ) |
Sets the picture to use for effect previews for the dialog.
picture | preview picture |
Definition at line 155 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Sets the effect properties widget.
Definition at line 263 of file qgseffectstackpropertieswidget.cpp.
|
inline |
Returns effect stack attached to the widget.
Definition at line 68 of file qgseffectstackpropertieswidget.h.
|
slot |
Updates the effect preview icon.
Definition at line 208 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Enables or disables widgets depending on the selected effect within the stack.
Definition at line 191 of file qgseffectstackpropertieswidget.cpp.
|
protected |
Definition at line 117 of file qgseffectstackpropertieswidget.h.
|
protected |
Definition at line 118 of file qgseffectstackpropertieswidget.h.
|
protected |
Definition at line 119 of file qgseffectstackpropertieswidget.h.
|
protected |
Definition at line 116 of file qgseffectstackpropertieswidget.h.