lecui 1.0.0-alpha.20
lecui C++ user interface library
Public Member Functions | List of all members
liblec::lecui::appearance Class Reference

Manipulate the form's appearance. More...

#include <appearance.h>

Public Member Functions

 appearance (form &fm)
 Class constructor. More...
 
 ~appearance ()
 Class destructor.
 
appearancetheme (themes theme)
 Set a preset theme. More...
 
themes theme ()
 Get the preset theme. More...
 
appearancetheme (const lecui::color &color, const lecui::color &color_hot, const lecui::color &color_disabled, const lecui::color &color_text)
 Set the theme color. More...
 
bool & shadow ()
 Set or get the form shadow property. More...
 
bool get_shadow () const
 Get the status of the form shadow. More...
 
appearanceshadow (const bool &enable)
 Set the form shadow property. More...
 
lecui::colorbackground ()
 Get or set the form's background color. More...
 
lecui::color get_background () const
 Get or the form's background color. More...
 
appearancebackground (const lecui::color &color)
 Set the form's background colors. More...
 
lecui::colortitle_bar ()
 Get or set the background color of the title bar. More...
 
lecui::color title_bar () const
 Get the background color of the title bar. More...
 
appearancetitle_bar (const lecui::color &color)
 Set the background color of the titlebar. More...
 
int & main_icon ()
 Get or set the ID of the main icon resource. More...
 
int get_main_icon () const
 Get the ID of the main icon resource. More...
 
appearancemain_icon (const int &main_icon)
 Set the ID of the main .ico resource. More...
 
int & mini_icon ()
 Get or set the ID of the small icon resource. More...
 
int get_mini_icon () const
 Get the ID of the small icon resource. More...
 
appearancemini_icon (const int &mini_icon)
 Set the ID of the small .ico resource. More...
 
int & caption_icon ()
 Get or set the ID of the caption icon resource. More...
 
int get_caption_icon () const
 Get the ID of the caption icon resource. More...
 
appearancecaption_icon (const int &caption_icon)
 Set the ID of the caption icon resource. More...
 

Detailed Description

Manipulate the form's appearance.

Constructor & Destructor Documentation

◆ appearance()

liblec::lecui::appearance::appearance ( form fm)

Class constructor.

Parameters
fmA reference to the form.

Member Function Documentation

◆ background() [1/2]

lecui::color & liblec::lecui::appearance::background ( )

Get or set the form's background color.

Returns
Returns a reference to the property.

◆ background() [2/2]

appearance & liblec::lecui::appearance::background ( const lecui::color color)

Set the form's background colors.

Parameters
colorThe background color of the entire form.
Returns
A reference to the modified object.

◆ caption_icon() [1/2]

int & liblec::lecui::appearance::caption_icon ( )

Get or set the ID of the caption icon resource.

Returns
A reference to the caption icon .png resource ID.

◆ caption_icon() [2/2]

appearance & liblec::lecui::appearance::caption_icon ( const int &  caption_icon)

Set the ID of the caption icon resource.

Parameters
caption_iconThe resource ID of the caption icon .png.
Returns
A reference to the modified object.

◆ get_background()

lecui::color liblec::lecui::appearance::get_background ( ) const

Get or the form's background color.

Returns
The value of the property.

◆ get_caption_icon()

int liblec::lecui::appearance::get_caption_icon ( ) const

Get the ID of the caption icon resource.

Returns
The resource ID of the caption icon .png.

◆ get_main_icon()

int liblec::lecui::appearance::get_main_icon ( ) const

Get the ID of the main icon resource.

Returns
The resource ID of the main .ico.

◆ get_mini_icon()

int liblec::lecui::appearance::get_mini_icon ( ) const

Get the ID of the small icon resource.

Returns
The resource ID of the small .ico.

◆ get_shadow()

bool liblec::lecui::appearance::get_shadow ( ) const

Get the status of the form shadow.

Returns
The status of the form shadow.

◆ main_icon() [1/2]

int & liblec::lecui::appearance::main_icon ( )

Get or set the ID of the main icon resource.

Returns
A reference to the main .ico resource ID.

◆ main_icon() [2/2]

appearance & liblec::lecui::appearance::main_icon ( const int &  main_icon)

Set the ID of the main .ico resource.

Parameters
main_iconThe ID of the main .ico resource.
Returns
A reference to the modified object.

◆ mini_icon() [1/2]

int & liblec::lecui::appearance::mini_icon ( )

Get or set the ID of the small icon resource.

Returns
A reference to the small .ico resource ID.

◆ mini_icon() [2/2]

appearance & liblec::lecui::appearance::mini_icon ( const int &  mini_icon)

Set the ID of the small .ico resource.

Parameters
mini_iconThe ID of the small .ico resource.
Returns
A reference to the modified object.

◆ shadow() [1/2]

bool & liblec::lecui::appearance::shadow ( )

Set or get the form shadow property.

Returns
A reference to the property.

◆ shadow() [2/2]

appearance & liblec::lecui::appearance::shadow ( const bool &  enable)

Set the form shadow property.

Parameters
enableSet to false to disable the shadow.
Returns
A reference to the modified object.

The shadow is enabled by default if this method is never called.

◆ theme() [1/3]

themes liblec::lecui::appearance::theme ( )

Get the preset theme.

Returns
The theme.

◆ theme() [2/3]

appearance & liblec::lecui::appearance::theme ( const lecui::color color,
const lecui::color color_hot,
const lecui::color color_disabled,
const lecui::color color_text 
)

Set the theme color.

Parameters
colorThe color of controls and the form border.
color_hotThe color on-hovering over a control.
color_disabledThe color when a control is disabled.
color_textThe text color.
Returns
A reference to the modified object.

◆ theme() [3/3]

appearance & liblec::lecui::appearance::theme ( themes  theme)

Set a preset theme.

Parameters
themeThe theme to set.
Returns
A reference to the modified object.

This option has to be set early in the form's layout event, or better in the form's initialize event. Changing this later is not yet supported.

◆ title_bar() [1/3]

lecui::color & liblec::lecui::appearance::title_bar ( )

Get or set the background color of the title bar.

Returns
A reference to the property.

◆ title_bar() [2/3]

lecui::color liblec::lecui::appearance::title_bar ( ) const

Get the background color of the title bar.

Returns
The value of the property.

◆ title_bar() [3/3]

appearance & liblec::lecui::appearance::title_bar ( const lecui::color color)

Set the background color of the titlebar.

Parameters
colorThe background color of the titlebar.
Returns
A reference to the modified object.

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