lib

KFontChooser_local Class Reference

#include <KFontDialog_local.h>

List of all members.


Detailed Description

A font selection widget.

While KFontChooser_local as an ordinary widget can be embedded in custom dialogs and therefore is very flexible, in most cases it is preferable to use the convenience functions in KFontDialog_local.

Author:
Preston Brown <pbrown@kde.org>, Bernd Wuebben <wuebben@kde.org>
Version:
Id
kfontdialog.h,v 1.71 2004/10/10 10:27:49 bhards Exp

Definition at line 57 of file KFontDialog_local.h.


Public Types

enum  FontColumn { FamilyList = 0x01, StyleList = 0x02, SizeList = 0x04 }
enum  FontDiff { FontDiffFamily = 0x01, FontDiffStyle = 0x02, FontDiffSize = 0x04 }
enum  FontListCriteria { FixedWidthFonts = 0x01, ScalableFonts = 0x02, SmoothScalableFonts = 0x04 }

Signals

void fontSelected (const QFont &font)

Public Member Functions

 KFontChooser_local (QWidget *parent=0L, const char *name=0L, bool onlyFixed=false, const QStringList &fontList=QStringList(), bool makeFrame=true, int visibleListSize=8, bool diff=false, QButton::ToggleState *sizeIsRelativeState=0L)
virtual ~KFontChooser_local ()
void enableColumn (int column, bool state)
void setFont (const QFont &font, bool onlyFixed=false)
int fontDiffFlags ()
QFont font () const
void setColor (const QColor &col)
QColor color () const
void setBackgroundColor (const QColor &col)
QColor backgroundColor () const
void setSizeIsRelative (QButton::ToggleState relative)
QButton::ToggleState sizeIsRelative () const
QString sampleText () const
void setSampleText (const QString &text)
void setSampleBoxVisible (bool visible)
void setFamilyList (QStringList list)
virtual QSize sizeHint (void) const

Static Public Member Functions

static QString getXLFD (const QFont &theFont)
static void getFontList (QStringList &list, uint fontListCriteria)

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Properties

QFont font []

Member Enumeration Documentation

  • FamilyList - Identifies the family (leftmost) list.

  • StyleList - Identifies the style (center) list.
  • SizeList - Identifies the size (rightmost) list.

Definition at line 68 of file KFontDialog_local.h.

  • FontDiffFamily - Identifies a requested change in the font family.

  • FontDiffStyle - Identifies a requested change in the font style.
  • FontDiffSize - Identifies a requested change in the font size.

Definition at line 75 of file KFontDialog_local.h.

The selection criteria for the font families shown in the dialog.

  • FixedWidthFont when included only fixed-width fonts are returned. The fonts where the width of every character is equal.
  • ScalableFont when included only scalable fonts are returned; certain configurations allow bitmap fonts to remain unscaled and thus these fonts have limited number of sizes.
  • SmoothScalableFont when included only return smooth scalable fonts. this will return only non-bitmap fonts which are scalable to any size requested. Setting this option to true will mean the "scalable" flag is irrelavant.

Definition at line 243 of file KFontDialog_local.h.


Constructor & Destructor Documentation

KFontChooser_local::KFontChooser_local ( QWidget *  parent = 0L,
const char *  name = 0L,
bool  onlyFixed = false,
const QStringList &  fontList = QStringList(),
bool  makeFrame = true,
int  visibleListSize = 8,
bool  diff = false,
QButton::ToggleState *  sizeIsRelativeState = 0L 
)

Constructs a font picker widget.

It normally comes up with all font families present on the system; the getFont method below does allow some more fine-tuning of the selection of fonts that will be displayed in the dialog.

Consider the following code snippet;

    QStringList list;
    KFontChooser_local::getFontList(list,SmoothScalableFonts);
    KFontChooser_local chooseFont = new KFontChooser_local(0, "FontList", false, list);

The above creates a font chooser dialog with only SmoothScaleble fonts.

Parameters:
parent The parent widget.
name The widget name.
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.
diff Display the difference version dialog. See KFontDialog_local::getFontDiff().
makeFrame Draws a frame with titles around the contents.
visibleListSize The minimum number of visible entries in the fontlists.
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 95 of file KFontDialog_local.cpp.

KFontChooser_local::~KFontChooser_local (  )  [virtual]

Destructs the font chooser.

Definition at line 340 of file KFontDialog_local.cpp.


Member Function Documentation

void KFontChooser_local::enableColumn ( int  column,
bool  state 
)

Enables or disable a font column in the chooser.

Use this function if your application does not need or supports all font properties.

Parameters:
column Specify the columns. An or'ed combination of FamilyList, StyleList and SizeList is possible.
state If false the columns are disabled.

Definition at line 414 of file KFontDialog_local.cpp.

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

Sets the currently selected font in the chooser.

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 431 of file KFontDialog_local.cpp.

int KFontChooser_local::fontDiffFlags (  ) 

Returns:
The bitmask corresponding to the attributes the user wishes to change.

Definition at line 448 of file KFontDialog_local.cpp.

QFont KFontChooser_local::font (  )  const [inline]

Returns:
The currently selected font in the chooser.

Definition at line 153 of file KFontDialog_local.h.

void KFontChooser_local::setColor ( const QColor &  col  ) 

Sets the color to use in the preview.

Definition at line 364 of file KFontDialog_local.cpp.

QColor KFontChooser_local::color (  )  const

Returns:
The color currently used in the preview (default: the text color of the active color group)

Definition at line 372 of file KFontDialog_local.cpp.

void KFontChooser_local::setBackgroundColor ( const QColor &  col  ) 

Sets the background color to use in the preview.

Definition at line 377 of file KFontDialog_local.cpp.

QColor KFontChooser_local::backgroundColor (  )  const

Returns:
The background color currently used in the preview (default: the base color of the active colorgroup)

Definition at line 385 of file KFontDialog_local.cpp.

void KFontChooser_local::setSizeIsRelative ( QButton::ToggleState  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 widget this setting will be ignored.

Definition at line 390 of file KFontDialog_local.cpp.

QButton::ToggleState KFontChooser_local::sizeIsRelative (  )  const

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

Definition at line 401 of file KFontDialog_local.cpp.

QString KFontChooser_local::sampleText (  )  const [inline]

Returns:
The current text in the sample text input area.

Definition at line 195 of file KFontDialog_local.h.

void KFontChooser_local::setSampleText ( const QString &  text  )  [inline]

Sets the sample text.

Normally you should not change this text, but it can be better to do this if the default text is too large for the edit area when using the default font of your application.

Parameters:
text The new sample text. The current will be removed.

Definition at line 207 of file KFontDialog_local.h.

void KFontChooser_local::setSampleBoxVisible ( bool  visible  )  [inline]

Shows or hides the sample text box.

Parameters:
visible Set it to true to show the box, to false to hide it.

Definition at line 217 of file KFontDialog_local.h.

static QString KFontChooser_local::getXLFD ( const QFont &  theFont  )  [inline, static]

Converts a QFont into the corresponding X Logical Font Description (XLFD).

Parameters:
theFont The font to convert.
Returns:
A string representing the given font in XLFD format.

Definition at line 229 of file KFontDialog_local.h.

void KFontChooser_local::getFontList ( QStringList &  list,
uint  fontListCriteria 
) [static]

Creates a list of font strings.

Parameters:
list The list is returned here.
fontListCriteria should contain all the restrictions for font selection as OR-ed values
See also:
KFontChooser_local::FontListCriteria for the individual values

Definition at line 654 of file KFontDialog_local.cpp.

void KFontChooser_local::setFamilyList ( QStringList  list  ) 

Fill the font family list of the KFontChooser.

Parameters:
list The font list.

Definition at line 723 of file KFontDialog_local.cpp.

QSize KFontChooser_local::sizeHint ( void   )  const [virtual]

Reimplemented for internal reasons.

Definition at line 408 of file KFontDialog_local.cpp.

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

Emitted whenever the selected font changes.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys