xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::vertical_control_layout_style Class Reference
Inheritance diagram for xtd::forms::vertical_control_layout_style:
xtd::forms::control_layout_style xtd::iequatable< vertical_control_layout_style > xtd::object xtd::iequatable< control_layout_style > xtd::interface xtd::extensions::equality_operators< type_t, equatable_t > xtd::interface xtd::extensions::equality_operators< type_t, equatable_t >

Definition

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

Header
#include <xtd/forms/vertical_control_layout_style>
Namespace
xtd::forms
Library
xtd.forms

Public Constructors

 vertical_control_layout_style ()=default
 Initialises a new instance of vertical control layout style class.
 
 vertical_control_layout_style (float height)
 Initialises a new instance of vertical control layout style class with specified height.
 
 vertical_control_layout_style (int32 height)
 Initialises a new instance of vertical control layout style class with specified height.
 
 vertical_control_layout_style (xtd::forms::size_type size_type)
 Initialises a new instance of vertical control layout style class with specified size type.
 
 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.
 
 vertical_control_layout_style (int32 height, xtd::forms::size_type size_type)
 Initialises a new instance of vertical control layout style class with specified height and size type.
 
 vertical_control_layout_style (bool expanded)
 Initialises a new instance of vertical control layout style class with specified expanded.
 
 vertical_control_layout_style (float height, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height and expanded.
 
 vertical_control_layout_style (int32 height, bool expanded)
 Initialises a new instance of vertical control layout style class with specified height and expanded.
 
 vertical_control_layout_style (xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified content alignment.
 
 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.
 
 vertical_control_layout_style (int32 height, xtd::forms::content_alignment align)
 Initialises a new instance of vertical control layout style class with specified height and content alignment.
 
 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.
 
 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.
 
 vertical_control_layout_style (int32 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.
 
 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.
 
 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.
 
 vertical_control_layout_style (int32 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.
 
 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.
 
 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.
 
 vertical_control_layout_style (int32 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.
 
 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.
 
 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.
 
 vertical_control_layout_style (int32 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.
 

Public Properties

std::optional< float > height () const noexcept
 Gets the height value for a control.
 
void height (float height)
 Sets the height value for a control.
 

Public Methods

bool equals (const vertical_control_layout_style &other) const noexcept override
 Determines whether the specified object is equal to the current object.
 
xtd::size get_hash_code () const noexcept override
 Serves as a hash function for a particular type.
 
xtd::string to_string () const noexcept override
 Returns a string that represent xtd::forms::control_layout_style.
 
bool equals (const xtd::object &obj) const noexcept override
 Determines whether the specified object is equal to the current object.
 
bool equals (const control_layout_style &other) const noexcept override
 Determines whether the specified object is equal to the current object.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::forms::control_layout_style
xtd::forms::size_type size_type () const noexcept
 Gets a flag indicating how a control should be sized relative to its containing layout container.
 
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.
 
bool expanded () const noexcept
 Gets a flag indicating if control is expanded to its containing layout container.
 
control_layout_styleexpanded (bool expanded)
 Sets a flag indicating if control is expanded to its containing layout container.
 
xtd::forms::content_alignment align () const noexcept
 Gets a flag indicating how a control should be align to its containing layout container.
 
control_layout_stylealign (xtd::forms::content_alignment align)
 Sets a flag indicating how a control should be align to its containing layout container.
 
bool equals (const control_layout_style &other) const noexcept override
 Determines whether the specified object is equal to the current object.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<class object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
- Public Member Functions inherited from xtd::iequatable< control_layout_style >
virtual bool equals (const control_layout_style &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type.
 
- Public Member Functions inherited from xtd::iequatable< vertical_control_layout_style >
virtual bool equals (const vertical_control_layout_style &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type.
 
- Static Public Member Functions inherited from xtd::object
template<class object_a_t , class object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<class object_a_t , class object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 
- Protected Member Functions inherited from xtd::forms::control_layout_style
 control_layout_style ()
 Initialises a new instance of control layout style class.
 
 control_layout_style (xtd::forms::size_type size_type)
 Initialises a new instance of control layout style class with specified size type.
 
 control_layout_style (bool expanded)
 Initialises a new instance of control layout style class with specified expanded.
 
 control_layout_style (xtd::forms::content_alignment align)
 Initialises a new instance of control layout style class with specified content alignment.
 
 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.
 
 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.
 
 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.
 
 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.
 

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)
explicit

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  height)
explicit

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)
explicit

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 
)

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  height,
xtd::forms::size_type  size_type 
)

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)
explicit

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 
)

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  height,
bool  expanded 
)

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)
explicit

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 
)

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  height,
xtd::forms::content_alignment  align 
)

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 
)

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 
)

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

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 
)

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 
)

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

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 
)

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 
)

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

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 
)

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 
)

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

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
noexcept

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)

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.

◆ equals() [1/3]

bool xtd::forms::vertical_control_layout_style::equals ( const vertical_control_layout_style other) const
overridenoexcept

Determines whether the specified object is equal to the current object.

Parameters
otherThe object to compare with the current object.
Returns
true if the specified object is equal to the current object. otherwise, false.

◆ get_hash_code()

xtd::size xtd::forms::vertical_control_layout_style::get_hash_code ( ) const
overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns
A hash code for the current object.

Reimplemented from xtd::forms::control_layout_style.

◆ to_string()

xtd::string xtd::forms::vertical_control_layout_style::to_string ( ) const
overridevirtualnoexcept

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.

◆ equals() [2/3]

bool xtd::forms::control_layout_style::equals ( const xtd::object obj) const
overridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters
objThe object to compare with the current object.
Returns
true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::forms::control_layout_style.

◆ equals() [3/3]

bool xtd::forms::control_layout_style::equals ( const control_layout_style other) const
overridenoexcept

Determines whether the specified object is equal to the current object.

Parameters
otherThe object to compare with the current object.
Returns
true if the specified object is equal to the current object. otherwise, false.

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