A struct encapsulating a set of properties used to configure IVControls. More...

#include <IGraphicsStructs.h>

Public Member Functions
	IVStyle (bool showLabel=DEFAULT_SHOW_LABEL, bool showValue=DEFAULT_SHOW_VALUE, const IVColorSpec &colors={DEFAULT_BGCOLOR, DEFAULT_FGCOLOR, DEFAULT_PRCOLOR, DEFAULT_FRCOLOR, DEFAULT_HLCOLOR, DEFAULT_SHCOLOR, DEFAULT_X1COLOR, DEFAULT_X2COLOR, DEFAULT_X3COLOR}, const IText &labelText=DEFAULT_LABEL_TEXT, const IText &valueText=DEFAULT_VALUE_TEXT, bool hideCursor=DEFAULT_HIDE_CURSOR, bool drawFrame=DEFAULT_DRAW_FRAME, bool drawShadows=DEFAULT_DRAW_SHADOWS, bool emboss=DEFAULT_EMBOSS, float roundness=DEFAULT_ROUNDNESS, float frameThickness=DEFAULT_FRAME_THICKNESS, float shadowOffset=DEFAULT_SHADOW_OFFSET, float widgetFrac=DEFAULT_WIDGET_FRAC, float angle=DEFAULT_WIDGET_ANGLE, EOrientation labelOrientation=DEFAULT_LABEL_ORIENTATION)
	Create a new IVStyle to configure common styling for IVControls. More...

	IVStyle (const std::initializer_list< IColor > &colors)
	Create a new IVStyle based on a list of colors, and defaults for the other elements. More...

IVStyle	WithShowLabel (bool show=true) const

IVStyle	WithShowValue (bool show=true) const

IVStyle	WithLabelText (const IText &text) const

IVStyle	WithValueText (const IText &text) const

IVStyle	WithHideCursor (bool hide=true) const

IVStyle	WithColor (EVColor idx, IColor color) const

IVStyle	WithColors (const IVColorSpec &spec) const

IVStyle	WithRoundness (float v) const

IVStyle	WithFrameThickness (float v) const

IVStyle	WithShadowOffset (float v) const

IVStyle	WithDrawShadows (bool v=true) const

IVStyle	WithDrawFrame (bool v=true) const

IVStyle	WithWidgetFrac (float v) const

IVStyle	WithAngle (float v) const

IVStyle	WithEmboss (bool v=true) const

IVStyle	WithLabelOrientation (EOrientation v) const

Public Attributes
bool	hideCursor = DEFAULT_HIDE_CURSOR

bool	showLabel = DEFAULT_SHOW_LABEL

bool	showValue = DEFAULT_SHOW_VALUE

bool	drawFrame = DEFAULT_DRAW_FRAME

bool	drawShadows = DEFAULT_DRAW_SHADOWS

bool	emboss = DEFAULT_EMBOSS

float	roundness = DEFAULT_ROUNDNESS

float	frameThickness = DEFAULT_FRAME_THICKNESS

float	shadowOffset = DEFAULT_SHADOW_OFFSET

float	widgetFrac = DEFAULT_WIDGET_FRAC

float	angle = DEFAULT_WIDGET_ANGLE

IVColorSpec	colorSpec = DEFAULT_COLOR_SPEC

IText	labelText = DEFAULT_LABEL_TEXT

IText	valueText = DEFAULT_VALUE_TEXT

EOrientation	labelOrientation = DEFAULT_LABEL_ORIENTATION

Detailed Description

A struct encapsulating a set of properties used to configure IVControls.

Definition at line 2473 of file IGraphicsStructs.h.

Constructor & Destructor Documentation

◆ IVStyle() [1/2]

IVStyle::IVStyle	(	bool	showLabel = `DEFAULT_SHOW_LABEL`,
		bool	showValue = `DEFAULT_SHOW_VALUE`,
		const IVColorSpec &	colors = `{DEFAULT_BGCOLOR, DEFAULT_FGCOLOR, DEFAULT_PRCOLOR, DEFAULT_FRCOLOR, DEFAULT_HLCOLOR, DEFAULT_SHCOLOR, DEFAULT_X1COLOR, DEFAULT_X2COLOR, DEFAULT_X3COLOR}`,
		const IText &	labelText = `DEFAULT_LABEL_TEXT`,
		const IText &	valueText = `DEFAULT_VALUE_TEXT`,
		bool	hideCursor = `DEFAULT_HIDE_CURSOR`,
		bool	drawFrame = `DEFAULT_DRAW_FRAME`,
		bool	drawShadows = `DEFAULT_DRAW_SHADOWS`,
		bool	emboss = `DEFAULT_EMBOSS`,
		float	roundness = `DEFAULT_ROUNDNESS`,
		float	frameThickness = `DEFAULT_FRAME_THICKNESS`,
		float	shadowOffset = `DEFAULT_SHADOW_OFFSET`,
		float	widgetFrac = `DEFAULT_WIDGET_FRAC`,
		float	angle = `DEFAULT_WIDGET_ANGLE`,
		EOrientation	labelOrientation = `DEFAULT_LABEL_ORIENTATION`
	)

inline

Create a new IVStyle to configure common styling for IVControls.

Parameters

showLabel	Show the label
showValue	Show the value
colors	An IVColorSpec for the style
labelText	The IText for the label text style
valueText	The IText for the value text style
hideCursor	Should the cursor be hidden e.g. when dragging the control
drawFrame	Should the frame be drawn around the bounds of the control or around the handle, where relevant
drawShadows	Should there be a shadow beneath the control handle
emboss	Should the handle of the control be embossed
roundness	The roundness factor for the control's elements
frameThickness	The thickness of the controls frame elements
shadowOffset	The distance of the shadow from the foreground
widgetFrac	The fraction of the widget area (control area - label/value if shown) that the widget occupies
angle	The rotation angle in degrees of e.g. the handle/pointer on an IVSlider

Definition at line 2506 of file IGraphicsStructs.h.

◆ IVStyle() [2/2]

IVStyle::IVStyle ( const std::initializer_list< IColor > & colors )

inline

Create a new IVStyle based on a list of colors, and defaults for the other elements.

Parameters

colors

Definition at line 2540 of file IGraphicsStructs.h.

Member Function Documentation

◆ WithAngle()

IVStyle IVStyle::WithAngle ( float v ) const

inline

Definition at line 2558 of file IGraphicsStructs.h.

◆ WithColor()

IVStyle IVStyle::WithColor	(	EVColor	idx,
		IColor	color
	)		const

inline

Definition at line 2550 of file IGraphicsStructs.h.

◆ WithColors()

IVStyle IVStyle::WithColors ( const IVColorSpec & spec ) const

inline

Definition at line 2551 of file IGraphicsStructs.h.

◆ WithDrawFrame()

IVStyle IVStyle::WithDrawFrame ( bool v = true ) const

inline

Definition at line 2556 of file IGraphicsStructs.h.

◆ WithDrawShadows()

IVStyle IVStyle::WithDrawShadows ( bool v = true ) const

inline

Definition at line 2555 of file IGraphicsStructs.h.

◆ WithEmboss()

IVStyle IVStyle::WithEmboss ( bool v = true ) const

inline

Definition at line 2559 of file IGraphicsStructs.h.

◆ WithFrameThickness()

IVStyle IVStyle::WithFrameThickness ( float v ) const

inline

Definition at line 2553 of file IGraphicsStructs.h.

◆ WithHideCursor()

IVStyle IVStyle::WithHideCursor ( bool hide = true ) const

inline

Definition at line 2549 of file IGraphicsStructs.h.

◆ WithLabelOrientation()

IVStyle IVStyle::WithLabelOrientation ( EOrientation v ) const

inline

Definition at line 2560 of file IGraphicsStructs.h.

◆ WithLabelText()

IVStyle IVStyle::WithLabelText ( const IText & text ) const

inline

Definition at line 2547 of file IGraphicsStructs.h.

◆ WithRoundness()

IVStyle IVStyle::WithRoundness ( float v ) const

inline

Definition at line 2552 of file IGraphicsStructs.h.

◆ WithShadowOffset()

IVStyle IVStyle::WithShadowOffset ( float v ) const

inline

Definition at line 2554 of file IGraphicsStructs.h.

◆ WithShowLabel()

IVStyle IVStyle::WithShowLabel ( bool show = true ) const

inline

Definition at line 2545 of file IGraphicsStructs.h.

◆ WithShowValue()

IVStyle IVStyle::WithShowValue ( bool show = true ) const

inline

Definition at line 2546 of file IGraphicsStructs.h.

◆ WithValueText()

IVStyle IVStyle::WithValueText ( const IText & text ) const

inline

Definition at line 2548 of file IGraphicsStructs.h.

◆ WithWidgetFrac()

IVStyle IVStyle::WithWidgetFrac ( float v ) const

inline

Definition at line 2557 of file IGraphicsStructs.h.

Member Data Documentation

◆ angle

float IVStyle::angle = DEFAULT_WIDGET_ANGLE

Definition at line 2485 of file IGraphicsStructs.h.

◆ colorSpec

IVColorSpec IVStyle::colorSpec = DEFAULT_COLOR_SPEC

Definition at line 2486 of file IGraphicsStructs.h.

◆ drawFrame

bool IVStyle::drawFrame = DEFAULT_DRAW_FRAME

Definition at line 2478 of file IGraphicsStructs.h.

◆ drawShadows

bool IVStyle::drawShadows = DEFAULT_DRAW_SHADOWS

Definition at line 2479 of file IGraphicsStructs.h.

◆ emboss

bool IVStyle::emboss = DEFAULT_EMBOSS

Definition at line 2480 of file IGraphicsStructs.h.

◆ frameThickness

float IVStyle::frameThickness = DEFAULT_FRAME_THICKNESS

Definition at line 2482 of file IGraphicsStructs.h.

◆ hideCursor

bool IVStyle::hideCursor = DEFAULT_HIDE_CURSOR

Definition at line 2475 of file IGraphicsStructs.h.

◆ labelOrientation

EOrientation IVStyle::labelOrientation = DEFAULT_LABEL_ORIENTATION

Definition at line 2489 of file IGraphicsStructs.h.

◆ labelText

IText IVStyle::labelText = DEFAULT_LABEL_TEXT

Definition at line 2487 of file IGraphicsStructs.h.

◆ roundness

float IVStyle::roundness = DEFAULT_ROUNDNESS

Definition at line 2481 of file IGraphicsStructs.h.

◆ shadowOffset

float IVStyle::shadowOffset = DEFAULT_SHADOW_OFFSET

Definition at line 2483 of file IGraphicsStructs.h.

◆ showLabel

bool IVStyle::showLabel = DEFAULT_SHOW_LABEL

Definition at line 2476 of file IGraphicsStructs.h.

◆ showValue

bool IVStyle::showValue = DEFAULT_SHOW_VALUE

Definition at line 2477 of file IGraphicsStructs.h.

◆ valueText

IText IVStyle::valueText = DEFAULT_VALUE_TEXT

Definition at line 2488 of file IGraphicsStructs.h.

◆ widgetFrac

float IVStyle::widgetFrac = DEFAULT_WIDGET_FRAC

Definition at line 2484 of file IGraphicsStructs.h.

The documentation for this struct was generated from the following file:

IGraphicsStructs.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IVStyle() [1/2]

◆ IVStyle() [2/2]

Member Function Documentation

◆ WithAngle()

◆ WithColor()

◆ WithColors()

◆ WithDrawFrame()

◆ WithDrawShadows()

◆ WithEmboss()

◆ WithFrameThickness()

◆ WithHideCursor()

◆ WithLabelOrientation()

◆ WithLabelText()

◆ WithRoundness()

◆ WithShadowOffset()

◆ WithShowLabel()

◆ WithShowValue()

◆ WithValueText()

◆ WithWidgetFrac()

Member Data Documentation

◆ angle

◆ colorSpec

◆ drawFrame

◆ drawShadows

◆ emboss

◆ frameThickness

◆ hideCursor

◆ labelOrientation

◆ labelText

◆ roundness

◆ shadowOffset

◆ showLabel

◆ showValue

◆ valueText

◆ widgetFrac