• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KFontDialog Class Reference

A font selection dialog. More...

#include <kfontdialog.h>

Inheritance diagram for KFontDialog:
KDialog QDialog

List of all members.

Signals

void fontSelected (const QFont &font)

Public Member Functions

QFont font () const
 KFontDialog (QWidget *parent=0, const KFontChooser::DisplayFlags &flags=KFontChooser::NoDisplayFlags, const QStringList &fontlist=QStringList(), Qt::CheckState *sizeIsRelativeState=0)
void setFont (const QFont &font, bool onlyFixed=false)
void setSizeIsRelative (Qt::CheckState relative)
Qt::CheckState sizeIsRelative () const
 ~KFontDialog ()

Static Public Member Functions

static int getFont (QFont &theFont, const KFontChooser::DisplayFlags &flags=KFontChooser::NoDisplayFlags, QWidget *parent=0L, Qt::CheckState *sizeIsRelativeState=0L)
static int getFontAndText (QFont &theFont, QString &theString, const KFontChooser::DisplayFlags &flags=KFontChooser::NoDisplayFlags, QWidget *parent=0L, Qt::CheckState *sizeIsRelativeState=0L)
static int getFontDiff (QFont &theFont, KFontChooser::FontDiffFlags &diffFlags, const KFontChooser::DisplayFlags &flags=KFontChooser::NoDisplayFlags, QWidget *parent=0L, Qt::CheckState *sizeIsRelativeState=0L)

Detailed Description

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

KDE Font Dialog

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

Definition at line 56 of file kfontdialog.h.


Constructor & Destructor Documentation

KFontDialog::KFontDialog ( QWidget *  parent = 0,
const KFontChooser::DisplayFlags &  flags = KFontChooser::NoDisplayFlags,
const QStringList &  fontlist = QStringList(),
Qt::CheckState *  sizeIsRelativeState = 0 
) [explicit]

Constructs a font selection dialog.

Parameters:
parent The parent widget of the dialog, if any.
flags Defines how the font chooser is displayed.
See also:
KFontChooser::DisplayFlags
Parameters:
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().

Definition at line 68 of file kfontdialog.cpp.

KFontDialog::~KFontDialog (  ) 

Definition at line 87 of file kfontdialog.cpp.


Member Function Documentation

QFont KFontDialog::font (  )  const
Returns:
The currently selected font in the dialog.

Definition at line 97 of file kfontdialog.cpp.

void KFontDialog::fontSelected ( const QFont &  font  )  [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.

int KFontDialog::getFont ( QFont &  theFont,
const KFontChooser::DisplayFlags &  flags = KFontChooser::NoDisplayFlags,
QWidget *  parent = 0L,
Qt::CheckState *  sizeIsRelativeState = 0L 
) [static]

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

Parameters:
theFont a reference to the font to write the chosen font into.
flags Defines how the font chooser is displayed.
See also:
KFontChooser::DisplayFlags
Parameters:
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().

Definition at line 136 of file kfontdialog.cpp.

int KFontDialog::getFontAndText ( QFont &  theFont,
QString &  theString,
const KFontChooser::DisplayFlags &  flags = KFontChooser::NoDisplayFlags,
QWidget *  parent = 0L,
Qt::CheckState *  sizeIsRelativeState = 0L 
) [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:
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
Parameters:
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.

Definition at line 157 of file kfontdialog.cpp.

int KFontDialog::getFontDiff ( QFont &  theFont,
KFontChooser::FontDiffFlags &  diffFlags,
const KFontChooser::DisplayFlags &  flags = KFontChooser::NoDisplayFlags,
QWidget *  parent = 0L,
Qt::CheckState *  sizeIsRelativeState = 0L 
) [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.

Parameters:
theFont a reference to the font to write the chosen font into.
flags Defines how the font chooser is displayed.
See also:
KFontChooser::DisplayFlags
Parameters:
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().

Definition at line 113 of file kfontdialog.cpp.

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

Sets the currently selected font in the dialog.

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

Definition at line 92 of file kfontdialog.cpp.

void KFontDialog::setSizeIsRelative ( Qt::CheckState  relative  ) 

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.

Definition at line 102 of file kfontdialog.cpp.

Qt::CheckState KFontDialog::sizeIsRelative (  )  const
Returns:
Whether the font size is to be interpreted as relative size (default: false)

Definition at line 107 of file kfontdialog.cpp.


The documentation for this class was generated from the following files:
  • kfontdialog.h
  • kfontdialog.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal