ofx::MUI::Styles Class Reference

A common class for setting shared Widget styles. More...

#include <Styles.h>

Public Types
enum	Role {   ROLE_FOREGROUND = 0, ROLE_BACKGROUND, ROLE_ACCENT, ROLE_BORDER,   ROLE_TEXT }
	Each Style has a role. More...
enum	State { STATE_NORMAL = 0, STATE_OVER, STATE_DOWN, STATE_DISABLED }
	Each style can also be applied to an interaction state. More...

Public Member Functions
	Styles ()
	Create a default styles.
virtual	~Styles ()
	Destroy these styles.
void	setColors (const ofColor &foreground, const ofColor &background, const ofColor &accent, const ofColor &border, const ofColor &text)
	Set colors for each role in the Style. More...
const ofColor &	getColor (Role role, State state) const
	Get the ofColor for a given Role and State. More...
void	setColor (const ofColor &color, Role role, State state)
	Set the ofColor for a given Role and State. More...
const ofTrueTypeFont &	getFont (FontSize size=FontSize::MEDIUM) const
	Get the font for a given FontSize. More...
void	setFont (FontSize size, std::shared_ptr< ofTrueTypeFont > font)
	Set the font for a given FontSize. More...

Protected Attributes
std::vector< std::vector< ofColor > >	_colors
	A collection of colros for this Style.
std::vector< std::shared_ptr< ofTrueTypeFont > >	_fonts
	A font cache for this Style.

Detailed Description

A common class for setting shared Widget styles.

Member Enumeration Documentation

enum ofx::MUI::Styles::Role

Each Style has a role.

Enumerator
ROLE_FOREGROUND	Styles applied to the foreground.
ROLE_BACKGROUND	Styles applied to the background.
ROLE_ACCENT	Styles applied to the accent areas.
ROLE_BORDER	Styles applied to the borders.
ROLE_TEXT	Styles applied to the text.

enum ofx::MUI::Styles::State

Each style can also be applied to an interaction state.

Enumerator
STATE_NORMAL	The normal target is idle.
STATE_OVER	The state when a pointer is over the target.
STATE_DOWN	The state when a target is down.
STATE_DISABLED	The state when a target is disabled.

Member Function Documentation

const ofColor & ofx::MUI::Styles::getColor	(	Role	role,
		State	state
	)		const

Get the ofColor for a given Role and State.

Parameters

role	The Role desired.
state	The State desired.

Returns

an ofColor for the given role and state.

const ofTrueTypeFont & ofx::MUI::Styles::getFont

(

FontSize

size = FontSize::MEDIUM

)

const

Get the font for a given FontSize.

Parameters

size	The font size to get.

Returns

a reference to the requested font.

void ofx::MUI::Styles::setColor	(	const ofColor &	color,
		Role	role,
		State	state
	)

Set the ofColor for a given Role and State.

Parameters

color	The color to set.
role	The Role desired.
state	The State desired.

void ofx::MUI::Styles::setColors	(	const ofColor &	foreground,
		const ofColor &	background,
		const ofColor &	accent,
		const ofColor &	border,
		const ofColor &	text
	)

Set colors for each role in the Style.

Parameters

foreground	The foreground color.
background	The background color.
accent	The accent color.
border	The border color.
text	The text color.

void ofx::MUI::Styles::setFont	(	FontSize	size,
		std::shared_ptr< ofTrueTypeFont >	font
	)

Set the font for a given FontSize.

Parameters

size	The FontSize for the font.
font	The cached font to use.

---

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

• Styles.h
• Styles.cpp