Class: QgsFontButton

A button for customizing QgsTextFormat settings.

The button will open a detailed text format settings dialog when clicked. An attached drop-down menu allows for copying and pasting text styles, picking colors for the text, and for dropping colors from other color widgets.

The button can be used in two different modes(). The default behavior is to include all settings used for configuring QgsTextFormat/QgsTextRenderer classes. A cut down mode (without settings for color) is also available when the resultant font is used only in a QFont object.

Class Hierarchy

Base classes

QToolButton
QAbstractButton
QWidget
QObject
QPaintDevice

Methods

copyColor	Copies the current text color to the clipboard.
copyFormat	Copies the current text format to the clipboard.
currentFont	Returns the current QFont set by the widget.
dialogTitle	Returns the title for the text settings dialog window.
layer	Returns the layer associated with the widget.
mapCanvas	Returns the map canvas associated with the widget.
messageBar	Returns the message bar associated with the widget.
mode	Returns the current button mode.
pasteColor	Pastes a color from the clipboard to the text format.
pasteFormat	Pastes a format from the clipboard.
registerExpressionContextGenerator	Register an expression context generator class that will be used to retrieve an expression context for the button when required.
setColor	Sets the current color for the text.
setCurrentFont	Sets the current text font to show in the widget.
setDialogTitle	Sets the title for the text settings dialog window.
setLayer	Sets a layer to associate with the widget.
setMapCanvas	Sets a map canvas to associate with the widget.
setMessageBar	Sets the message bar associated with the widget.
setMode	Sets the current button mode.
setNoFormatString	Sets the string to use for the "null format" option in the button's drop-down menu.
setShowNullFormat	Sets whether the "null format" option should be shown in the button's drop-down menu.
setTextFormat	Sets the current text format to show in the widget.
setToNullFormat	Sets the text format to a null (invalid) QgsTextFormat.
showNullFormat	Returns whether the "null format" option will be shown in the button's drop-down menu.
textFormat	Returns the current text formatting set by the widget.

Signals

changed

Emitted when the widget's text format settings are changed.

Attributes

ModeQFont
ModeTextRenderer

class qgis.gui.QgsFontButton

Bases: QToolButton

__init__(parent: QWidget | None = None, dialogTitle: str | None = '')

Construct a new font button. Use parent to attach a parent QWidget to the dialog. Use dialogTitle string to define the title to show in the text settings dialog.

Parameters:

• parent (Optional[QWidget] = None)

• dialogTitle (Optional[str] = '')

class Mode

Bases: int

ModeQFont = 1

ModeTextRenderer = 0

signal changed

Emitted when the widget’s text format settings are changed.

copyColor(self)

Copies the current text color to the clipboard. This is only used when mode() is ModeTextRenderer.

See also

pasteColor()

copyFormat(self)

Copies the current text format to the clipboard.

See also

pasteFormat()

currentFont(self) → QFont

Returns the current QFont set by the widget. This is only used when mode() is ModeQFont.

See also

setCurrentFont()

Return type:

QFont

dialogTitle(self) → str

Returns the title for the text settings dialog window.

See also

setDialogTitle()

Return type:

str

layer(self) → QgsVectorLayer | None

Returns the layer associated with the widget.

See also

setLayer()

Added in version 3.10.

Return type:

Optional[QgsVectorLayer]

mapCanvas(self) → QgsMapCanvas | None

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Return type:

Optional[QgsMapCanvas]

messageBar(self) → QgsMessageBar | None

Returns the message bar associated with the widget.

See also

setMessageBar()

Added in version 3.10.

Return type:

Optional[QgsMessageBar]

mode(self) → QgsFontButton.Mode

Returns the current button mode.

See also

setMode()

Return type:

QgsFontButton.Mode

pasteColor(self)

Pastes a color from the clipboard to the text format. If clipboard does not contain a valid color or string representation of a color, then no change is applied. This is only used when mode() is ModeTextRenderer.

See also

copyColor()

pasteFormat(self)

Pastes a format from the clipboard. If clipboard does not contain a valid format then no change is applied.

See also

copyFormat()

registerExpressionContextGenerator(self, generator: QgsExpressionContextGenerator | None)

Register an expression context generator class that will be used to retrieve an expression context for the button when required.

Added in version 3.10.

Parameters:

generator (Optional[QgsExpressionContextGenerator])

setColor(self, color: QColor | Qt.GlobalColor)

Sets the current color for the text. Will emit a changed signal if the color is different to the previous text color. This is only used when mode() is ModeTextRenderer.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setCurrentFont(self, font: QFont)

Sets the current text font to show in the widget. This is only used when mode() is ModeQFont.

See also

currentFont()

Parameters:

font (QFont)

setDialogTitle(self, title: str | None)

Sets the title for the text settings dialog window.

See also

dialogTitle()

Parameters:

title (Optional[str])

setLayer(self, layer: QgsVectorLayer | None)

Sets a layer to associate with the widget. This allows the widget to setup layer related settings within the text settings dialog, such as correctly populating data defined override buttons.

See also

layer()

Added in version 3.10.

Parameters:

layer (Optional[QgsVectorLayer])

setMapCanvas(self, canvas: QgsMapCanvas | None)

Sets a map canvas to associate with the widget. This allows the widget to fetch current settings from the map canvas, such as current scale.

See also

mapCanvas()

Parameters:

canvas (Optional[QgsMapCanvas])

setMessageBar(self, bar: QgsMessageBar | None)

Sets the message bar associated with the widget. This allows the widget to push feedback messages to the appropriate message bar.

See also

messageBar()

Added in version 3.10.

Parameters:

bar (Optional[QgsMessageBar])

setMode(self, mode: QgsFontButton.Mode)

Sets the current button mode. This can be used to toggle between the full capabilities of the button (for configuring QgsTextFormat/QgsTextRenderer objects) and a cut-back version for configuring QFont object properties (i.e. with no color settings or the other advanced options QgsTextFormat allows).

See also

mode()

Parameters:

mode (QgsFontButton.Mode)

setNoFormatString(self, string: str | None)

Sets the string to use for the “null format” option in the button’s drop-down menu.

Note

The “null format” option is only shown if showNullFormat() is True.

See also

setShowNullFormat()

Added in version 3.16.

Parameters:

string (Optional[str])

setShowNullFormat(self, show: bool)

Sets whether the “null format” option should be shown in the button’s drop-down menu. This option is only used for buttons set to the ModeTextRenderer mode().

If selected, the “null format” option sets the button’s format to an invalid QgsTextFormat. This can be used to represent a “use default format” state for the button.

By default this option is not shown.

See also

setNoFormatString()

See also

showNullFormat()

Added in version 3.16.

Parameters:

show (bool)

setTextFormat(self, format: QgsTextFormat)

Sets the current text format to show in the widget. This is only used when mode() is ModeTextRenderer.

See also

textFormat()

Parameters:

format (QgsTextFormat)

setToNullFormat(self)

Sets the text format to a null (invalid) QgsTextFormat.

This is only used when mode() is ModeTextRenderer.

Added in version 3.16.

showNullFormat(self) → bool

Returns whether the “null format” option will be shown in the button’s drop-down menu. This option is only used for buttons set to the ModeTextRenderer mode().

If selected, the “null format” option sets the button’s format to an invalid QgsTextFormat. This can be used to represent a “use default format” state for the button.

By default this option is not shown.

See also

setShowNullFormat()

Added in version 3.16.

Return type:

bool

textFormat(self) → QgsTextFormat

Returns the current text formatting set by the widget. This is only used when mode() is ModeTextRenderer.

See also

setTextFormat()

Return type:

QgsTextFormat