QFontDialog Class Reference

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

#include <qfontdialog.h>

Inherits QDialog.

List of all member functions.

Static Public Members

QFont getFont ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 )
QFont getFont ( bool * ok, QWidget * parent = 0, const char * name = 0 )

Detailed Description

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

The usual way to use this class is to call one of the static convenience functions, e.g. getFont().

Examples:

    bool ok;
    QFont font = QFontDialog::getFont(
                    &ok, QFont( "Helvetica [Cronyx]", 10 ), this );
    if ( ok ) {
        // font is set to the font the user selected
    } else {
        // the user cancelled 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.

See also QFont, QFontInfo, QFontMetrics and Dialog Classes.

Member Function Documentation

QFont QFontDialog::getFont ( bool * ok, const QFont & initial, QWidget * parent = 0, const char * name = 0 ) `[static]`

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 called name, with the parent parent. initial is the initially selected font. If the ok parameter is not-null, *ok is set to TRUE if the user clicked OK, and set to FALSE if the user clicked Cancel.

This static function is less flexible than the full QFontDialog object, but is convenient and easy to use.

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 cancelled 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.

Examples: qfd/fontdisplayer.cpp, qwerty/qwerty.cpp and xform/xform.cpp.

QFont QFontDialog::getFont ( bool * ok, QWidget * parent = 0, const char * name = 0 ) `[static]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above 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 called name, with parent parent. If the ok parameter is not-null, *ok is set to TRUE if the user clicked OK, and FALSE if the user clicked Cancel.

This static function is less functional than the full QFontDialog object, but is convenient and easy to use.

Example:

    bool ok;
    QFont font = QFontDialog::getFont( &ok, this );
    if ( ok ) {
        // font is set to the font the user selected
    } else {
        // the user cancelled the dialog; font is set to the default
        // application font, QApplication::font()
    }

Trademarks

Qt version 3.0.4