xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::forms::vertical_control_layout_style Class Reference

#include <vertical_control_layout_style.h>

Definition

Implements the basic functionality that represents the appearance and behavior of a control layout.

Namespace
xtd::forms
Library
xtd.forms

Public Member Functions

 vertical_control_layout_style ()=default
 Initialises a new instance of vertical control layout style class. More...
 
 vertical_control_layout_style (float height)
 Initialises a new instance of vertical control layout style class with specified height. More...
 
 vertical_control_layout_style (int32_t height)
 Initialises a new instance of vertical control layout style class with specified height. More...
 
 vertical_control_layout_style (xtd::forms::size_type size_type)
 Initialises a new instance of vertical control layout style class with specified size type. More...
 
 vertical_control_layout_style (float height, xtd::forms::size_type size_type)
 Initialises a new instance of vertical control layout style class with specified height and size type. More...
 
 vertical_control_layout_style (int32_t height, xtd::forms::size_type size_type)
 Initialises a new instance of vertical control layout style class with specified height and size type. More...
 
 vertical_control_layout_style (bool expanded)
 Initialises a new instance of vertical control layout style class with specified expanded. More...
 
 vertical_control_layout_style (float height, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height and expanded. More...
 
 vertical_control_layout_style (int32_t height, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height and expanded. More...
 
 vertical_control_layout_style (xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified content alignment. More...
 
 vertical_control_layout_style (float height, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height and content alignment. More...
 
 vertical_control_layout_style (int32_t height, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height and content alignment. More...
 
 vertical_control_layout_style (xtd::forms::size_type size_type, bool expanded)
 Initialises a new instance of vertical control layout style class with specified size type and expanded. More...
 
 vertical_control_layout_style (float height, xtd::forms::size_type size_type, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height, size type and expanded. More...
 
 vertical_control_layout_style (int32_t height, xtd::forms::size_type size_type, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height, size type and expanded. More...
 
 vertical_control_layout_style (xtd::forms::size_type size_type, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified size type and content alignment. More...
 
 vertical_control_layout_style (float height, xtd::forms::size_type size_type, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, size type and content alignment. More...
 
 vertical_control_layout_style (int32_t height, xtd::forms::size_type size_type, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, size type and content alignment. More...
 
 vertical_control_layout_style (xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified size type, expanded and content alignment. More...
 
 vertical_control_layout_style (float height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment. More...
 
 vertical_control_layout_style (int32_t height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment. More...
 
 vertical_control_layout_style (bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified expanded and content alignment. More...
 
 vertical_control_layout_style (float height, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment. More...
 
 vertical_control_layout_style (int32_t height, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment. More...
 
std::optional< float > height () const
 Gets the height value for a control. More...
 
void height (float height)
 Sets the height value for a control. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represent xtd::forms::control_layout_style. More...
 
- Public Member Functions inherited from xtd::forms::control_layout_style
xtd::forms::content_alignment align () const
 Gets a flag indicating how a control should be align to its containing layout container. More...
 
control_layout_stylealign (xtd::forms::content_alignment align)
 Sets a flag indicating how a control should be align to its containing layout container. More...
 
bool expanded () const
 Gets a flag indicating if control is expanded to its containing layout container. More...
 
control_layout_styleexpanded (bool expanded)
 Sets a flag indicating if control is expanded to its containing layout container. More...
 
xtd::forms::size_type size_type () const
 Gets a flag indicating how a control should be sized relative to its containing layout container. More...
 
control_layout_stylesize_type (xtd::forms::size_type size_type)
 Sets a flag indicating how a control should be sized relative to its containing layout container. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 
- Protected Member Functions inherited from xtd::forms::control_layout_style
 control_layout_style ()=default
 Initialises a new instance of control layout style class. More...
 
 control_layout_style (xtd::forms::size_type size_type)
 Initialises a new instance of control layout style class with specified size type. More...
 
 control_layout_style (bool expanded)
 Initialises a new instance of control layout style class with specified expanded. More...
 
 control_layout_style (xtd::forms::content_alignment align)
 Initialises a new instance of control layout style class with specified content alignment. More...
 
 control_layout_style (xtd::forms::size_type size_type, bool expanded)
 Initialises a new instance of control layout style class with specified size type and expanded. More...
 
 control_layout_style (xtd::forms::size_type size_type, xtd::forms::content_alignment align)
 Initialises a new instance of control layout style class with specified size type and content alignment. More...
 
 control_layout_style (xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of control layout style class with specified size type, expanded and content alignment. More...
 
 control_layout_style (bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of control layout style class with specified expanded and content alignment. More...
 

Constructor & Destructor Documentation

◆ vertical_control_layout_style() [1/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( )
default

Initialises a new instance of vertical control layout style class.

◆ vertical_control_layout_style() [2/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height)
inline

Initialises a new instance of vertical control layout style class with specified height.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

◆ vertical_control_layout_style() [3/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height)
inline

Initialises a new instance of vertical control layout style class with specified height.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

◆ vertical_control_layout_style() [4/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::size_type  size_type)
inline

Initialises a new instance of vertical control layout style class with specified size type.

Parameters
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

◆ vertical_control_layout_style() [5/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
xtd::forms::size_type  size_type 
)
inline

Initialises a new instance of vertical control layout style class with specified height and size type.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

◆ vertical_control_layout_style() [6/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
xtd::forms::size_type  size_type 
)
inline

Initialises a new instance of vertical control layout style class with specified height and size type.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

◆ vertical_control_layout_style() [7/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( bool  expanded)
inline

Initialises a new instance of vertical control layout style class with specified expanded.

Parameters
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [8/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
bool  expanded 
)
inline

Initialises a new instance of vertical control layout style class with specified height and expanded.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [9/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
bool  expanded 
)
inline

Initialises a new instance of vertical control layout style class with specified height and expanded.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [10/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::content_alignment  align)
inline

Initialises a new instance of vertical control layout style class with specified content alignment.

Parameters
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [11/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [12/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [13/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::size_type  size_type,
bool  expanded 
)
inline

Initialises a new instance of vertical control layout style class with specified size type and expanded.

Parameters
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [14/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
xtd::forms::size_type  size_type,
bool  expanded 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type and expanded.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [15/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
xtd::forms::size_type  size_type,
bool  expanded 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type and expanded.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.

◆ vertical_control_layout_style() [16/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::size_type  size_type,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified size type and content alignment.

Parameters
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [17/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
xtd::forms::size_type  size_type,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [18/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
xtd::forms::size_type  size_type,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [19/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::size_type  size_type,
bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified size type, expanded and content alignment.

Parameters
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [20/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
xtd::forms::size_type  size_type,
bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [21/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
xtd::forms::size_type  size_type,
bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_typeOne of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [22/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified expanded and content alignment.

Parameters
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [23/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height,
bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

◆ vertical_control_layout_style() [24/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32_t  height,
bool  expanded,
xtd::forms::content_alignment  align 
)
inline

Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values. The default is middle_center.

Member Function Documentation

◆ height() [1/2]

std::optional<float> xtd::forms::vertical_control_layout_style::height ( ) const
inline

Gets the height value for a control.

Returns
The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

◆ height() [2/2]

void xtd::forms::vertical_control_layout_style::height ( float  height)
inline

Sets the height value for a control.

Parameters
heightThe preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

◆ to_string()

xtd::ustring xtd::forms::vertical_control_layout_style::to_string ( ) const
inlineoverridevirtualnoexcept

Returns a string that represent xtd::forms::control_layout_style.

Returns
A string containing that represent xtd::forms::control_layout_style.

Reimplemented from xtd::forms::control_layout_style.


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