class KFontDialog

A font selection dialog. More...

Definition#include <kfontdialog.h>
InheritsKDialogBase [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Signals

Public Static Methods

Protected Methods

Protected Members


Detailed Description

The KFontDialog provides a dialog for interactive font selection. It is basically a thin wrapper around the KFontChooser widget, which can also be used standalone. In most cases, the simplest use of this class is the static method KFontDialog::getFont(), which pops up the dialog, allows the user to select a font, and returns when the dialog is closed.

Example:


      QFont myFont;
      int result = KFontDialog::getFont( myFont );
      if ( result == KFontDialog::Accepted )
            ...

 KFontDialog ( QWidget *parent = 0L, const char *name = 0, bool onlyFixed = false, bool modal = false, const QStringList &fontlist = QStringList(), bool makeFrame = true, bool diff = false, QButton::ToggleState *sizeIsRelativeState = 0L )

KFontDialog

Constructs a font selection dialog.

Parameters:
parentThe parent widget of the dialog, if any.
nameThe name of the dialog.
modalSpecifies whether the dialog is modal or not.
onlyFixedonly display fonts which have fixed-width character sizes.
fontlista list of fonts to display, in XLFD format. If no list is formatted, the internal KDE font list is used. If that has not been created, X is queried, and all fonts available on the system are displayed.
makeFrameDraws a frame with titles around the contents.
diffDisplay the difference version dialog. See getFontDiff().
sizeIsRelativeStateIf not zero the widget will show a checkbox where the user may choose whether the font size is to be interpreted as relative size. Initial state of this checkbox will be set according to *sizeIsRelativeState, user choice may be retrieved by calling sizeIsRelative().

void  setFont ( const QFont &font, bool onlyFixed = false )

setFont

Sets the currently selected font in the dialog.

Parameters:
fontThe font to select.
onlyFixedreadjust the font list to display only fixed width fonts if true, or vice-versa

QFont  font ()

font

[const]

Returns: The currently selected font in the dialog.

void  setSizeIsRelative ( QButton::ToggleState relative )

setSizeIsRelative

Sets the state of the checkbox indicating whether the font size is to be interpreted as relative size. NOTE: If parameter sizeIsRelative was not set in the constructor of the dialog this setting will be ignored.

QButton::ToggleState  sizeIsRelative ()

sizeIsRelative

[const]

Returns: Whether the font size is to be interpreted as relative size (default: false)

void  setCharset ( const QString & charset )

setCharset

Sets the currently selected charset in the dialog.

QString  charset ()

charset

[const]

Returns: The currently selected charset in the dialog.

int  getFont ( QFont &theFont, bool onlyFixed = false, QWidget *parent = 0L, bool makeFrame = true, QButton::ToggleState *sizeIsRelativeState = 0L )

getFont

[static]

Creates a modal font dialog, lets the user choose a font, and returns when the dialog is closed.

Parameters:
theFonta reference to the font to write the chosen font into.
onlyFixedif true, only select from fixed-width fonts.
parentParent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).
makeFrameDraws a frame with titles around the contents.
sizeIsRelativeStateIf not zero the widget will show a checkbox where the user may choose whether the font size is to be interpreted as relative size. Initial state of this checkbox will be set according to *sizeIsRelativeState and user choice will be returned therein.

Returns: QDialog::result().

int  getFontDiff ( QFont &theFont, int &diffFlags, bool onlyFixed = false, QWidget *parent = 0L, bool makeFrame = true, QButton::ToggleState *sizeIsRelativeState = 0L )

getFontDiff

[static]

Creates a modal font difference dialog, lets the user choose a selection of changes that should be made to a set of fonts, and returns when the dialog is closed. Useful for choosing slight adjustments to the font set when the user would otherwise have to manually edit a number of fonts.


        if ( diffFlags & KFontChooser::FontDiffFamily )
            [...]
        if ( diffFlags & KFontChooser::FontDiffStyle )
            [...]
        if ( diffFlags & KFontChooser::FontDiffSize )
            [...]

Parameters:
theFonta reference to the font to write the chosen font into.
diffFlagsa reference to the int into which the chosen difference selection bitmask should be written. Check the returned bitmask like:
onlyFixedif true, only select from fixed-width fonts.
parentParent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).
makeFrameDraws a frame with titles around the contents.
sizeIsRelativeStateIf not zero the widget will show a checkbox where the user may choose whether the font size is to be interpreted as relative size. Initial state of this checkbox will be set according to *sizeIsRelativeState and user choice will be returned therein.

Returns: QDialog::result().

int  getFontAndText ( QFont &theFont, QString &theString, bool onlyFixed = false, QWidget *parent = 0L, bool makeFrame = true, QButton::ToggleState *sizeIsRelativeState = 0L )

getFontAndText

[static]

When you are not only interested in the font selected, but also in the example string typed in, you can call this method.

Parameters:
theFonta reference to the font to write the chosen font into.
theStringa reference to the example text that was typed.
onlyFixedif true, only select from fixed-width fonts.
parentParent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).
makeFrameDraws a frame with titles around the contents.
sizeIsRelativeStateIf not zero the widget will show a checkbox where the user may choose whether the font size is to be interpreted as relative size. Initial state of this checkbox will be set according to *sizeIsRelativeState and user choice will be returned therein.

Returns: The result of the dialog.

void  fontSelected ( const QFont &font )

fontSelected

[signal]

Emitted whenever the currently selected font changes. Connect to this to monitor the font as it is selected if you are not running modal.

KFontChooser * chooser

chooser

[protected]

void  virtual_hook ( int id, void* data )

virtual_hook

[protected virtual]

Reimplemented from KDialogBase.