SALOME style model. More...

#include <Style_Model.h>

Classes
struct	AppData

Public Types
enum	ColorRole { WindowText = QPalette::WindowText , Button = QPalette::Button , Light = QPalette::Light , Midlight = QPalette::Midlight , Dark = QPalette::Dark , Mid = QPalette::Mid , Text = QPalette::Text , BrightText = QPalette::BrightText , ButtonText = QPalette::ButtonText , Base = QPalette::Base , Window = QPalette::Window , Shadow = QPalette::Shadow , Highlight = QPalette::Highlight , HighlightedText = QPalette::HighlightedText , Link = QPalette::Link , LinkVisited = QPalette::LinkVisited , AlternateBase = QPalette::AlternateBase , NoRole = QPalette::NoRole , ToolTipBase = QPalette::ToolTipBase , ToolTipText = QPalette::ToolTipText , NColorRoles = QPalette::NColorRoles , BorderTop = NColorRoles , BorderBottom , TabBorderTop , TabBorderBottom , FieldLight , FieldDark , Slider , Lines , HighlightWidget , HighlightBorder , Header , ProgressBar , Pointer , Checked , GridLine , LastColor }
	Color palette instance enumeration. More...

enum	LineType { NoLines , Horizontal , Inclined }
	Lines type. More...

enum	WidgetRounding { ButtonRadius , EditRadius , FrameRadius , SliderRadius }

enum	WidgetEffect { NoEffect , HighlightEffect , AutoRaiseEffect }
	Widget effect. More...

Public Member Functions
	Style_Model ()
	Constructor. More...

virtual	~Style_Model ()
	Destructor. More...

void	fromApplication (bool=false)
	Initialize model from the current application style. More...

void	fromResources (QtxResourceMgr *, const QString &=QString())
	Initialize model from the resources. More...

void	save (QtxResourceMgr *=0, const QString &=QString())
	Save SALOME stype properties to the resource file. More...

void	update ()
	Reload SALOME style properties from the resources file(s). More...

void	restore ()
	Restore original style, palette and font to the application. More...

QtxResourceMgr *	resourceMgr () const
	Get resource manager used by this SALOME style model. More...

QString	resourceSection () const
	Get resources section name. More...

QColor	color (ColorRole, QPalette::ColorGroup=QPalette::Active) const
	Get palette color value. More...

void	setColor (ColorRole, const QColor &, const QColor &=QColor(), const QColor &=QColor())
	Set palette color value. More...

void	setColor (ColorRole, QPalette::ColorGroup, const QColor &)
	Set palette color value. More...

bool	isAutoPalette () const
	Returns 'auto-calculating color values' flag. More...

void	setAutoPalette (bool)
	Set/clear 'auto-calculating color values' flag. More...

LineType	linesType () const
	Get lines type. More...

void	setLinesType (LineType)
	Set lines type. More...

int	linesTransparency () const
	Get lines transparency value. More...

void	setLinesTransparency (int)
	Set lines transparency value. More...

QFont	applicationFont () const
	Get application font. More...

void	setApplicationFont (const QFont &)
	Set application font. More...

double	widgetRounding (WidgetRounding) const
	Get widget corners rounding radius value. More...

void	setWidgetRounding (WidgetRounding, double)
	Set widget corners rounding radius value. More...

bool	antialiasing () const
	Get anti-aliasing flag value. More...

void	setAntialiasing (bool)
	Set anti-aliasing flag value. More...

WidgetEffect	widgetEffect () const
	Get widget effect. More...

void	setWidgetEffect (WidgetEffect)
	Set widget effect. More...

int	handleDelta (Qt::Orientation) const
	Get handle spacing value. More...

void	setHandleDelta (Qt::Orientation, int)
	Set handle spacing value. More...

int	splitHandleLength () const
	Get splitter handle length. More...

void	setSplitHandleLength (int)
	Set splitted handle length. More...

int	sliderSize () const
	Get slider handle extra size. More...

void	setSliderSize (int)
	Set slider handle extra size. More...

Private Types
typedef QMap< ColorRole, QColor >	ColorMap

typedef QMap< QPalette::ColorGroup, ColorMap >	ColorGroupMap

typedef QMap< WidgetRounding, double >	RoundMap

typedef QMap< Qt::Orientation, int >	DeltaMap

Private Member Functions
void	initDefaults ()
	Initialize model with the default values. More...

void	readColorValue (ColorRole, const QString &)
	Read palette color values from resources manager. More...

void	writeColorValue (ColorRole, const QString &, QtxResourceMgr *, const QString &) const
	Write palette color values to resources manager. More...

Private Attributes
QtxResourceMgr *	myResourceMgr

QString	myResourceSection

ColorGroupMap	myColors

bool	myAutoPalette

RoundMap	myWidgetRounding

DeltaMap	myHandleDelta

QFont	myFont

LineType	myLinesType

WidgetEffect	myWidgetEffect

bool	myAntiAliasing

int	myLinesTransparency

int	mySplitHandleLength

int	mySliderSize

Static Private Attributes
static AppData *	myAppData = 0
	Application style data. More...

Detailed Description

SALOME style model.

Style model class stores properties of the SALOME style, like palette colors, widget roundings etc. It allows reading these properties from the resource file and write them back to resource file.

SALOME_Style class provides an access to the global style model (which is applied to the application). To get access to the global SALOME style model, use static Style_Model::model() function.

See also: Style_Salome class

Member Typedef Documentation

◆ ColorGroupMap

typedef QMap<QPalette::ColorGroup, ColorMap> Style_Model::ColorGroupMap

private

◆ ColorMap

typedef QMap<ColorRole, QColor> Style_Model::ColorMap

private

◆ DeltaMap

typedef QMap<Qt::Orientation, int> Style_Model::DeltaMap

private

◆ RoundMap

typedef QMap<WidgetRounding, double> Style_Model::RoundMap

private

Member Enumeration Documentation

◆ ColorRole

enum Style_Model::ColorRole

Color palette instance enumeration.

Enumerator
WindowText	A general foreground color.
Button	The general button background color.
Light	Usually lighter than Button color.
Midlight	Usually between Button and Light.
Dark	Usually darker than Button.
Mid	Usualliy between Button and Dark.
Text	The foreground color used with Base.
BrightText	A text color that is very different from WindowText, and contrasts well with e.g. Dark.
ButtonText	A foreground color used with the Button color.
Base	Used mostly as the background color for text entry widgets.
Window	A general background color.
Shadow	Usually a very dark palette color.
Highlight	A color to indicate a selected item or the current item.
HighlightedText	A text color that contrasts with Highlight.
Link	A text color used for unvisited hyperlinks.
LinkVisited	A text color used for already visited hyperlinks.
AlternateBase	Used as the alternate background color in views with alternating row colors.
NoRole	No role; this special role is often used to indicate that a role has not been assigned.
ToolTipBase	Used as the background color for QToolTip and QWhatsThis.
ToolTipText	Used as the foreground color for QToolTip and QWhatsThis.
NColorRoles	Used to indicate last standard palette color.
BorderTop	Used to draw top-left borders of the widgets.
BorderBottom	Used to draw bottom-right borders of the widgets.
TabBorderTop	Used to draw top-left borders of the tab panels.
TabBorderBottom	Used to draw bottom-right borders of the tab panels.
FieldLight	Light component of the text entry widgets.
FieldDark	Dark component of the text entry widgets.
Slider	Used to draw sliders.
Lines	Used to draw lines throughout all the widgets.
HighlightWidget	Used to draw widget background when widget is hovered.
HighlightBorder	Used to draw widget borders when widget is hovered.
Header	Used to draw header of tab panels.
ProgressBar	Main progress bar color.
Pointer	Used to draw different widgets indicators like spin box arrows etc.
Checked	Check box indicator color.
GridLine	Used to draw table widgets grid.
LastColor	Points to the last color; no specific meaning.

◆ LineType

enum Style_Model::LineType

Lines type.

Enumerator
NoLines	Do not draw lines.
Horizontal	Draw horozontal lines.
Inclined	Draw inclined lines.

◆ WidgetEffect

enum Style_Model::WidgetEffect

Widget effect.

Enumerator
NoEffect	Do not use widget effects.
HighlightEffect	Highlight widget when it is hovered.
AutoRaiseEffect	Raise widget when it is hovered.

◆ WidgetRounding

enum Style_Model::WidgetRounding

Enumerator
ButtonRadius	Buttons rounding.
EditRadius	Text entry widgets rounding.
FrameRadius	Frames rounding.
SliderRadius	Sliders rounding.

Constructor & Destructor Documentation

◆ Style_Model()

Style_Model::Style_Model ( )

Constructor.

Create new SALOME style model with default properties.

References initDefaults().

◆ ~Style_Model()

Style_Model::~Style_Model ( )

virtual

Destructor.

Member Function Documentation

◆ antialiasing()

bool Style_Model::antialiasing ( ) const

Get anti-aliasing flag value.

Returns: true if widgets borders should be antialiased

See also: setAntialiasing(), widgetRounding()

References myAntiAliasing.

◆ applicationFont()

QFont Style_Model::applicationFont ( ) const

Get application font.

Returns: current application font

See also: setApplicationFont()

References myFont.

◆ color()

QColor Style_Model::color	(	ColorRole	role,
		QPalette::ColorGroup	cg = `QPalette::Active`
	)		const

Get palette color value.

Parameters

role	color role
cg	color group

Returns: a color which should be used to draw the corresponding part of the application

See also: setColor()

References myColors.

◆ fromApplication()

void Style_Model::fromApplication ( bool reset = false )

Initialize model from the current application style.

This function is useful when it is necessary to set/remove SALOME style dynamically. Function fromApplication() saves current application properties (style, palette, font) which can be later restored with the restore() function.

The simplest way it can be done is using static functions of Style_Salome class: Style_Salome::apply(), Style_Salome::restore()

Parameters

reset if true model is also initializes preoperties from the application

See also: restore(), fromResources(); Style_Salome class

References BorderBottom, BorderTop, Checked, FieldDark, FieldLight, GridLine, Header, HighlightBorder, HighlightWidget, initDefaults(), Style_Salome::isActive(), Lines, myAppData, myColors, myFont, Style_Model::AppData::myFont, Style_Model::AppData::myPalette, Style_Model::AppData::myStyle, NColorRoles, Pointer, ProgressBar, setColor(), Slider, TabBorderBottom, TabBorderTop, and WindowText.

◆ fromResources()

void Style_Model::fromResources	(	QtxResourceMgr *	resMgr,
		const QString &	resSection = `QString()`
	)

Initialize model from the resources.

This function can be used to retrieve SALOME style properties from the resource file(s). Note, that paremeters resMgr and resSection are stored by the model to be used later with save() method.

Parameters

resMgr	resources manager
resSection	resources section name; if empty (default), "Theme" section is used instead

See also: fromApplication(), save(), update()

References AlternateBase, AutoRaiseEffect, Base, QtxResourceMgr::booleanValue(), BorderBottom, BorderTop, BrightText, Button, ButtonRadius, ButtonText, Checked, Dark, EditRadius, FieldDark, FieldLight, FrameRadius, fromApplication(), GridLine, Header, Highlight, HighlightBorder, HighlightedText, HighlightEffect, HighlightWidget, Horizontal, Inclined, QtxResourceMgr::integerValue(), Light, Lines, Link, LinkVisited, Mid, Midlight, myResourceMgr, myResourceSection, NoEffect, NoLines, Pointer, ProgressBar, readColorValue(), resourceMgr(), resourceSection(), setAntialiasing(), setApplicationFont(), setAutoPalette(), setHandleDelta(), setLinesTransparency(), setLinesType(), setSliderSize(), setSplitHandleLength(), setWidgetEffect(), setWidgetRounding(), Shadow, Slider, SliderRadius, TabBorderBottom, TabBorderTop, Text, ToolTipBase, ToolTipText, Vertical, Window, and WindowText.

◆ handleDelta()

int Style_Model::handleDelta ( Qt::Orientation o ) const

Get handle spacing value.

Parameters

o	handle spacing direction

Returns: current handle spacing value

See also: setHandleDelta()

References myHandleDelta.

◆ initDefaults()

void Style_Model::initDefaults ( )

private

Initialize model with the default values.

References AlternateBase, Base, BorderBottom, BorderTop, BrightText, Button, ButtonRadius, ButtonText, Checked, Dark, EditRadius, FieldDark, FieldLight, FrameRadius, GridLine, Header, Highlight, HighlightBorder, HighlightedText, HighlightWidget, Horizontal, Light, Lines, Link, LinkVisited, Mid, Midlight, mixColors(), myAntiAliasing, myAutoPalette, myFont, myHandleDelta, myLinesTransparency, myLinesType, mySliderSize, mySplitHandleLength, myWidgetEffect, myWidgetRounding, NoEffect, NoLines, Pointer, ProgressBar, setColor(), Shadow, Slider, SliderRadius, TabBorderBottom, TabBorderTop, Text, ToolTipBase, ToolTipText, Vertical, Window, and WindowText.

◆ isAutoPalette()

bool Style_Model::isAutoPalette ( ) const

Returns 'auto-calculating color values' flag.

Returns: 'auto-calculating color values' flag

See also: setAutoPalette()

References myAutoPalette.

◆ linesTransparency()

int Style_Model::linesTransparency ( ) const

Get lines transparency value.

Returns: current lines transparency

See also: setLinesTransparency(), linesType()

References myLinesTransparency.

◆ linesType()

Style_Model::LineType Style_Model::linesType ( ) const

Get lines type.

Returns: current lines type

See also: setLinesType(), linesTransparency()

References myLinesType.

◆ readColorValue()

void Style_Model::readColorValue	(	ColorRole	role,
		const QString &	prefix
	)

private

Read palette color values from resources manager.

Parameters

role	color role
prefix	palette color value resource name prefix

See also: writeColorValue()

References resourceMgr(), resourceSection(), and setColor().

◆ resourceMgr()

QtxResourceMgr * Style_Model::resourceMgr ( ) const

Get resource manager used by this SALOME style model.

Returns: pointer to the resource manager passed previously to the fromResources() method

See also: initFromResources(), resourceSection()

References myResourceMgr.

◆ resourceSection()

QString Style_Model::resourceSection ( ) const

Get resources section name.

If section name is empty, default "Theme" is returned

Returns: resource section name passed previously to the fromResources() method

See also: initFromResources(), resourceMgr()

References myResourceSection.

◆ restore()

void Style_Model::restore ( )

Restore original style, palette and font to the application.

This function should be used in conjunction with fromApplication() method. Sets initial style, color palette and font to the application. If SALOME style model has not been initialized from the application, this function does nothing.

See also: fromApplication()

References myAppData, Style_Model::AppData::myFont, Style_Model::AppData::myPalette, and Style_Model::AppData::myStyle.

◆ save()

void Style_Model::save	(	QtxResourceMgr *	resMgr = `0`,
		const QString &	resSection = `QString()`
	)

Save SALOME stype properties to the resource file.

If paremeters resMgr and resSection are not specified, default ones (those passed to the fromResources() function) are used instead.

Parameters

resMgr	resources manager
resSection	resources section name

See also: fromResources(), update()

References AlternateBase, antialiasing(), applicationFont(), Base, BorderBottom, BorderTop, BrightText, Button, ButtonRadius, ButtonText, Checked, Dark, EditRadius, FieldDark, FieldLight, FrameRadius, GridLine, handleDelta(), Header, Highlight, HighlightBorder, HighlightedText, HighlightWidget, Horizontal, isAutoPalette(), Light, Lines, linesTransparency(), linesType(), Link, LinkVisited, Mid, Midlight, Pointer, ProgressBar, resourceMgr(), resourceSection(), QtxResourceMgr::setValue(), Shadow, Slider, SliderRadius, sliderSize(), splitHandleLength(), TabBorderBottom, TabBorderTop, Text, ToolTipBase, ToolTipText, Vertical, widgetEffect(), widgetRounding(), Window, WindowText, and writeColorValue().

◆ setAntialiasing()

void Style_Model::setAntialiasing ( bool value )

Set anti-aliasing flag value.

Parameters

value if true, widgets borders should be antialiased

See also: antialiasing(), widgetRounding()

References myAntiAliasing.

◆ setApplicationFont()

void Style_Model::setApplicationFont ( const QFont & font )

Set application font.

Parameters

font	new application font

See also: applicationFont()

References myFont.

◆ setAutoPalette()

void Style_Model::setAutoPalette ( bool on )

Set/clear 'auto-calculating color values' flag.

Parameters

on	new value of 'auto-calculating color values' flag

See also: isAutoPalette()

References myAutoPalette.

◆ setColor() [1/2]

void Style_Model::setColor	(	Style_Model::ColorRole	role,
		const QColor &	active,
		const QColor &	inactive = `QColor()`,
		const QColor &	disabled = `QColor()`
	)

Set palette color value.

If inactive and/or disabled colors are not specified, they are automatically calculated from active color.

Parameters

role	color role
active	a color to be used with active color group (QPalette::Active)
inactive	a color to be used with inactive color group (QPalette::Inactive)
disabled	a color to be used with disabled color group (QPalette::Disabled)

See also: color()

References AlternateBase, Base, Button, ButtonText, color(), Light, Midlight, mixColors(), Text, and WindowText.

◆ setColor() [2/2]

void Style_Model::setColor	(	Style_Model::ColorRole	role,
		QPalette::ColorGroup	cg,
		const QColor &	c
	)

Set palette color value.

If inactive and/or disabled colors are not specified, they are automatically calculated from active color.

Parameters

role	color role
cg	color group
c	color which should be used to draw the corresponding part of the application

See also: color()

References myColors.

◆ setHandleDelta()

void Style_Model::setHandleDelta	(	Qt::Orientation	o,
		int	value
	)

Set handle spacing value.

Parameters

o	handle spacing direction
value	new handle spacing value

See also: handleDelta()

References myHandleDelta.

◆ setLinesTransparency()

void Style_Model::setLinesTransparency ( int transparency )

Set lines transparency value.

Parameters

transparency new lines transparency

See also: linesTransparency(), linesType()

References myLinesTransparency.

◆ setLinesType()

void Style_Model::setLinesType ( LineType lt )

Set lines type.

Parameters

lt	new lines type

See also: linesType(), linesTransparency()

References myLinesType.

◆ setSliderSize()

void Style_Model::setSliderSize ( int value )

Set slider handle extra size.

Parameters

value new slider handle extra size

See also: sliderSize()

References mySliderSize.

◆ setSplitHandleLength()

void Style_Model::setSplitHandleLength ( int value )

Set splitted handle length.

Parameters

value new splitter handle length

See also: splitHandleLength()

References mySplitHandleLength.

◆ setWidgetEffect()

void Style_Model::setWidgetEffect ( WidgetEffect we )

Set widget effect.

Parameters

we	new widget effect

See also: widgetEffect()

References myWidgetEffect.

◆ setWidgetRounding()

void Style_Model::setWidgetRounding	(	WidgetRounding	wr,
		double	value
	)

Set widget corners rounding radius value.

Parameters

wr	widget type
value	new widget corners rounding

See also: widgetRounding(), antialiasing()

References myWidgetRounding.

◆ sliderSize()

int Style_Model::sliderSize ( ) const

Get slider handle extra size.

Returns: current slider handle extra size

See also: setSliderSize()

References mySliderSize.

◆ splitHandleLength()

int Style_Model::splitHandleLength ( ) const

Get splitter handle length.

Returns: current splitter handle length

See also: setSplitHandleLength()

References mySplitHandleLength.

◆ update()

void Style_Model::update ( )

Reload SALOME style properties from the resources file(s).

See also: fromResources(), save()

References fromResources(), resourceMgr(), and resourceSection().

◆ widgetEffect()

Style_Model::WidgetEffect Style_Model::widgetEffect ( ) const

Get widget effect.

Returns: current widget effect

See also: setWidgetEffect()

References myWidgetEffect.

◆ widgetRounding()

double Style_Model::widgetRounding ( Style_Model::WidgetRounding wr ) const

Get widget corners rounding radius value.

Parameters

wr	widget type

Returns: current widget corners rounding

See also: setWidgetRounding(), antialiasing()

References myWidgetRounding.

◆ writeColorValue()

void Style_Model::writeColorValue	(	ColorRole	role,
		const QString &	prefix,
		QtxResourceMgr *	resMgr,
		const QString &	resSection
	)		const

private

Write palette color values to resources manager.

Parameters

role	color role
prefix	palette color value resource name prefix
resMgr	resource manager
resSection	resource section name

See also: readColorValue()

References color(), and QtxResourceMgr::setValue().

Member Data Documentation

◆ myAntiAliasing

bool Style_Model::myAntiAliasing

private

◆ myAppData

Style_Model::AppData * Style_Model::myAppData = 0

staticprivate

Application style data.

◆ myAutoPalette

bool Style_Model::myAutoPalette

private

◆ myColors

ColorGroupMap Style_Model::myColors

private

◆ myFont

QFont Style_Model::myFont

private

◆ myHandleDelta

DeltaMap Style_Model::myHandleDelta

private

◆ myLinesTransparency

int Style_Model::myLinesTransparency

private

◆ myLinesType

LineType Style_Model::myLinesType

private

◆ myResourceMgr

QtxResourceMgr* Style_Model::myResourceMgr

private

◆ myResourceSection

QString Style_Model::myResourceSection

private

◆ mySliderSize

int Style_Model::mySliderSize

private

◆ mySplitHandleLength

int Style_Model::mySplitHandleLength

private

◆ myWidgetEffect

WidgetEffect Style_Model::myWidgetEffect

private

◆ myWidgetRounding

RoundMap Style_Model::myWidgetRounding

private

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

src/Style/Style_Model.h
src/Style/Style_Model.cxx

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ColorGroupMap

◆ ColorMap

◆ DeltaMap

◆ RoundMap

Member Enumeration Documentation

◆ ColorRole

◆ LineType

◆ WidgetEffect

◆ WidgetRounding

Constructor & Destructor Documentation

◆ Style_Model()

◆ ~Style_Model()

Member Function Documentation

◆ antialiasing()

◆ applicationFont()

◆ color()

◆ fromApplication()

◆ fromResources()

◆ handleDelta()

◆ initDefaults()

◆ isAutoPalette()

◆ linesTransparency()

◆ linesType()

◆ readColorValue()

◆ resourceMgr()

◆ resourceSection()

◆ restore()

◆ save()

◆ setAntialiasing()

◆ setApplicationFont()

◆ setAutoPalette()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setHandleDelta()

◆ setLinesTransparency()

◆ setLinesType()

◆ setSliderSize()

◆ setSplitHandleLength()

◆ setWidgetEffect()

◆ setWidgetRounding()

◆ sliderSize()

◆ splitHandleLength()

◆ update()

◆ widgetEffect()

◆ widgetRounding()

◆ writeColorValue()

Member Data Documentation

◆ myAntiAliasing

◆ myAppData

◆ myAutoPalette

◆ myColors

◆ myFont

◆ myHandleDelta

◆ myLinesTransparency

◆ myLinesType

◆ myResourceMgr

◆ myResourceSection

◆ mySliderSize

◆ mySplitHandleLength

◆ myWidgetEffect

◆ myWidgetRounding