QFontDialog Class

Member Function Documentation

QFontDialog::QFontDialog(const QFont &initial, QWidget *parent = nullptr)

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

This function was introduced in Qt 4.5.

QFontDialog::QFontDialog(QWidget *parent = nullptr)

Constructs a standard font dialog.

Use setCurrentFont() to set the initial font attributes.

The parent parameter is passed to the QDialog constructor.

This function was introduced in Qt 4.5.

See also getFont().

[signal] void QFontDialog::currentFontChanged(const QFont &font)

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.

Note: Notifier signal for property currentFont.

This function was introduced in Qt 4.5.

See also currentFont, fontSelected(), and selectedFont().

[signal] void QFontDialog::fontSelected(const QFont &font)

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.

This function was introduced in Qt 4.5.

See also selectedFont(), currentFontChanged(), and currentFont.

[override virtual protected] void QFontDialog::changeEvent(QEvent *e)

Reimplements: QWidget::changeEvent(QEvent *event).

QFont QFontDialog::currentFont() const

Returns the current font.

Note: Getter function for property currentFont.

This function was introduced in Qt 4.5.

See also setCurrentFont() and selectedFont().

[override virtual protected] void QFontDialog::done(int result)

Reimplements: QDialog::done(int r).

Closes the dialog and sets its result code to result. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return result.

See also QDialog::done().

[static] QFont QFontDialog::getFont(bool *ok, const QFont &initial, QWidget *parent = nullptr, const QString &title = QString(), QFontDialog::FontDialogOptions options = FontDialogOptions())

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:

bool ok;
QFont font = QFontDialog::getFont(&ok, QFont("Times", 12), this);
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.

[static] QFont QFontDialog::getFont(bool *ok, QWidget *parent = nullptr)

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:

bool ok;
QFont font = QFontDialog::getFont(&ok, this);
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()
}

void QFontDialog::open(QObject *receiver, const char *member)

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.

This function was introduced in Qt 4.5.

QFont QFontDialog::selectedFont() const

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

void QFontDialog::setCurrentFont(const QFont &font)

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

Note: Setter function for property currentFont.

This function was introduced in Qt 4.5.

See also currentFont() and selectedFont().

void QFontDialog::setOption(QFontDialog::FontDialogOption option, bool on = true)

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

See also options and testOption().

[override virtual] void QFontDialog::setVisible(bool visible)

Reimplements: QDialog::setVisible(bool visible).

bool QFontDialog::testOption(QFontDialog::FontDialogOption option) const

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

See also options and setOption().