Subgroup: Effect

Class: QgsEffectStackPropertiesWidget

class qgis.gui.QgsEffectStackPropertiesWidget(stack: QgsEffectStack, parent: QWidget = None)

Bases: qgis._gui.QgsPanelWidget

QgsEffectStackPropertiesWidget constructor

Parameters:
  • stack – QgsEffectStack to modify in the widget
  • parent – parent widget

A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.

See also

QgsEffectStack

New in version 2.9: Methods

actionEvent
addEffect Adds a new effect to the stack.
changeEffect Updates the effect stack when the currently selected effect changes properties.
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
effectChanged Updates the widget when the selected effect changes type.
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
loadStack Refreshes the widget to reflect the current state of the stack.
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEffectByOffset Moves the currently selected effect within the stack by a specified offset
moveEffectDown Moves the currently selected effect down in the stack.
moveEffectUp Moves the currently selected effect up in the stack.
moveEvent
nativeEvent
paintEvent
receivers
removeEffect Removes the currently selected effect from the stack.
resizeEvent
sender
senderSignalIndex
setPreviewPicture Sets the picture to use for effect previews for the dialog
setWidget Sets the effect properties widget
sharedPainter
showEvent
stack Returns effect stack attached to the widget
tabletEvent
timerEvent
updateMicroFocus
updatePreview Updates the effect preview icon.
updateUi Enables or disables widgets depending on the selected effect within the stack.
wheelEvent

Signals

Attributes

actionEvent()
addEffect(self)

Adds a new effect to the stack.

changeEffect(self, newEffect: QgsPaintEffect)

Updates the effect stack when the currently selected effect changes properties.

Parameters:newEffect – new effect to replace existing effect at selected position within the stack.
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
effectChanged(self)

Updates the widget when the selected effect changes type.

enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadStack(self)

Refreshes the widget to reflect the current state of the stack.

loadStack(self, stack: QgsEffectStack) Refreshes the widget to reflect the current state of a specified stack.

Parameters:stack – QgsEffectStack for widget
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEffectByOffset(self, offset: int)

Moves the currently selected effect within the stack by a specified offset

moveEffectDown(self)

Moves the currently selected effect down in the stack.

moveEffectUp(self)

Moves the currently selected effect up in the stack.

moveEvent()
nativeEvent()
paintEvent()
receivers()
removeEffect(self)

Removes the currently selected effect from the stack.

resizeEvent()
sender()
senderSignalIndex()
setPreviewPicture(self, picture: QPicture)

Sets the picture to use for effect previews for the dialog

Parameters:picture – preview picture
setWidget(self, widget: QWidget)

Sets the effect properties widget

sharedPainter()
showEvent()
stack(self) → QgsEffectStack

Returns effect stack attached to the widget

Returns:QgsEffectStack modified by the widget
tabletEvent()
timerEvent()
updateMicroFocus()
updatePreview(self)

Updates the effect preview icon.

updateUi(self)

Enables or disables widgets depending on the selected effect within the stack.

wheelEvent()