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

Manipulate a form's controls. More...

#include <controls.h>

Public Member Functions

 controls (form &fm)
 Class constructor. More...
 
 ~controls ()
 Class destructor.
 
controlsallow_resize (bool enable)
 Whether to allow a form to be resizable. More...
 
controlsallow_minimize (bool enable)
 Whether to add a minimize control button to the form. More...
 
controlsmake_top_most (bool enable)
 Whether to make this a top most form. More...
 
controlsstart_hidden (bool hidden)
 Whether to keep the form hidden after its creation. More...
 

Detailed Description

Manipulate a form's controls.

This manipulation is best done in the form's initialize event.

Constructor & Destructor Documentation

◆ controls()

liblec::lecui::controls::controls ( form fm)

Class constructor.

Parameters
fmA reference to the form.

Member Function Documentation

◆ allow_minimize()

controls & liblec::lecui::controls::allow_minimize ( bool  enable)

Whether to add a minimize control button to the form.

Parameters
enableSet to false to remove the minimize control button.
Returns
A reference to the modified object.

The minimize control button is enabled by default if this method is never called.

◆ allow_resize()

controls & liblec::lecui::controls::allow_resize ( bool  enable)

Whether to allow a form to be resizable.

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

If resizing is enabled by default if this method is never called.

◆ make_top_most()

controls & liblec::lecui::controls::make_top_most ( bool  enable)

Whether to make this a top most form.

Parameters
enableSet to false for a normal form and to true to make the form appear above all other windows.
Returns
A reference to the modified object.

◆ start_hidden()

controls & liblec::lecui::controls::start_hidden ( bool  hidden)

Whether to keep the form hidden after its creation.

Parameters
hiddenSet to false to keep normal form bahaviour and to true to initialize app with the form hidden. Useful when starting app in the background and when using the system tray.
Returns
A reference to the modified object.

To hide a form after it has already been created use the form::hide method. To restore a form after it's creation use the form::restore method.


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