LC::Util::WkFontsWidget Class Reference

A settings widget for configuring WebKit fonts. More...

#include "wkfontswidget.h"

Inheritance diagram for LC::Util::WkFontsWidget:

Collaboration diagram for LC::Util::WkFontsWidget:

Public Slots
void	accept ()
void	reject ()

Signals
void	fontChanged (IWkFontsSettable::FontFamily family, const QFont &font)
	Notifies the font for the given family has been changed. More...
void	sizeChanged (IWkFontsSettable::FontSize type, int size)
	Notifies the size for the given font type has been changed. More...
void	sizeMultiplierChanged (qreal factor)
	Notifies the text zoom factor has been changed. More...

Public Member Functions
	WkFontsWidget (Util::BaseSettingsManager *bsm, QWidget *parent=nullptr)
	Creates the fonts settings widget. More...
void	RegisterSettable (IWkFontsSettable *settable)
	Registers an object to be automatically updated whenever font settings change. More...
void	SetSize (IWkFontsSettable::FontSize type, int size)
	Sets the size for the given font size type. More...

Detailed Description

A settings widget for configuring WebKit fonts.

Provides a common widget for configuring QtWebKit fonts for standard WebKit font types.

This widget works through LeechCraft's XML Settings Dialog system, storing the configuration in an BaseSettingsManager instance.

This widget also supports automatically updating font settings for objects implementing the IWkFontsSettable interface if the user changes them.

Typical usage includes creating an item of type customwidget in the XML file describing the settings and then setting an instance of the WkFontsWidget as the widget for that item. On the C++ side this looks like:

FontsWidget_ = new Util::WkFontsWidget { &XmlSettingsManager::Instance () };
XmlSettingsDialog_->SetCustomWidget ("FontsSelector", FontsWidget_);

assuming the Util::BaseSettingsManager is provided by a singleton XmlSettingsManager class, and XmlSettingsDialog_ is an instance of Util::XmlSettingsDialog.

The code above also stores the WkFontsWidget as a class variable, which may be a good idea if one wishes to use the settings autoupdate feature. For example, assuming a class ChatTab properly implements the IWkFontsSettable interface:

const auto tab = new ChatTab {};
FontsWidget_->RegisterSettable (tab);

See also

IWkFontsSettable

Definition at line 68 of file wkfontswidget.h.

Constructor & Destructor Documentation

WkFontsWidget()

LC::Util::WkFontsWidget::WkFontsWidget	(	Util::BaseSettingsManager *	bsm,
		QWidget *	parent = nullptr
	)

Creates the fonts settings widget.

Parameters

[in]	bsm	The settings manager to use for storing settings.
[in]	parent	The parent widget for this widget.

Definition at line 34 of file wkfontswidget.cpp.

Member Function Documentation

accept

void LC::Util::WkFontsWidget::accept ( )

slot

Definition at line 160 of file wkfontswidget.cpp.

fontChanged

void LC::Util::WkFontsWidget::fontChanged ( IWkFontsSettable::FontFamily  family, const QFont &  font  )

signal

Notifies the font for the given family has been changed.

Parameters

[out]	family	The font family for which the font has been changed.
[out]	font	The new font for the given family.

RegisterSettable()

void LC::Util::WkFontsWidget::RegisterSettable

(

IWkFontsSettable *

settable

)

Registers an object to be automatically updated whenever font settings change.

Parameters

[in]

settable

An object implementing IWkFontsSettable.

See also

IWkFontsSettable

Definition at line 78 of file wkfontswidget.cpp.

reject

void LC::Util::WkFontsWidget::reject ( )

slot

Definition at line 176 of file wkfontswidget.cpp.

SetSize()

void LC::Util::WkFontsWidget::SetSize	(	IWkFontsSettable::FontSize	type,
		int	size
	)

Sets the size for the given font size type.

The new size is stored in settings and applied to all settables registered with this widget via RegisterSettable().

Parameters

type	The type of font size to change.
size	The new size.

Definition at line 92 of file wkfontswidget.cpp.

sizeChanged

void LC::Util::WkFontsWidget::sizeChanged ( IWkFontsSettable::FontSize  type, int  size  )

signal

Notifies the size for the given font type has been changed.

Parameters

[out]	type	The font type for which the size has been changed.
[out]	size	The new font size for the given font type.

sizeMultiplierChanged

void LC::Util::WkFontsWidget::sizeMultiplierChanged ( qreal  factor )

signal

Notifies the text zoom factor has been changed.

Parameters

[out]

factor

The new font size multiplier.

---

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

• /home/d34df00d/leechcraft/src/util/xsd/wkfontswidget.h
• /home/d34df00d/leechcraft/src/util/xsd/wkfontswidget.cpp