Style_Salome Class Reference

SALOME style class. More...

#include <Style_Salome.h>

Inheritance diagram for Style_Salome:

Public Member Functions
virtual	~Style_Salome ()
	Destructor.
virtual void	polish (QApplication *)
	Initialize the appearance of the application.
virtual void	polish (QWidget *)
	Initializes the appearance of the given widget.
virtual void	unpolish (QWidget *)
	Uninitialize the given widget's appearance.
virtual void	drawComplexControl (ComplexControl, const QStyleOptionComplex *, QPainter *, const QWidget *=0) const
	Draws the given control using the provided painter with the style options specified by opt.
virtual void	drawControl (ControlElement, const QStyleOption *, QPainter *, const QWidget *) const
	Draws the given element with the provided painter with the style options specified by opt.
virtual void	drawPrimitive (PrimitiveElement, const QStyleOption *, QPainter *, const QWidget *=0) const
	Draws the given primitive element with the provided painter using the style options specified by opt.
virtual int	pixelMetric (PixelMetric, const QStyleOption *=0, const QWidget *=0) const
	Returns the value of the given pixel metric.
virtual QSize	sizeFromContents (ContentsType, const QStyleOption *, const QSize &, const QWidget *=0) const
	Returns the size of the element described by the specified option opt and type ct, based on the provided contentsSize.
virtual QPixmap	standardPixmap (StandardPixmap, const QStyleOption *, const QWidget *=0) const
	Returns a pixmap for the given standardPixmap.
virtual int	styleHint (StyleHint, const QStyleOption *=0, const QWidget *=0, QStyleHintReturn *=0) const
	Returns an integer representing the specified style hint for the given widget w described by the provided style option opt.
virtual QRect	subControlRect (ComplexControl, const QStyleOptionComplex *, SubControl, const QWidget *=0) const
	Get the rectangle containing the specified subcontrol sc of the given complex control cc (with the style specified by option opt). The rectangle is defined in screen coordinates.
virtual QRect	subElementRect (SubElement, const QStyleOption *, const QWidget *=0) const
	Returns the sub-area for the given element se as described in the provided style option opt. The returned rectangle is defined in screen coordinates.
Static Public Member Functions
static void	initialize (QtxResourceMgr *=0, const QString &=QString())
	Initialize SALOME style.
static void	apply ()
	Set SALOME style to the application.
static void	restore ()
	Restore original style to the application.
static bool	isActive ()
	Check if the SALOME style is currently set to application.
static Style_Model *	model ()
	Get style model.
static void	update ()
	Update style from resources.
Protected Slots
QIcon	standardIconImplementation (StandardPixmap, const QStyleOption *=0, const QWidget *=0) const
	Returns an icon for the given standardIcon.
Private Member Functions
	Style_Salome ()
	Constructor.
void	updatePaletteColors ()
	Update palette colors from style model.
void	updateAllWidgets (QApplication *)
	Update all widgets with the current style properties.
bool	hasHover () const
	Check if any widget effect is currently used.
void	drawHoverRect (QPainter *, const QRect &, const QColor &, const double, const int, const bool) const
	Draw rectangle for the hovered widget.
void	drawHandle (QPainter *, const QRect &, bool, bool=true) const
	Draw widget handle.
void	drawBackground (QPainter *, const QRect &, const QColor &, const bool, const bool=false, const bool=true) const
	Draw background.
void	drawBorder (QPainter *, const QRect &, bool) const
	Draw border.
QString	titleText (const QString &, const int, const int, QFont &) const
	Get corrected title text.
Static Private Attributes
static Style_Model *	myModel = 0

---

Detailed Description

To set SALOME style to the application, use static function Style_Salome.apply(). Static function restore() can be used then to restore initial application style.

The usual way to use SALOME style is as following:

  Style_Salome::initialize( resourceMgr() );     // initialize SALOME style from resources
  if ( needSalomeStyle ) Style_Salome::apply();  // set SALOME style to the application

Style_PrefDlg class can be then used to change style properties, select one of the predefined style themes or even create user themes:

  Style_PrefDlg dlg( desktop() );
  dlg.exec();

---

Constructor & Destructor Documentation

Style_Salome::Style_Salome

(

)

[private]

Use Style_Salome.apply() static function to set SALOME style to the application.

Style_Salome::~Style_Salome

(

)

[virtual]

---

Member Function Documentation

void Style_Salome::initialize	(	QtxResourceMgr *	resMgr = 0,
		const QString &	section = QString()
	)		[static]

This method should be called at the very beginning of the application which uses SALOME style. The method initializes style properties from the current settings.

If the parameter resMgr is not 0, the style is initialized from the resources manager.

The parameter section allows customizing of the resources file section used to store style's properties. By default "Theme" section name is used.

Parameters:

resMgr	resources manager
section	resources file section name

See also:

apply(), restore()

References Style_Model.fromResources(), and model().

void Style_Salome::apply

(

)

[static]

See also:

initialize(), restore()

References isActive(), model(), Style_Salome(), update(), and Style_Model.update().

void Style_Salome::restore

(

)

[static]

See also:

initialize(), apply()

References isActive(), model(), and Style_Model.restore().

bool Style_Salome::isActive

(

)

[static]

Returns:

true if SALOME style is set to the applcation or false otherwise

Style_Model * Style_Salome::model

(

)

[static]

Returns:

style model

References myModel.

void Style_Salome::update

(

)

[static]

void Style_Salome::polish

(

QApplication *

app

)

[virtual]

Performs late initialization of the given application object.

Parameters:

app	application object

References checkDebugLevel(), model(), updateAllWidgets(), and updatePaletteColors().

void Style_Salome::polish

(

QWidget *

w

)

[virtual]

This function is called for every widget at some point after it has been fully created but just before it is shown for the very first time.

Parameters:

w	widget object

References checkDebugLevel(), hasHover(), and polish().

void Style_Salome::unpolish

(

QWidget *

w

)

[virtual]

This function is the counterpart to polish(). It is called for every polished widget whenever the style is dynamically changed; the former style has to unpolish its settings before the new style can polish them again.

Parameters:

w	widget object

References checkDebugLevel(), and hasHover().

void Style_Salome::drawComplexControl	(	ComplexControl	cc,
		const QStyleOptionComplex *	opt,
		QPainter *	p,
		const QWidget *	w = 0
	)		const [virtual]

Parameters:

cc	complex control type
opt	style option
p	painter
w	widget

References Style_Tools.All, Style_Model.antialiasing(), Style_Tools.arrowRect(), Style_Model.AutoRaiseEffect, Style_Model.BorderBottom, Style_Model.BorderTop, BUT_PERCENT_COL, Style_Model.ButtonRadius, checkDebugLevel(), Style_Model.color(), DELTA_SLIDER, drawControl(), Style_Tools.drawFocus(), drawHandle(), drawHoverRect(), drawPrimitive(), Style_Tools.drawSlider(), Style_Model.EditRadius, Style_Model.FieldDark, Style_Model.FieldLight, Style_Model.FrameRadius, Style_Tools.getMinDelta(), hasHover(), Style_Model.HighlightEffect, Horizontal, Style_Tools.Left, LINE_GR_MARGIN, model(), pixelMetric(), Style_Tools.Right, SHADOW, Style_Tools.shadowRect(), Style_Tools.SlDown, Style_Model.Slider, Style_Model.SliderRadius, Style_Tools.SlLeft, Style_Tools.SlNone, Style_Tools.SlRight, Style_Tools.SlUp, styleHint(), subControlRect(), subElementRect(), Style_Model.TabBorderBottom, Style_Model.TabBorderTop, Style_Model.widgetEffect(), Style_Model.widgetRounding(), and Window.

void Style_Salome::drawControl	(	ControlElement	ce,
		const QStyleOption *	opt,
		QPainter *	p,
		const QWidget *	w
	)		const [virtual]

Parameters:

ce	control element type
opt	style option
p	painter
w	widget

References Style_Tools.All, Style_Model.antialiasing(), Style_Model.AutoRaiseEffect, Style_Model.BorderBottom, Style_Model.BorderTop, Style_Tools.BottomLeft, Style_Tools.BottomRight, BUT_PERCENT_COL, BUT_PERCENT_ON, Style_Model.ButtonRadius, checkDebugLevel(), Style_Model.color(), DELTA_H_TAB, drawBackground(), drawBorder(), Style_Tools.drawFocus(), drawHandle(), drawHoverRect(), drawPrimitive(), Style_Model.EditRadius, Style_Model.FieldLight, Style_Model.FrameRadius, Style_Tools.getMaxRect(), hasHover(), Style_Model.Header, Style_Model.HighlightBorder, Style_Model.HighlightEffect, Style_Model.HighlightWidget, Horizontal, Style_Tools.Left, LINE_GR_MARGIN, model(), Plot2d.None, pixelMetric(), Style_Model.ProgressBar, Style_Tools.Right, Style_Tools.roundRect(), SHADOW, Style_Tools.shadowRect(), Style_Model.Slider, Style_Model.splitHandleLength(), standardPixmap(), styleHint(), subControlRect(), subElementRect(), Style_Model.TabBorderBottom, Style_Model.TabBorderTop, Style_Tools.tabRect(), titleText(), Style_Tools.TopLeft, Style_Tools.TopRight, Vertical, Style_Model.widgetEffect(), Style_Model.widgetRounding(), and Window.

void Style_Salome::drawPrimitive	(	PrimitiveElement	pe,
		const QStyleOption *	opt,
		QPainter *	p,
		const QWidget *	w = 0
	)		const [virtual]

Parameters:

pe	primitive type
opt	style option
p	painter
w	widget (optional)

References test_table.a, Style_Tools.All, Style_Model.antialiasing(), Style_Model.Base, Style_Model.BorderBottom, Style_Model.BorderTop, Style_Tools.BottomLeft, Style_Tools.BottomRight, BUT_PERCENT_COL, BUT_PERCENT_ON, Style_Model.ButtonRadius, test_table.c, checkDebugLevel(), Style_Model.Checked, Style_Model.color(), DELTA_H_TAB, Style_Tools.drawArrow(), drawBackground(), drawBorder(), drawHandle(), drawHoverRect(), Style_Tools.drawSign(), Style_Model.EditRadius, Style_Model.FieldDark, Style_Model.FieldLight, Style_Model.FrameRadius, hasHover(), Style_Model.HighlightEffect, LINE_GR_MARGIN, model(), Plot2d.NoPen, Style_Model.Pointer, PTSARRLEN, SHADOW, Style_Tools.shadowCheck(), Style_Tools.shadowRect(), Style_Model.splitHandleLength(), Style_Model.TabBorderBottom, Style_Model.TabBorderTop, Style_Tools.tabRect(), Style_Tools.TopLeft, Style_Tools.TopRight, Style_Model.widgetEffect(), Style_Model.widgetRounding(), and Window.

int Style_Salome::pixelMetric	(	PixelMetric	metric,
		const QStyleOption *	opt = 0,
		const QWidget *	w = 0
	)		const [virtual]

Parameters:

metric	metric type
opt	style option
w	widget

Returns:

metric value

References checkDebugLevel(), model(), and Style_Model.sliderSize().

QSize Style_Salome::sizeFromContents	(	ContentsType	ct,
		const QStyleOption *	opt,
		const QSize &	contentsSize,
		const QWidget *	w = 0
	)		const [virtual]

Parameters:

ct	contents type
opt	style option
contentsSize	contents size
w	widget (optional)

Returns:

size of the element

References checkDebugLevel(), DELTA_H_TAB, Style_Model.EditRadius, Style_Tools.getMaxRect(), model(), Style_Model.sliderSize(), subControlRect(), and Style_Model.widgetRounding().

QPixmap Style_Salome::standardPixmap	(	StandardPixmap	stPixmap,
		const QStyleOption *	opt,
		const QWidget *	w = 0
	)		const [virtual]

Parameters:

stPixmap	standard pixmap type
opt	style option
w	widget (optional)

Returns:

standard pixmap

References checkDebugLevel(), cross_xpm, maximize_xpm, minimize_xpm, and normal_xpm.

int Style_Salome::styleHint	(	StyleHint	hint,
		const QStyleOption *	opt = 0,
		const QWidget *	w = 0,
		QStyleHintReturn *	returnData = 0
	)		const [virtual]

Parameters:

hint	hint type
opt	style option
w	widget (optional)
returnData	(currently not used)

Returns:

style hint value

References checkDebugLevel(), Style_Model.color(), Style_Model.GridLine, and model().

QRect Style_Salome::subControlRect	(	ComplexControl	cc,
		const QStyleOptionComplex *	opt,
		SubControl	sc,
		const QWidget *	wid = 0
	)		const [virtual]

Parameters:

cc	complex control type
opt	style option
sc	subcontrol type
wid	widget (optional)

Returns:

subcontrol rectangle

References Style_Model.ButtonRadius, checkDebugLevel(), DELTA_SLIDER, Style_Model.EditRadius, Style_Tools.getMaxRect(), Horizontal, model(), SHADOW, and Style_Model.widgetRounding().

QRect Style_Salome::subElementRect	(	SubElement	se,
		const QStyleOption *	opt,
		const QWidget *	wid = 0
	)		const [virtual]

Parameters:

se	subelement type
opt	style option
wid	widget (optional)

Returns:

subelement rectangle

References checkDebugLevel(), Style_Model.EditRadius, Style_Tools.getMaxRect(), hasHover(), model(), SHADOW, subControlRect(), and Style_Model.widgetRounding().

QIcon Style_Salome::standardIconImplementation	(	StandardPixmap	standardIcon,
		const QStyleOption *	opt = 0,
		const QWidget *	w = 0
	)		const [protected, slot]

Parameters:

standardIcon	standard icon type
opt	style option
w	widget (optional)

Returns:

standard icon

References checkDebugLevel().

void Style_Salome::updatePaletteColors

(

)

[private]

References model(), Style_Model.NColorRoles, and Style_Model.WindowText.

void Style_Salome::updateAllWidgets

(

QApplication *

app

)

[private]

Parameters:

app	application object

References polish().

bool Style_Salome::hasHover

(

)

const [private]

Returns:

true if any widget effect is currently used

References model(), Style_Model.NoEffect, and Style_Model.widgetEffect().

void Style_Salome::drawHoverRect	(	QPainter *	p,
		const QRect &	r,
		const QColor &	bgCol,
		const double	rad,
		const int	type,
		const bool	border
	)		const [private]

Parameters:

p	painter
r	rectangle
bgCol	background color
rad	corners rounding radius
type	shadow type
border	if true border is colored with specific color

References Style_Model.AutoRaiseEffect, Style_Model.BorderTop, BUT_PERCENT_ON, Style_Model.color(), hasHover(), HIGH_WDG_MARGIN, Style_Model.HighlightBorder, Style_Model.HighlightEffect, Style_Tools.highlightRect(), Style_Model.HighlightWidget, model(), and Style_Model.widgetEffect().

void Style_Salome::drawHandle	(	QPainter *	p,
		const QRect &	r,
		bool	horiz,
		bool	isRect = true
	)		const [private]

Parameters:

p	painter
r	rectangle
horiz	if true draw horizontal handle, otherwise draw vertical handle
isRect	if true surrounding rectangle is also drawn

References Style_Model.handleDelta(), hole_xpm, Horizontal, model(), and Vertical.

void Style_Salome::drawBackground	(	QPainter *	p,
		const QRect &	r,
		const QColor &	bgCol,
		const bool	fill,
		const bool	grad = false,
		const bool	horiz = true
	)		const [private]

Parameters:

p	painter
r	rectangle
bgCol	background color
fill	'fill rectangle' flag
grad	'draw gradient' flag
horix	'draw horizontal item' flag (usefull for gradient background)

References BUT_PERCENT_ON, test_table.c, Style_Model.color(), Style_Model.Horizontal, Style_Model.Inclined, Style_Model.Lines, and model().

void Style_Salome::drawBorder	(	QPainter *	p,
		const QRect &	r,
		bool	horiz
	)		const [private]

Parameters:

p	painter
r	rectangle
horiz	'draw horizontal item' flag

References Style_Model.color(), model(), Style_Model.TabBorderBottom, and Style_Model.TabBorderTop.

QString Style_Salome::titleText	(	const QString &	txt,
		const int	W,
		const int	H,
		QFont &	f
	)		const [private]

Parameters:

txt	original text
W	possible width
H	possible height
f	used font

Returns:

corrected title text

---

Field Documentation

Style_Model * Style_Salome::myModel = 0 [static, private]