Subgroup: Font

Class: QgsFontButton¶

class qgis.gui.QgsFontButton¶

Bases: PyQt5.QtWidgets.QToolButton

A button for customising 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.

New in version 3.0: Methods

`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`adjustSize`
`animateClick`
`arrowType`
`autoExclusive`
`autoFillBackground`
`autoRaise`
`autoRepeat`
`autoRepeatDelay`
`autoRepeatInterval`
`backgroundRole`
`baseSize`
`blockSignals`
`changeEvent`
`checkStateSet`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clearFocus`
`clearMask`
`click`
`close`
`closeEvent`
`colorCount`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`copyColor`	Copies the current text color to the clipboard.
`copyFormat`	Copies the current text format to the clipboard.
`create`
`createWindowContainer`
`currentFont`	Returns the current QFont set by the widget.
`cursor`
`customEvent`
`defaultAction`
`deleteLater`
`depth`
`destroy`
`devType`
`devicePixelRatio`
`devicePixelRatioF`
`devicePixelRatioFScale`
`dialogTitle`	Returns the title for the text settings dialog window.
`disconnect`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`effectiveWinId`
`ensurePolished`
`enterEvent`
`event`
`eventFilter`
`find`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPolicy`
`focusPreviousChild`
`focusProxy`
`focusWidget`
`font`
`fontInfo`
`fontMetrics`
`foregroundRole`
`frameGeometry`
`frameSize`
`geometry`
`getContentsMargins`
`grab`
`grabGesture`
`grabKeyboard`
`grabMouse`	grabMouse(self, Union[QCursor, Qt.CursorShape])
`grabShortcut`
`graphicsEffect`
`graphicsProxyWidget`
`group`
`hasFocus`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideEvent`
`hitButton`
`icon`
`iconSize`
`inherits`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`insertAction`
`insertActions`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isCheckable`
`isChecked`
`isDown`
`isEnabled`
`isEnabledTo`
`isFullScreen`
`isHidden`
`isLeftToRight`
`isMaximized`
`isMinimized`
`isModal`
`isRightToLeft`
`isSignalConnected`
`isVisible`
`isVisibleTo`
`isWidgetType`
`isWindow`
`isWindowModified`
`isWindowType`
`keyPressEvent`
`keyReleaseEvent`
`keyboardGrabber`
`killTimer`
`layout`
`layoutDirection`
`leaveEvent`
`locale`
`logicalDpiX`
`logicalDpiY`
`lower`
`mapCanvas`	Returns the map canvas associated with the widget.
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maximumHeight`
`maximumSize`
`maximumWidth`
`menu`
`metaObject`
`metric`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`mode`	Returns the current button mode.
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextCheckState`
`nextInFocusChain`
`normalGeometry`
`objectName`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`pasteColor`	Pastes a color from the clipboard to the text format.
`pasteFormat`	Pastes a format from the clipboard.
`physicalDpiX`
`physicalDpiY`
`popupMode`
`pos`
`previousInFocusChain`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`raise_`
`receivers`
`rect`
`releaseKeyboard`
`releaseMouse`
`releaseShortcut`
`removeAction`
`removeEventFilter`
`render`	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground\|QWidget.DrawChildren))
`repaint`	repaint(self, int, int, int, int)
`resize`	resize(self, int, int)
`resizeEvent`
`restoreGeometry`
`saveGeometry`
`scroll`	scroll(self, int, int, QRect)
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setArrowType`
`setAttribute`
`setAutoExclusive`
`setAutoFillBackground`
`setAutoRaise`
`setAutoRepeat`
`setAutoRepeatDelay`
`setAutoRepeatInterval`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setCheckable`
`setChecked`
`setColor`	Sets the current `color` for the text.
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCurrentFont`	Sets the current text `font` to show in the widget.
`setCursor`
`setDefaultAction`
`setDialogTitle`	Sets the `title` for the text settings dialog window.
`setDisabled`
`setDown`
`setEnabled`
`setFixedHeight`
`setFixedSize`	setFixedSize(self, int, int)
`setFixedWidth`
`setFocus`	setFocus(self, Qt.FocusReason)
`setFocusPolicy`
`setFocusProxy`
`setFont`
`setForegroundRole`
`setGeometry`	setGeometry(self, int, int, int, int)
`setGraphicsEffect`
`setHidden`
`setIcon`
`setIconSize`
`setInputMethodHints`
`setLayout`
`setLayoutDirection`
`setLocale`
`setMapCanvas`	Sets a map `canvas` to associate with the widget.
`setMask`	setMask(self, QRegion)
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMenu`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setMode`	Sets the current button `mode`.
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setPopupMode`
`setProperty`
`setShortcut`
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabOrder`
`setTabletTracking`
`setText`
`setTextFormat`	Sets the current text `format` to show in the widget.
`setToolButtonStyle`
`setToolTip`
`setToolTipDuration`
`setUpdatesEnabled`
`setVisible`
`setWhatsThis`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`sharedPainter`
`shortcut`
`show`
`showEvent`
`showFullScreen`
`showMaximized`
`showMenu`
`showMinimized`
`showNormal`
`signalsBlocked`
`size`
`sizeHint`
`sizeIncrement`
`sizePolicy`
`stackUnder`
`startTimer`
`statusTip`
`style`
`styleSheet`
`tabletEvent`
`testAttribute`
`text`
`textFormat`	Returns the current text formatting set by the widget.
`thread`
`timerEvent`
`toggle`
`toolButtonStyle`
`toolTip`
`toolTipDuration`
`tr`
`underMouse`
`ungrabGesture`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QRect)
`updateGeometry`
`updateMicroFocus`
`updatesEnabled`
`visibleRegion`
`whatsThis`
`wheelEvent`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`x`
`y`

Attributes

`DelayedPopup`
`DrawChildren`
`DrawWindowBackground`
`IgnoreMask`
`InstantPopup`
`MenuButtonPopup`
`ModeQFont`
`ModeTextRenderer`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`changed`	Emitted when the widget’s text format settings are changed.
`clicked`	clicked(self, bool = False) [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`pressed`	pressed(self) [signal]
`released`	released(self) [signal]
`staticMetaObject`
`toggled`	toggled(self, bool) [signal]
`triggered`	triggered(self, QAction) [signal]
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [signal]

class Mode¶: Bases: int

ModeQFont = 1¶

ModeTextRenderer = 0¶

actionEvent()¶

changeEvent(self, e: QEvent)¶

changed¶: Emitted when the widget’s text format settings are changed. [signal]

checkStateSet()¶

childEvent()¶

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

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()

create()¶

currentFont(self) → QFont¶: Returns the current QFont set by the widget. This is only used when mode() is ModeQFont.

See also

setCurrentFont()

customEvent()¶

destroy()¶

dialogTitle(self) → str¶: Returns the title for the text settings dialog window.

See also

setDialogTitle()

disconnectNotify()¶

dragEnterEvent(self, e: QDragEnterEvent)¶

dragLeaveEvent(self, e: QDragLeaveEvent)¶

dragMoveEvent()¶

dropEvent(self, e: QDropEvent)¶

enterEvent()¶

event(self, e: QEvent) → bool¶

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

hitButton()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

isSignalConnected()¶

keyPressEvent()¶

keyReleaseEvent()¶

leaveEvent()¶

mapCanvas(self) → QgsMapCanvas¶: Returns the map canvas associated with the widget.

See also

setMapCanvas()

metric()¶

minimumSizeHint(self) → QSize¶

mode(self) → QgsFontButton.Mode¶: Returns the current button mode.

See also

setMode()

mouseDoubleClickEvent()¶

mouseMoveEvent(self, e: QMouseEvent)¶

mousePressEvent(self, e: QMouseEvent)¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

nextCheckState()¶

paintEvent()¶

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()

receivers()¶

resizeEvent(self, event: QResizeEvent)¶

sender()¶

senderSignalIndex()¶

setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])¶: 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.

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()

setDialogTitle(self, title: str)¶: Sets the title for the text settings dialog window.

See also

dialogTitle()

setMapCanvas(self, canvas: QgsMapCanvas)¶: 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()

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()

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()

sharedPainter()¶

showEvent(self, e: QShowEvent)¶

sizeHint(self) → QSize¶

tabletEvent()¶

textFormat(self) → QgsTextFormat¶: Returns the current text formatting set by the widget. This is only used when mode() is ModeTextRenderer.

See also

setTextFormat()

timerEvent()¶

updateMicroFocus()¶

wheelEvent(self, event: QWheelEvent)¶