class QFontDialog

The QFontDialog class provides a dialog widget for selecting a font. More…

Inheritance diagram of PySide6.QtWidgets.QFontDialog

Synopsis

Properties

  • currentFontᅟ - The current font of the dialog

  • optionsᅟ - The various options that affect the look and feel of the dialog

Methods

Signals

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

A font dialog is created through one of the static getFont() functions.

Examples:

ok = bool()
font = QFontDialog.getFont(()
                ok, QFont("Helvetica [Cronyx]", 10), self)
if ok:
    # the user clicked OK and font is set to the font the user selected
else:
    # the user canceled the dialog; font is set to the initial
    # value, in this case Helvetica [Cronyx], 10

The dialog can also be used to set a widget’s font directly:

myWidget.setFont(QFontDialog.getFont(0, myWidget.font()))

If the user clicks OK the font they chose will be used for myWidget, and if they click Cancel the original font is used.

../../_images/fusion-fontdialog.png

See also

QColorDialog QFileDialog Standard Dialogs Example

class FontDialogOption

(inherits enum.Flag) This enum specifies various options that affect the look and feel of a font dialog.

For instance, it allows to specify which type of font should be displayed. If none are specified all fonts available will be listed.

Note that the font filtering options might not be supported on some platforms (e.g. Mac). They are always supported by the non native dialog (used on Windows or Linux).

Constant

Description

QFontDialog.NoButtons

Don’t display OK and Cancel buttons. (Useful for “live dialogs”.)

QFontDialog.DontUseNativeDialog

Use Qt’s standard font dialog on the Mac instead of Apple’s native font panel.

QFontDialog.ScalableFonts

Show scalable fonts

QFontDialog.NonScalableFonts

Show non scalable fonts

QFontDialog.MonospacedFonts

Show monospaced fonts

QFontDialog.ProportionalFonts

Show proportional fonts

See also

options setOption() testOption()

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property currentFontᅟ: QFont

This property holds the current font of the dialog..

Access functions:
property optionsᅟ: Combination of QFontDialog.FontDialogOption

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

Constructs a standard font dialog.

Use setCurrentFont() to set the initial font attributes.

The parent parameter is passed to the QDialog constructor.

See also

getFont()

__init__(initial[, parent=None])
Parameters:

Constructs a standard font dialog with the given parent and specified initial font.

currentFont()
Return type:

QFont

Returns the current font.

Getter of property currentFontᅟ .

currentFontChanged(font)
Parameters:

font – QFont

This signal is emitted when the current font is changed. The new font is specified in font.

The signal is emitted while a user is selecting a font. Ultimately, the chosen font may differ from the font currently selected.

Notification signal of property currentFontᅟ .

fontSelected(font)
Parameters:

font – QFont

This signal is emitted when a font has been selected. The selected font is specified in font.

The signal is only emitted when a user has chosen the final font to be used. It is not emitted while the user is changing the current font in the font dialog.

static getFont([parent=None])
Parameters:

parent – QWidget

Return type:

PyTuple

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This is an overloaded function.

Executes a modal font dialog and returns a font.

If the user clicks OK, the selected font is returned. If the user clicks Cancel, the Qt default font is returned.

The dialog is constructed with the given parent. If the ok parameter is not-null, the value it refers to is set to true if the user clicks OK, and false if the user clicks Cancel.

Example:

ok = bool()
font = QFontDialog.getFont(ok, self)
if ok:
    # font is set to the font the user selected
else:
    # the user canceled the dialog; font is set to the default
    # application font, QApplication::font()

Warning

Do not delete parent during the execution of the dialog. If you want to do this, you should create the dialog yourself using one of the QFontDialog constructors.

static getFont(initial[, parent=None[, title=""[, options=QFontDialog.FontDialogOptions()]]])
Parameters:
Return type:

PyTuple

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Executes a modal font dialog and returns a font.

If the user clicks OK, the selected font is returned. If the user clicks Cancel, the initial font is returned.

The dialog is constructed with the given parent and the options specified in options. title is shown as the window title of the dialog and initial is the initially selected font. If the ok parameter is not-null, the value it refers to is set to true if the user clicks OK, and set to false if the user clicks Cancel.

Examples:

ok = bool()
font = QFontDialog.getFont(ok, QFont("Times", 12), self)
if ok:
    # font is set to the font the user selected
else:
    # the user canceled the dialog; font is set to the initial
    # value, in this case Times, 12.

The dialog can also be used to set a widget’s font directly:

myWidget.setFont(QFontDialog.getFont(0, myWidget.font()))

In this example, if the user clicks OK the font they chose will be used, and if they click Cancel the original font is used.

Warning

Do not delete parent during the execution of the dialog. If you want to do this, you should create the dialog yourself using one of the QFontDialog constructors.

open(receiver, member)
Parameters:

  • receiver – QObject

  • member – str

Opens the dialog and connects its fontSelected() signal to the slot specified by receiver and member.

The signal will be disconnected from the slot when the dialog is closed.

options()
Return type:

Combination of FontDialogOption

See also

setOptions()

Getter of property optionsᅟ .

selectedFont()
Return type:

QFont

Returns the font that the user selected by clicking the OK or equivalent button.

Note

This font is not always the same as the font held by the currentFont property since the user can choose different fonts before finally selecting the one to use.

setCurrentFont(font)
Parameters:

font – QFont

Sets the font highlighted in the QFontDialog to the given font.

Setter of property currentFontᅟ .

setOption(option[, on=true])
Parameters:

Sets the given option to be enabled if on is true; otherwise, clears the given option.

setOptions(options)
Parameters:

options – Combination of FontDialogOption

See also

options()

Setter of property optionsᅟ .

testOption(option)
Parameters:

option – FontDialogOption

Return type:

bool

Returns true if the given option is enabled; otherwise, returns false.

See also

options setOption()