Toggle widget. To instantiate and add to a container use the add static method. More...

#include <toggle.h>

Inheritance diagram for liblec::lecui::widgets::toggle:

Classes
struct	toggle_events
	Events specific to this widget. More...

Public Member Functions
	toggle ()
	Constructor.

toggle_events &	events ()
	Get or set toggle widget events. More...

bool	operator== (const toggle &param)
	Check whether widget specs are equal. Only those properties that require the widget resources to be re-created are considered. More...

bool	operator!= (const toggle &param)
	Check whether widget specs are NOT equal. Only those properties that require the widget resources to be re-created are considered. More...

std::string &	text () override
	Get or set the widget text. More...

toggle &	text (const std::string &text)
	Set the widget's text. More...

std::string &	tooltip () override
	Get or set the widget's tooltip text. More...

toggle &	tooltip (const std::string &tooltip)
	Set the tooltip text. More...

lecui::rect &	rect () override
	Get or set the position and dimensions of the widget. More...

toggle &	rect (const lecui::rect &rect)
	Set the position and dimensions of the widget. More...

resize_params &	on_resize () override
	Get or set the behaviour of the widget when its container is resized. More...

toggle &	on_resize (const resize_params &on_resize)
	Set the behaviour of the widget when its container is resized. More...

cursor_type &	cursor () override
	Get or set the mouse cursor to use then over the widget. More...

toggle &	cursor (const cursor_type cursor)
	Set the mouse cursor to use when over the widget. More...

std::string &	font () override
	Get or set the default widget font, e.g. "Georgia". More...

toggle &	font (const std::string &font)
	Set the default widget font. More...

float &	font_size () override
	Get or set the default widget font size in points, e.g. 9.0f. More...

toggle &	font_size (const float &font_size)
	Set the widget's font size. More...

color &	color_text () override
	Get or set the color of the widget's text. More...

toggle &	color_text (const color &color_text)
	Set the color of the widget's text. More...

color &	color_fill () override
	Get or set the fill color of the widget. More...

toggle &	color_fill (const color &color_fill)
	Set the fill color of the widget. More...

color &	color_hot () override
	Get or set the widget's color when the mouse is hovered over it. More...

toggle &	color_hot (const color &color_hot)
	Set the widget's color when the mouse is hovered over it. More...

color &	color_selected () override
	Get or set the widget's color when selected. More...

toggle &	color_selected (const color &color_selected)
	Set the widget's color when selected. More...

color &	color_disabled () override
	Get or set the widget's color when it is disabled. More...

toggle &	color_disabled (const color &color_disabled)
	Set the widget's color when it is disabled. More...

std::string &	text_off ()
	Get or set the text to show when the toggle is off. More...

toggle &	text_off (const std::string &text_off)
	Set the text to show when the toggle is off. More...

color &	color_on ()
	Get or set the background color to use when the toggle is on. More...

toggle &	color_on (const color &color_on)
	Set the background color to use when the toggle is on. More...

color &	color_off ()
	Get or set the background color to use when the toggle is off. More...

toggle &	color_off (const color &color_off)
	Set the background color to use when the toggle is off. More...

bool &	on ()
	Get or set the toggle status. More...

toggle &	on (const bool &on)
	Set the toggle status. More...

Public Member Functions inherited from liblec::lecui::widgets::widget
	widget ()
	Widget constructor.

virtual	~widget ()
	Widget descructor.

bool	operator== (const widget &param)
	Check whether widget's basic specifications are equal. Only those properties that require the widget's basic resources to be re-created are considered. More...

bool	operator!= (const widget &param)
	Check whether widget's basic specifications are NOT equal. Only those properties that require the widget's basic resources to be re-created are considered. More...

virtual std::string &	text ()=0
	Get or set the widget text. More...

virtual std::string &	tooltip ()=0
	Get or set the widget's tooltip text. More...

virtual lecui::rect &	rect ()=0
	Get or set the position and dimensions of the widget. More...

virtual resize_params &	on_resize ()=0
	Get or set the behaviour of the widget when its container is resized. More...

virtual cursor_type &	cursor ()=0
	Get or set the mouse cursor to use then over the widget. More...

virtual std::string &	font ()=0
	Get or set the default widget font, e.g. "Georgia". More...

virtual float &	font_size ()=0
	Get or set the default widget font size in points, e.g. 9.0f. More...

virtual color &	color_text ()=0
	Get or set the color of the widget's text. More...

virtual color &	color_fill ()=0
	Get or set the fill color of the widget. More...

virtual color &	color_hot ()=0
	Get or set the widget's color when the mouse is hovered over it. More...

virtual color &	color_selected ()=0
	Get or set the widget's color when selected. More...

virtual color &	color_disabled ()=0
	Get or set the widget's color when it's disabled. More...

basic_events &	events ()
	Widget events. More...

const std::string &	alias ()
	The widget's alias, either user defined or automatically generated by the library. More...

Static Public Member Functions
static toggle &	add (containers::page &page, const std::string &alias=std::string())
	Add a toggle to a container. More...

static toggle &	get (form &fm, const std::string &path)
	Get the specifications of a toggle. More...

Additional Inherited Members
Public Types inherited from liblec::lecui::widgets::widget
enum class	cursor_type { arrow , hand , caret }
	Mouse cursor type. More...

Protected Attributes inherited from liblec::lecui::widgets::widget
std::string	_text
	The widget's text.

std::string	_tooltip
	The widget's tooltip text.

lecui::rect	_rect
	The widget's rectangle.

resize_params	_on_resize = { 0.f, 0.f, 0.f, 0.f }
	The widget's behaviour when container is resized.

cursor_type	_cursor = cursor_type::arrow
	The widget's cursor.

std::string	_font = "Segoe UI"
	The widget's font.

float	_font_size = 9.f
	The widget's font size.

color	_color_text = { 0, 0, 0, 255 }
	The color of the widget's text.

color	_color_fill = { 0, 120, 170, 255 }
	The fill color of the widget.

color	_color_hot = { 0, 120, 170, 255 }
	The color to indicate when the mouse hovers over the widget.

color	_color_selected = { 0, 120, 170, 30 }
	The color to indicate when the widget is selected.

color	_color_disabled = { 180, 180, 180, 255 }
	The color to indicate when the widget is disabled.

Detailed Description

Toggle widget. To instantiate and add to a container use the add static method.

Recommended height with defaults is 20px. Recommended minimum width with defaults is 100px. Default size is 200x20px.

Member Function Documentation

◆ add()

static toggle & liblec::lecui::widgets::toggle::add	(	containers::page &	page,
		const std::string &	alias = `std::string()`
	)

static

Add a toggle to a container.

Parameters

page	The container to place the widget in.
alias	The in-page unique alias, e.g. "use_ssl".

Returns: A reference to the widget specifications.

If an empty alias is given an internally generated random alias will be assigned.

◆ color_disabled() [1/2]

color & liblec::lecui::widgets::toggle::color_disabled ( )

overridevirtual

Get or set the widget's color when it is disabled.

Returns: a reference to the property.

Implements liblec::lecui::widgets::widget.

◆ color_disabled() [2/2]

toggle & liblec::lecui::widgets::toggle::color_disabled ( const color & color_disabled )

Set the widget's color when it is disabled.

Parameters

color_disabled The color of the widget when it is disabled, as defined in color.

Returns: A reference to the modified object.

◆ color_fill() [1/2]

color & liblec::lecui::widgets::toggle::color_fill ( )

overridevirtual

Get or set the fill color of the widget.

Returns: A reference to the widget's fill color.

Implements liblec::lecui::widgets::widget.

◆ color_fill() [2/2]

toggle & liblec::lecui::widgets::toggle::color_fill ( const color & color_fill )

Set the fill color of the widget.

Parameters

color_fill The fill color.

Returns: A reference to the modified object.

◆ color_hot() [1/2]

color & liblec::lecui::widgets::toggle::color_hot ( )

overridevirtual

Get or set the widget's color when the mouse is hovered over it.

Returns: A reference to the widget's hover color.

Implements liblec::lecui::widgets::widget.

◆ color_hot() [2/2]

toggle & liblec::lecui::widgets::toggle::color_hot ( const color & color_hot )

Set the widget's color when the mouse is hovered over it.

Parameters

color_hot The color.

Returns: A reference to the modified object.

◆ color_off() [1/2]

color & liblec::lecui::widgets::toggle::color_off ( )

Get or set the background color to use when the toggle is off.

Returns: A reference to the color.

◆ color_off() [2/2]

toggle & liblec::lecui::widgets::toggle::color_off ( const color & color_off )

Set the background color to use when the toggle is off.

Parameters

color_off The color.

Returns: A reference to the modified object.

◆ color_on() [1/2]

color & liblec::lecui::widgets::toggle::color_on ( )

Get or set the background color to use when the toggle is on.

Returns: A reference to the color.

◆ color_on() [2/2]

toggle & liblec::lecui::widgets::toggle::color_on ( const color & color_on )

Set the background color to use when the toggle is on.

Parameters

color_on The color.

Returns: A reference to the modified object.

◆ color_selected() [1/2]

color & liblec::lecui::widgets::toggle::color_selected ( )

overridevirtual

Get or set the widget's color when selected.

Returns: A reference to the widget's color when selected.

Implements liblec::lecui::widgets::widget.

◆ color_selected() [2/2]

toggle & liblec::lecui::widgets::toggle::color_selected ( const color & color_selected )

Set the widget's color when selected.

Parameters

color_selected The widget's color when selected.

Returns: A reference to the modified object.

◆ color_text() [1/2]

color & liblec::lecui::widgets::toggle::color_text ( )

overridevirtual

Get or set the color of the widget's text.

Returns: A reference to the widget's text color.

Implements liblec::lecui::widgets::widget.

◆ color_text() [2/2]

toggle & liblec::lecui::widgets::toggle::color_text ( const color & color_text )

Set the color of the widget's text.

Parameters

color_text The color of the widget's text.

Returns: A reference to the modified object.

◆ cursor() [1/2]

cursor_type & liblec::lecui::widgets::toggle::cursor ( )

overridevirtual

Get or set the mouse cursor to use then over the widget.

Returns: A reference to the cursor type as defined in cursor_type.

Implements liblec::lecui::widgets::widget.

◆ cursor() [2/2]

toggle & liblec::lecui::widgets::toggle::cursor ( const cursor_type cursor )

Set the mouse cursor to use when over the widget.

Parameters

cursor The cursor type as defined in cursor_type.

Returns: A reference to the modified object.

◆ events()

toggle_events & liblec::lecui::widgets::toggle::events ( )

inline

Get or set toggle widget events.

Returns: A reference to the toggle widget events.

◆ font() [1/2]

std::string & liblec::lecui::widgets::toggle::font ( )

overridevirtual

Get or set the default widget font, e.g. "Georgia".

Returns: A reference to the widget's font name.

Implements liblec::lecui::widgets::widget.

◆ font() [2/2]

toggle & liblec::lecui::widgets::toggle::font ( const std::string & font )

Set the default widget font.

Parameters

font	The font's name, e.g. "Georgia".

Returns: A reference to the modified object.

◆ font_size() [1/2]

float & liblec::lecui::widgets::toggle::font_size ( )

overridevirtual

Get or set the default widget font size in points, e.g. 9.0f.

Returns: A reference to the widget's font size.

Implements liblec::lecui::widgets::widget.

◆ font_size() [2/2]

toggle & liblec::lecui::widgets::toggle::font_size ( const float & font_size )

Set the widget's font size.

Parameters

font_size The font size in points, e.g. 9.0f.

Returns: A reference to the modified object.

◆ get()

static toggle & liblec::lecui::widgets::toggle::get	(	form &	fm,
		const std::string &	path
	)

static

Get the specifications of a toggle.

Parameters

fm	A reference to the form.
path	The full path to the widget, e.g. "sample_page/tools_tab_pane/options_tab/use_ssl".

Returns: A reference to the widget specifications.

Throws on failure. For faster coding and more readable code consider calling this static method through the helper macro provided.

◆ on() [1/2]

bool & liblec::lecui::widgets::toggle::on ( )

Get or set the toggle status.

Returns: A reference to the toggle status.

◆ on() [2/2]

toggle & liblec::lecui::widgets::toggle::on ( const bool & on )

Set the toggle status.

Parameters

on	The toggle status.

Returns: A reference to the modified object.

◆ on_resize() [1/2]

resize_params & liblec::lecui::widgets::toggle::on_resize ( )

overridevirtual

Get or set the behaviour of the widget when its container is resized.

Returns: A reference to the resize parameters as defined in resize_params.

Implements liblec::lecui::widgets::widget.

◆ on_resize() [2/2]

toggle & liblec::lecui::widgets::toggle::on_resize ( const resize_params & on_resize )

Set the behaviour of the widget when its container is resized.

Parameters

on_resize The resize parameters as defined in resize_params.

Returns: A reference to the modified object.

◆ operator!=()

bool liblec::lecui::widgets::toggle::operator!= ( const toggle & param )

Check whether widget specs are NOT equal. Only those properties that require the widget resources to be re-created are considered.

Parameters

param The specs to compare to.

Returns: Returns true if the specs are NOT equal, else false.

◆ operator==()

bool liblec::lecui::widgets::toggle::operator== ( const toggle & param )

Check whether widget specs are equal. Only those properties that require the widget resources to be re-created are considered.

Parameters

param The specs to compare to.

Returns: Returns true if the specs are equal, else false.

◆ rect() [1/2]

lecui::rect & liblec::lecui::widgets::toggle::rect ( )

overridevirtual

Get or set the position and dimensions of the widget.

Returns: A reference to the widget rectangle.

The position is in reference to the widget's container.

Implements liblec::lecui::widgets::widget.

◆ rect() [2/2]

toggle & liblec::lecui::widgets::toggle::rect ( const lecui::rect & rect )

Set the position and dimensions of the widget.

Parameters

rect	The widget's rectangle.

Returns: A reference to the modified object.

◆ text() [1/2]

std::string & liblec::lecui::widgets::toggle::text ( )

overridevirtual

Get or set the widget text.

Returns: A reference to the widget text.

Implements liblec::lecui::widgets::widget.

◆ text() [2/2]

toggle & liblec::lecui::widgets::toggle::text ( const std::string & text )

Set the widget's text.

Parameters

text The text.

Returns: A reference to the modified object.

◆ text_off() [1/2]

std::string & liblec::lecui::widgets::toggle::text_off ( )

Get or set the text to show when the toggle is off.

Returns: A reference to the text.

◆ text_off() [2/2]

toggle & liblec::lecui::widgets::toggle::text_off ( const std::string & text_off )

Set the text to show when the toggle is off.

Parameters

text_off The text.

Returns: A reference to the modified object.

◆ tooltip() [1/2]

std::string & liblec::lecui::widgets::toggle::tooltip ( )

overridevirtual

Get or set the widget's tooltip text.

Returns: A reference to the tooltip text.

Implements liblec::lecui::widgets::widget.

◆ tooltip() [2/2]

toggle & liblec::lecui::widgets::toggle::tooltip ( const std::string & tooltip )

Set the tooltip text.

Parameters

tooltip The tooltip text.

Returns: A reference to the modified object.

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

widgets/toggle.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ color_disabled() [1/2]

◆ color_disabled() [2/2]

◆ color_fill() [1/2]

◆ color_fill() [2/2]

◆ color_hot() [1/2]

◆ color_hot() [2/2]

◆ color_off() [1/2]

◆ color_off() [2/2]

◆ color_on() [1/2]

◆ color_on() [2/2]

◆ color_selected() [1/2]

◆ color_selected() [2/2]

◆ color_text() [1/2]

◆ color_text() [2/2]

◆ cursor() [1/2]

◆ cursor() [2/2]

◆ events()

◆ font() [1/2]

◆ font() [2/2]

◆ font_size() [1/2]

◆ font_size() [2/2]

◆ get()

◆ on() [1/2]

◆ on() [2/2]

◆ on_resize() [1/2]

◆ on_resize() [2/2]

◆ operator!=()

◆ operator==()

◆ rect() [1/2]

◆ rect() [2/2]

◆ text() [1/2]

◆ text() [2/2]

◆ text_off() [1/2]

◆ text_off() [2/2]

◆ tooltip() [1/2]

◆ tooltip() [2/2]