# class KFontDialog

###

Module | kdeui
Namespace |
Class | KFontDialog
Inherits | KDialog

A font selection dialog.

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

Author Preston Brown <pbrown@kde.org>, Bernd Wuebben <wuebben@kde.org>

### methods

- KFontDialog (parent, flags, fontlist, sizeIsRelativeState)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | 0
  flags | KFontChooser.DisplayFlags | KFontChooser.NoDisplayFlags
  fontlist | QStringList | QStringList()
  sizeIsRelativeState | Qt.CheckState | 0

  Constructs a font selection dialog.

  parent - The parent widget of the dialog, if any.

  flags - Defines how the font chooser is displayed.

  See also KFontChooser.DisplayFlags

  onlyFixed - only display fonts which have fixed-width character sizes.

  fontlist - a 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.

  makeFrame - Draws a frame with titles around the contents.

  diff - Display the difference version dialog. See getFontDiff().

  sizeIsRelativeState - If 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().

- KFontDialog (a0)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  a0 | KFontDialog |

- KFontDialog (a0, a1, a2, a3)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QWidget | 0
  a1 | KFontChooser.DisplayFlags | KFontChooser.NoDisplayFlags
  a2 | QStringList | QStringList()
  a3 | Qt.CheckState | Qt.Unchecked

- font ( )

  returns QFont

  Returns The currently selected font in the dialog.

- fontSelected (font)

  returns Nothing
  SIGNAL ("fontSelected (const QFont&)")

  Argument | Type | Default
  --- | --- | ---
  font | QFont |

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

- getFont (a0, a1, a2, a3)

  returns SIP_PYTUPLE
  static

  Argument | Type | Default
  --- | --- | ---
  a0 | QFont |
  a1 | KFontChooser.DisplayFlags | KFontChooser.NoDisplayFlags
  a2 | QWidget | 0
  a3 | Qt.CheckState | Qt.Unchecked

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

  theFont - a reference to the font to write the chosen font into.

  flags - Defines how the font chooser is displayed.

  See also KFontChooser.DisplayFlags

  parent - Parent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).

  makeFrame - Draws a frame with titles around the contents.

  sizeIsRelativeState - If 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().

- getFontAndText (a0, a1, a2, a3, a4)

  returns SIP_PYTUPLE
  static

  Argument | Type | Default
  --- | --- | ---
  a0 | QFont |
  a1 | QString |
  a2 | KFontChooser.DisplayFlags | KFontChooser.NoDisplayFlags
  a3 | QWidget | 0
  a4 | Qt.CheckState | Qt.Unchecked

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

  theFont - a reference to the font to write the chosen font into.

  theString - a reference to the example text that was typed.

  flags - Defines how the font chooser is displayed.

  See also KFontChooser.DisplayFlags

  parent - Parent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).

  sizeIsRelativeState - If 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.

- getFontDiff (a0, a1, a2, a3, a4)

  returns SIP_PYTUPLE
  static

  Argument | Type | Default
  --- | --- | ---
  a0 | QFont |
  a1 | KFontChooser.FontDiffFlags |
  a2 | KFontChooser.DisplayFlags | KFontChooser.NoDisplayFlags
  a3 | QWidget | 0
  a4 | Qt.CheckState | Qt.Unchecked

  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.

  theFont - a reference to the font to write the chosen font into.

  flags - Defines how the font chooser is displayed.

  See also KFontChooser.DisplayFlags

  diffFlags - a reference to the int into which the chosen difference selection bitmask should be written. Check the returned bitmask like:

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

  parent - Parent widget of the dialog. Specifying a widget different from 0 (Null) improves centering (looks better).

  sizeIsRelativeState - If 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().

- setFont (font, onlyFixed)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  font | QFont |
  onlyFixed | bool | 0

  Sets the currently selected font in the dialog.

  font - The font to select.

  onlyFixed - readjust the font list to display only fixed width fonts if true, or vice-versa

- setSizeIsRelative (relative)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  relative | Qt.CheckState |

  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.

- sizeIsRelative ( )

  returns Qt.CheckState

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