Class: QgsLabelSettingsWidgetBase

class qgis.gui.QgsLabelSettingsWidgetBase(parent: QWidget = None, vl: QgsVectorLayer = None)

Bases: QgsPanelWidget

Constructor for QgsLabelSettingsWidgetBase.

Parameters
  • parent (QWidget = None) – parent widget

  • vl (QgsVectorLayer = None) – associated vector layer

Base class for widgets which allow customization of label engine properties, such as label placement settings.

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

dataDefinedProperties

Returns the current data defined properties state as specified in the widget.

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

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.

setDataDefinedProperties

Sets the current data defined properties to show in the widget.

setGeometryType

Sets the geometry type of the features to customize the widget accordingly.

sharedPainter

showEvent

tabletEvent

timerEvent

updateDataDefinedProperties

Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

updateMicroFocus

wheelEvent

Signals

auxiliaryFieldCreated

Emitted when an auxiliary field is created in the widget.

changed

Emitted when any of the settings described by the widget are changed.

actionEvent()
auxiliaryFieldCreated

Emitted when an auxiliary field is created in the widget. [signal]

changeEvent()
changed

Emitted when any of the settings described by the widget are changed. [signal]

childEvent()
closeEvent()
connectNotify()
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()

Return type

QgsSymbolWidgetContext

contextMenuEvent()
create()
createExpressionContext(self) → QgsExpressionContext
Return type

QgsExpressionContext

customEvent()
dataDefinedProperties(self) → QgsPropertyCollection

Returns the current data defined properties state as specified in the widget.

Return type

QgsPropertyCollection

destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
registerDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsPalLayerSettings.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.

Parameters
resizeEvent()
sender()
senderSignalIndex()
setContext(self, context: QgsSymbolWidgetContext)

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

See also

context()

Parameters

context (QgsSymbolWidgetContext) –

setDataDefinedProperties(self, dataDefinedProperties: QgsPropertyCollection)

Sets the current data defined properties to show in the widget.

Parameters

dataDefinedProperties (QgsPropertyCollection) –

setGeometryType(self, type: QgsWkbTypes.GeometryType)

Sets the geometry type of the features to customize the widget accordingly.

Parameters

type (QgsWkbTypes.GeometryType) –

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateDataDefinedProperties(self, properties: QgsPropertyCollection)

Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

Parameters

properties (QgsPropertyCollection) –

updateMicroFocus()
wheelEvent()