Class: QgsLayerPropertiesWidget

class qgis.gui.QgsLayerPropertiesWidget(layer: QgsSymbolLayer, symbol: QgsSymbol, vl: QgsVectorLayer, parent: QWidget = None)

Bases: QgsPanelWidget, QgsExpressionContextGenerator

Constructor for QgsLayerPropertiesWidget.

Parameters

• layer – the symbol layer

• symbol – the symbol

• vl – associated vector layer

• parent –

  parent widget

  Methods

  actionEvent
  changeEvent
  childEvent
  closeEvent
  connectNotify
  context	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
  contextMenuEvent
  create
  createExpressionContext	rtype QgsExpressionContext
  customEvent
  destroy
  disconnectNotify
  dragEnterEvent
  dragLeaveEvent
  dragMoveEvent
  dropEvent
  emitSignalChanged
  enterEvent
  event
  focusInEvent
  focusNextChild
  focusNextPrevChild
  focusOutEvent
  focusPreviousChild
  hideEvent
  initPainter
  inputMethodEvent
  isSignalConnected
  keyPressEvent	Overridden key press event to handle the esc event on the widget.
  keyReleaseEvent
  layerTypeChanged
  leaveEvent
  metric
  mouseDoubleClickEvent
  mouseMoveEvent
  mousePressEvent
  mouseReleaseEvent
  moveEvent
  nativeEvent
  paintEvent
  populateLayerTypes
  receivers
  registerDataDefinedButton	Registers a data defined override button.
  resizeEvent
  sender
  senderSignalIndex
  setContext	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
  setDockMode	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
  sharedPainter
  showEvent
  tabletEvent
  timerEvent
  updateMicroFocus
  updateSymbolLayerWidget	param layer
  wheelEvent

  Signals

  changeLayer	changeLayer(self, QgsSymbolLayer) [signal]
  changed	changed(self) [signal]

actionEvent(self, QActionEvent)

changeEvent(self, QEvent)

changeLayer

changeLayer(self, QgsSymbolLayer) [signal]

changed

changed(self) [signal]

childEvent(self, QChildEvent)

closeEvent(self, QCloseEvent)

connectNotify(self, QMetaMethod)

context(self) → QgsSymbolWidgetContext

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

See also

setContext()

New in version 3.0.

Return type

QgsSymbolWidgetContext

contextMenuEvent(self, QContextMenuEvent)

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createExpressionContext(self) → QgsExpressionContext

Return type

QgsExpressionContext

customEvent(self, QEvent)

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

emitSignalChanged(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPreviousChild(self) → bool

hideEvent(self, QHideEvent)

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

isSignalConnected(self, QMetaMethod) → bool

keyPressEvent(self, event: QKeyEvent)

Overridden key press event to handle the esc event on the widget.

Parameters

event – The key event

keyReleaseEvent(self, QKeyEvent)

layerTypeChanged(self)

leaveEvent(self, QEvent)

metric(self, QPaintDevice.PaintDeviceMetric) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

moveEvent(self, QMoveEvent)

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]

paintEvent(self, QPaintEvent)

populateLayerTypes(self)

receivers(self, PYQT_SIGNAL) → int

registerDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsSymbolLayer.Property)

Registers a data defined override button. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

New in version 3.0.

Parameters

• button (QgsPropertyOverrideButton) –

• key (QgsSymbolLayer.Property) –

resizeEvent(self, QResizeEvent)

sender(self) → QObject

senderSignalIndex(self) → int

setContext(self, context: QgsSymbolWidgetContext)

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

Parameters

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

New in version 3.0.

setDockMode(self, dockMode: bool)

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs

Parameters

dockMode (bool) – True to enable dock mode.

sharedPainter(self) → QPainter

showEvent(self, QShowEvent)

tabletEvent(self, QTabletEvent)

timerEvent(self, QTimerEvent)

updateMicroFocus(self)

updateSymbolLayerWidget(self, layer: QgsSymbolLayer)

Parameters

layer (QgsSymbolLayer) –

wheelEvent(self, QWheelEvent)