Inheritance diagram for Digikam::DFontProperties:

Public Types
enum	DisplayFlag { NoDisplayFlags = 0 , FixedFontsOnly = 1 , DisplayFrame = 2 , ShowDifferences = 4 }

enum	FontColumn { FamilyList = 0x01 , StyleList = 0x02 , SizeList = 0x04 }

enum	FontDiff { NoFontDiffFlags = 0 , FontDiffFamily = 1 , FontDiffStyle = 2 , FontDiffSize = 4 , AllFontDiffs = FontDiffFamily \| FontDiffStyle \| FontDiffSize }

enum	FontListCriteria { FixedWidthFonts = 0x01 , ScalableFonts = 0x02 , SmoothScalableFonts = 0x04 }

Signals
void	fontSelected (const QFont &font)

Public Member Functions
QColor	backgroundColor () const

QColor	color () const

	DFontProperties (QWidget const parent=nullptr, const DisplayFlags &flags=DisplayFrame, const QStringList &fontList=QStringList(), int visibleListSize=8, Qt::CheckState const sizeIsRelativeState=nullptr)

void	enableColumn (int column, bool state)

QFont	font () const

FontDiffFlags	fontDiffFlags () const

void	makeColumnVisible (int column, bool state)

QString	sampleText () const

void	setBackgroundColor (const QColor &col)

void	setColor (const QColor &col)

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

void	setSampleBoxVisible (bool visible)

void	setSampleText (const QString &text)

void	setSizeIsRelative (Qt::CheckState relative)

QSize	sizeHint (void) const override

Qt::CheckState	sizeIsRelative () const

	~DFontProperties () override

Static Public Member Functions
static void	getFontList (QStringList &list, uint fontListCriteria)

Properties
QColor	backgroundColor

QColor	color

QFont	font

QString	sampleText

Qt::CheckState	sizeIsRelative

Member Enumeration Documentation

◆ DisplayFlag

enum Digikam::DFontProperties::DisplayFlag

FixedFontsOnly only show fixed fonts, excluding proportional fonts
DisplayFrame show a visual frame around the chooser
ShowDifferences display the font differences interfaces

Enumerator
NoDisplayFlags
FixedFontsOnly
DisplayFrame
ShowDifferences

◆ FontColumn

enum Digikam::DFontProperties::FontColumn

FamilyList - Identifies the family (leftmost) list.
StyleList - Identifies the style (center) list.
SizeList - Identifies the size (rightmost) list.

Enumerator
FamilyList
StyleList
SizeList

◆ FontDiff

enum Digikam::DFontProperties::FontDiff

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.

Enumerator
NoFontDiffFlags
FontDiffFamily
FontDiffStyle
FontDiffSize
AllFontDiffs

◆ FontListCriteria

enum Digikam::DFontProperties::FontListCriteria

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

Enumerator
FixedWidthFonts
ScalableFonts
SmoothScalableFonts

Constructor & Destructor Documentation

◆ DFontProperties()

Digikam::DFontProperties::DFontProperties	(	QWidget *const	parent = `nullptr`,
		const DisplayFlags &	flags = `DisplayFrame`,
		const QStringList &	fontList = `QStringList()`,
		int	visibleListSize = `8`,
		Qt::CheckState *const	sizeIsRelativeState = `nullptr`
	)

explicit

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.

Parameters

parent	The parent widget.
flags	Defines how the font chooser is displayed.

See also: DisplayFlags

Parameters

fontList	A list of fonts to display, in XLFD format.
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().

References DisplayFrame, FixedFontsOnly, font, fontSelected(), setFont(), setSampleText(), setSizeIsRelative(), and ShowDifferences.

◆ ~DFontProperties()

Digikam::DFontProperties::~DFontProperties ( )

override

Destructs the font chooser.

Member Function Documentation

◆ backgroundColor()

QColor Digikam::DFontProperties::backgroundColor ( ) const

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

◆ color()

QColor Digikam::DFontProperties::color ( ) const

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

◆ enableColumn()

void Digikam::DFontProperties::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.

References FamilyList, SizeList, and StyleList.

◆ font()

QFont Digikam::DFontProperties::font ( ) const

Returns: The currently selected font in the chooser.

◆ fontDiffFlags()

DFontProperties::FontDiffFlags Digikam::DFontProperties::fontDiffFlags ( ) const

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

References FontDiffFamily, FontDiffSize, FontDiffStyle, and NoFontDiffFlags.

◆ fontSelected

void Digikam::DFontProperties::fontSelected ( const QFont & font )

signal

Emitted whenever the selected font changes.

Referenced by DFontProperties().

◆ getFontList()

void Digikam::DFontProperties::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: DFontProperties::FontListCriteria for the individual values

References FixedWidthFonts, ScalableFonts, and SmoothScalableFonts.

◆ makeColumnVisible()

void Digikam::DFontProperties::makeColumnVisible	(	int	column,
		bool	state
	)

Makes a font column in the chooser visible or invisible.

Use this function if your application does not need to show 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 made invisible.

References FamilyList, SizeList, and StyleList.

◆ sampleText()

QString Digikam::DFontProperties::sampleText ( ) const

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

◆ setBackgroundColor()

void Digikam::DFontProperties::setBackgroundColor ( const QColor & col )

Sets the background color to use in the preview.

◆ setColor()

void Digikam::DFontProperties::setColor ( const QColor & col )

Sets the color to use in the preview.

◆ setFont()

void Digikam::DFontProperties::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.

Referenced by DFontProperties().

◆ setSampleBoxVisible()

void Digikam::DFontProperties::setSampleBoxVisible ( bool visible )

Shows or hides the sample text box.

Parameters

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

◆ setSampleText()

void Digikam::DFontProperties::setSampleText ( const QString & text )

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.

Referenced by DFontProperties().

◆ setSizeIsRelative()

void Digikam::DFontProperties::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 widget this setting will be ignored.

Referenced by DFontProperties().

◆ sizeHint()

QSize Digikam::DFontProperties::sizeHint ( void ) const

override

Reimplemented for internal reasons.

◆ sizeIsRelative()

Qt::CheckState Digikam::DFontProperties::sizeIsRelative ( ) const

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

Property Documentation

◆ backgroundColor

QColor Digikam::DFontProperties::backgroundColor

readwrite

◆ color

QColor Digikam::DFontProperties::color

readwrite

◆ font

QFont Digikam::DFontProperties::font

readwrite

Referenced by DFontProperties().

◆ sampleText

QString Digikam::DFontProperties::sampleText

readwrite

◆ sizeIsRelative

Qt::CheckState Digikam::DFontProperties::sizeIsRelative

readwrite

The documentation for this class was generated from the following files:

core/libs/widgets/fonts/dfontproperties.h
core/libs/widgets/fonts/dfontproperties.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Member Enumeration Documentation

◆ DisplayFlag

◆ FontColumn

◆ FontDiff

◆ FontListCriteria

Constructor & Destructor Documentation

◆ DFontProperties()

◆ ~DFontProperties()

Member Function Documentation

◆ backgroundColor()

◆ color()

◆ enableColumn()

◆ font()

◆ fontDiffFlags()

◆ fontSelected

◆ getFontList()

◆ makeColumnVisible()

◆ sampleText()

◆ setBackgroundColor()

◆ setColor()

◆ setFont()

◆ setSampleBoxVisible()

◆ setSampleText()

◆ setSizeIsRelative()

◆ sizeHint()

◆ sizeIsRelative()

Property Documentation

◆ backgroundColor

◆ color

◆ font

◆ sampleText

◆ sizeIsRelative