Tab pane. To instantiate and add to a container use the add static method. More...

#include <tab_pane.h>

Inheritance diagram for liblec::lecui::containers::tab_pane:

Public Types
enum class	side { left , right , top , bottom }
	The side to place the tabs on. More...

enum class	orientation { horizontal , vertical }
	Orientation of tab captions. More...

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

Public Member Functions
	tab_pane ()
	Class constructor.

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

bool	operator!= (const tab_pane &param)
	Check whether tab pane 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...

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

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

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

tab_pane &	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...

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

float &	border ()
	Get or set the thickness of the border. More...

tab_pane &	border (const float &border)
	Set the thickness of the border. More...

color &	color_border ()
	Get or set the color of the border. More...

tab_pane &	color_border (const color &color_border)
	Set the color of the border. More...

float &	corner_radius_x ()
	Get or set the horizontal radius of the corners. More...

tab_pane &	corner_radius_x (const float &corner_radius_x)
	Set the horizontal radius of the corners. More...

float &	corner_radius_y ()
	Get or set the vertical radius of the corners. More...

tab_pane &	corner_radius_y (const float &corner_radius_y)
	Set the vertical radius of the corners. More...

side &	tab_side ()
	Get or set the side on which to place the tab. More...

tab_pane &	tab_side (const side &tab_side)
	Set the side on which to place the tab. More...

std::vector< std::string > &	caption_reserve ()
	Get or set the caption reserve property. More...

tab_pane &	caption_reserve (const std::vector< std::string > &caption_reserve)
	Set the caption reserve property. More...

orientation &	caption_orientation ()
	Get or set the orientation of the caption text. More...

tab_pane &	caption_orientation (const orientation &caption_orientation)
	Set the orientation of the caption text. More...

color &	color_tabs ()
	Get or set the fill color of the tabs. More...

tab_pane &	color_tabs (const color &color_tabs)
	Set the fill color of the tabs. More...

color &	color_tabs_border ()
	Get or set the color of the tab borders. More...

tab_pane &	color_tabs_border (const color &color_tabs_border)
	Set the color of the tab borders. More...

float &	tabs_border ()
	Get or set the thickness of the tab borders. More...

tab_pane &	tabs_border (const float &tabs_border)
	Set the thickness of the tab borders. More...

std::string &	selected ()
	Get or set the selected tab. More...

tab_pane &	selected (const std::string &selected)
	Set the selected tab. 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 tab_pane &	add (containers::page &page, const std::string &alias=std::string(), const float &content_margin=10.f)
	Make a tab pane. More...

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

Additional Inherited Members
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

Tab pane. To instantiate and add to a container use the add static method.

Member Enumeration Documentation

◆ orientation

enum class liblec::lecui::containers::tab_pane::orientation

strong

Orientation of tab captions.

Enumerator
horizontal	Horizontal orientation.
vertical	Vertical orientation.

◆ side

enum class liblec::lecui::containers::tab_pane::side

strong

The side to place the tabs on.

Enumerator
left	Place the tabs on the left of the tab pane.
right	Place the tabs on the right of the tab pane.
top	Place the tabs at the top of the tab pane (default).
bottom	Place the tabs at the bottom of the tab pane.

Member Function Documentation

◆ add()

static tab_pane & liblec::lecui::containers::tab_pane::add	(	containers::page &	page,
		const std::string &	alias = `std::string()`,
		const float &	content_margin = `10.f`
	)

static

Make a tab pane.

Parameters

page	A reference to the container to place the tab pane in.
alias	The in-page unique alias, e.g. "settings_tab_pane".
content_margin	The margin to use inside the tabs.

Returns: A reference to the tab pane.

Ensure that the alias is unique within the page. Reusing an alias in a tab pane leads to undefined behavior.

◆ border() [1/2]

float & liblec::lecui::containers::tab_pane::border ( )

Get or set the thickness of the border.

Returns: A reference to the border thickness, in pixels.

◆ border() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::border ( const float & border )

Set the thickness of the border.

Parameters

border The border thickness, in pixels.

Returns: A reference to the modified object.

◆ caption_orientation() [1/2]

orientation & liblec::lecui::containers::tab_pane::caption_orientation ( )

Get or set the orientation of the caption text.

Returns: A reference to the property, as defined in orientation.

◆ caption_orientation() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::caption_orientation ( const orientation & caption_orientation )

Set the orientation of the caption text.

Parameters

caption_orientation The caption orientation, as defined in orientation.

Returns: A reference to the modified object.

◆ caption_reserve() [1/2]

std::vector< std::string > & liblec::lecui::containers::tab_pane::caption_reserve ( )

Get or set the caption reserve property.

Returns: A reference to the list of tab captions.

Only affects tab captions whose orientation is perpendicular to the tab area. Make a reservation for the captions of all the tabs that are going to be added. If there is no way to know before-hand it is recommended to insert at least one dummy caption that estimates the size of the longest expected caption. This is not required if the tab caption orientation is parallel to the tab area. If the tab caption orientation is perpendicular, it is important to set this reservation before adding the first tab to the tab pane. Failure to do this will result in the thickness of the tab area being clipped to the size of the first tab's caption. This, however, won't be an issue if the rest of the tab captions are shorter than the first.

◆ caption_reserve() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::caption_reserve ( const std::vector< std::string > & caption_reserve )

Set the caption reserve property.

Parameters

caption_reserve The list of tab captions.

Returns: A reference to the modified object.

Only affects tab captions whose orientation is perpendicular to the tab area. Make a reservation for the captions of all the tabs that are going to be added. If there is no way to know before-hand it is recommended to insert at least one dummy caption that estimates the size of the longest expected caption. This is not required if the tab caption orientation is parallel to the tab area. If the tab caption orientation is perpendicular, it is important to set this reservation before adding the first tab to the tab pane. Failure to do this will result in the thickness of the tab area being clipped to the size of the first tab's caption. This, however, won't be an issue if the rest of the tab captions are shorter than the first.

◆ color_border() [1/2]

color & liblec::lecui::containers::tab_pane::color_border ( )

Get or set the color of the border.

Returns: A reference to the border color, as defined in color.

◆ color_border() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::color_border ( const color & color_border )

Set the color of the border.

Parameters

color_border The border color, as defined in color.

Returns: A reference to the modified object.

◆ color_disabled() [1/2]

color & liblec::lecui::containers::tab_pane::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]

tab_pane & liblec::lecui::containers::tab_pane::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::containers::tab_pane::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]

tab_pane & liblec::lecui::containers::tab_pane::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::containers::tab_pane::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.

This property is not used.

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

◆ color_hot() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

This property is not used.

◆ color_selected() [1/2]

color & liblec::lecui::containers::tab_pane::color_selected ( )

overridevirtual

Get or set the widget's color when selected.

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

This property is not used.

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

◆ color_selected() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

This property is not used.

◆ color_tabs() [1/2]

color & liblec::lecui::containers::tab_pane::color_tabs ( )

Get or set the fill color of the tabs.

Returns: A reference to the color.

◆ color_tabs() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::color_tabs ( const color & color_tabs )

Set the fill color of the tabs.

Parameters

color_tabs The color.

Returns: A reference to the modified object.

◆ color_tabs_border() [1/2]

color & liblec::lecui::containers::tab_pane::color_tabs_border ( )

Get or set the color of the tab borders.

Returns: A reference to the color.

◆ color_tabs_border() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::color_tabs_border ( const color & color_tabs_border )

Set the color of the tab borders.

Parameters

color_tabs_border The color.

Returns: A reference to the modified object.

◆ color_text() [1/2]

color & liblec::lecui::containers::tab_pane::color_text ( )

overridevirtual

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

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

This property is not used.

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

◆ color_text() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

This property is not used.

◆ corner_radius_x() [1/2]

float & liblec::lecui::containers::tab_pane::corner_radius_x ( )

Get or set the horizontal radius of the corners.

Returns: A reference to the radius, in pixels.

◆ corner_radius_x() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::corner_radius_x ( const float & corner_radius_x )

Set the horizontal radius of the corners.

Parameters

corner_radius_x The horizontal radius of the corner, in pixels.

Returns: A reference to the modified object.

◆ corner_radius_y() [1/2]

float & liblec::lecui::containers::tab_pane::corner_radius_y ( )

Get or set the vertical radius of the corners.

Returns: A reference to the radius, in pixels.

◆ corner_radius_y() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::corner_radius_y ( const float & corner_radius_y )

Set the vertical radius of the corners.

Parameters

corner_radius_y The horizontal radius of the corner, in pixels.

Returns: A reference to the modified object.

◆ cursor() [1/2]

cursor_type & liblec::lecui::containers::tab_pane::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.

This is only used if the widget is non-static.

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

◆ cursor() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

◆ font() [1/2]

std::string & liblec::lecui::containers::tab_pane::font ( )

overridevirtual

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

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

This property is not used.

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

◆ font() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

This property is not used.

◆ font_size() [1/2]

float & liblec::lecui::containers::tab_pane::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.

This property is not used.

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

◆ font_size() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::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.

This property is not used.

◆ get()

static tab_pane & liblec::lecui::containers::tab_pane::get	(	form &	fm,
		const std::string &	path
	)

static

Get the specifications of a pane.

Parameters

fm	A reference to the form.
path	The full path to the pane, e.g. "sample_page/settings_pane".

Returns: A reference to the pane specifications.

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

◆ on_resize() [1/2]

resize_params & liblec::lecui::containers::tab_pane::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]

tab_pane & liblec::lecui::containers::tab_pane::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::containers::tab_pane::operator!= ( const tab_pane & param )

Check whether tab pane 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::containers::tab_pane::operator== ( const tab_pane & param )

Check whether tab pane 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::containers::tab_pane::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]

tab_pane & liblec::lecui::containers::tab_pane::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.

◆ selected() [1/2]

std::string & liblec::lecui::containers::tab_pane::selected ( )

Get or set the selected tab.

Returns: A reference to the property.

◆ selected() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::selected ( const std::string & selected )

Set the selected tab.

Parameters

selected The name of the tab.

Returns: A reference to the modified object.

◆ tab_side() [1/2]

side & liblec::lecui::containers::tab_pane::tab_side ( )

Get or set the side on which to place the tab.

Returns: A reference to the property, as defined in side.

◆ tab_side() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::tab_side ( const side & tab_side )

Set the side on which to place the tab.

Parameters

tab_side The property, as defined in side.

Returns: A reference to the modified object.

◆ tabs_border() [1/2]

float & liblec::lecui::containers::tab_pane::tabs_border ( )

Get or set the thickness of the tab borders.

Returns: A reference to the thickness, in pixels.

◆ tabs_border() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::tabs_border ( const float & tabs_border )

Set the thickness of the tab borders.

Parameters

tabs_border The thickness, in pixels.

Returns: A reference to the modified object.

◆ text() [1/2]

std::string & liblec::lecui::containers::tab_pane::text ( )

overridevirtual

Get or set the widget text.

Returns: A reference to the widget text.

This property is not used.

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

◆ text() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::text ( const std::string & text )

Set the widget's text.

Parameters

text The text.

Returns: A reference to the modified object.

This property is not used.

◆ tooltip() [1/2]

std::string & liblec::lecui::containers::tab_pane::tooltip ( )

overridevirtual

Get or set the widget's tooltip text.

Returns: A reference to the tooltip text.

This property is not used.

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

◆ tooltip() [2/2]

tab_pane & liblec::lecui::containers::tab_pane::tooltip ( const std::string & tooltip )

Set the tooltip text.

Parameters

tooltip The tooltip text.

Returns: A reference to the modified object.

This property is not used.

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

containers/tab_pane.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ orientation

◆ side

Member Function Documentation

◆ add()

◆ border() [1/2]

◆ border() [2/2]

◆ caption_orientation() [1/2]

◆ caption_orientation() [2/2]

◆ caption_reserve() [1/2]

◆ caption_reserve() [2/2]

◆ color_border() [1/2]

◆ color_border() [2/2]

◆ 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_selected() [1/2]

◆ color_selected() [2/2]

◆ color_tabs() [1/2]

◆ color_tabs() [2/2]

◆ color_tabs_border() [1/2]

◆ color_tabs_border() [2/2]

◆ color_text() [1/2]

◆ color_text() [2/2]

◆ corner_radius_x() [1/2]

◆ corner_radius_x() [2/2]

◆ corner_radius_y() [1/2]

◆ corner_radius_y() [2/2]

◆ cursor() [1/2]

◆ cursor() [2/2]

◆ font() [1/2]

◆ font() [2/2]

◆ font_size() [1/2]

◆ font_size() [2/2]

◆ get()

◆ on_resize() [1/2]

◆ on_resize() [2/2]

◆ operator!=()

◆ operator==()

◆ rect() [1/2]

◆ rect() [2/2]

◆ selected() [1/2]

◆ selected() [2/2]

◆ tab_side() [1/2]

◆ tab_side() [2/2]

◆ tabs_border() [1/2]

◆ tabs_border() [2/2]

◆ text() [1/2]

◆ text() [2/2]

◆ tooltip() [1/2]

◆ tooltip() [2/2]