liblec::lecui::containers::status_pane_specs Class Reference

Status pane container specifications. More...

#include <status_pane.h>

Public Types
enum class	pane_location { bottom , top , left , right }
	The status pane's location. More...

Public Member Functions
float &	thickness ()
	Get or set the pane's thickness. This will be a height for top and bottom panes, and a width for left and right panes. More...
status_pane_specs &	thickness (const float &thickness)
	Set the pane's thickness. This will be a height for top and bottom panes, and a width for left and right panes. More...
bool &	floating ()
	Get or set the floating property. More...
status_pane_specs &	floating (const bool &floating)
	Set the floating property. More...
pane_location &	location ()
	Get or set the location of the status pane. More...
status_pane_specs &	location (const status_pane_specs::pane_location location)
	Set the location of the status pane. More...

Detailed Description

Status pane container specifications.

Note that this does not inherit from widgets::widget as regular panes do. This is by design because of the nature of the status pane.

Member Enumeration Documentation

pane_location

enum class liblec::lecui::containers::status_pane_specs::pane_location

strong

The status pane's location.

Enumerator
bottom	Place the status pane at the bottom.
top	Place the status pane at the top.
left	Place the status pane on the left.
right	Place the status pane on the right.

Member Function Documentation

floating() [1/2]

bool & liblec::lecui::containers::status_pane_specs::floating

(

)

Get or set the floating property.

Returns

A reference to the property.

The floating property determines whether the pane should just float above the form without eating into the client area.

floating() [2/2]

status_pane_specs & liblec::lecui::containers::status_pane_specs::floating

(

const bool &

floating

)

Set the floating property.

Parameters

floating

Whether to make this a floating pane.

Returns

A reference to the modified object.

The floating property determines whether the pane should just float above the form without eating into the client area.

location() [1/2]

pane_location & liblec::lecui::containers::status_pane_specs::location

(

)

Get or set the location of the status pane.

Returns

A reference to the property.

location() [2/2]

status_pane_specs & liblec::lecui::containers::status_pane_specs::location

(

const status_pane_specs::pane_location

location

)

Set the location of the status pane.

Parameters

location

The location of the status pane.

Returns

A reference to the modified object.

thickness() [1/2]

float & liblec::lecui::containers::status_pane_specs::thickness

(

)

Get or set the pane's thickness. This will be a height for top and bottom panes, and a width for left and right panes.

Returns

A reference to the thickness, in pixels.

thickness() [2/2]

status_pane_specs & liblec::lecui::containers::status_pane_specs::thickness

(

const float &

thickness

)

Set the pane's thickness. This will be a height for top and bottom panes, and a width for left and right panes.

Parameters

thickness

The thickness, in pixels.

Returns

A reference to the modified object.

---

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

• containers/status_pane.h