xtd 1.0.0
Loading...
Searching...
No Matches
xtd::forms::horizontal_control_layout_style Class Reference
Inheritance diagram for xtd::forms::horizontal_control_layout_style:
xtd::forms::control_layout_style xtd::iequatable< horizontal_control_layout_style > xtd::object xtd::iequatable< control_layout_style > xtd::interface xtd::extensions::equality_operators< horizontal_control_layout_style, iequatable< horizontal_control_layout_style > > xtd::interface xtd::extensions::equality_operators< control_layout_style, iequatable< control_layout_style > >

Definition

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

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

Public Constructors

 horizontal_control_layout_style ()=default
 Initialises a new instance of horizontal control layout style class.
 horizontal_control_layout_style (float width)
 Initialises a new instance of horizontal control layout style class with specified width.
 horizontal_control_layout_style (xtd::int32 width)
 Initialises a new instance of horizontal control layout style class with specified width.
 horizontal_control_layout_style (xtd::forms::size_type size_typesize_type)
 Initialises a new instance of horizontal control layout style class with specified size type.
 horizontal_control_layout_style (float width, xtd::forms::size_type size_typesize_type)
 Initialises a new instance of horizontal control layout style class with specified width and size type.
 horizontal_control_layout_style (xtd::int32 width, xtd::forms::size_type size_typesize_type)
 Initialises a new instance of horizontal control layout style class with specified width and size type.
 horizontal_control_layout_style (bool expanded)
 Initialises a new instance of horizontal control layout style class with specified expanded.
 horizontal_control_layout_style (float width, bool expanded)
 Initialises a new instance of horizontal control layout style class with specified width and expanded.
 horizontal_control_layout_style (xtd::int32 width, bool expanded)
 Initialises a new instance of horizontal control layout style class with specified width and expanded.
 horizontal_control_layout_style (xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified content alignment.
 horizontal_control_layout_style (float width, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width and content alignment.
 horizontal_control_layout_style (xtd::int32 width, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width and content alignment.
 horizontal_control_layout_style (xtd::forms::size_type size_typesize_type, bool expanded)
 Initialises a new instance of horizontal control layout style class with specified size type and expanded.
 horizontal_control_layout_style (float width, xtd::forms::size_type size_typesize_type, bool expanded)
 Initialises a new instance of horizontal control layout style class with specified width, size type and expanded.
 horizontal_control_layout_style (xtd::int32 width, xtd::forms::size_type size_typesize_type, bool expanded)
 Initialises a new instance of horizontal control layout style class with specified width, size type and expanded.
 horizontal_control_layout_style (xtd::forms::size_type size_typesize_type, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified size type and content alignment.
 horizontal_control_layout_style (float width, xtd::forms::size_type size_typesize_type, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width, size type and content alignment.
 horizontal_control_layout_style (xtd::int32 width, xtd::forms::size_type size_typesize_type, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width, size type and content alignment.
 horizontal_control_layout_style (xtd::forms::size_type size_typesize_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified size type, expanded and content alignment.
 horizontal_control_layout_style (float width, xtd::forms::size_type size_typesize_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width, size type, expanded and content alignment.
 horizontal_control_layout_style (xtd::int32 width, xtd::forms::size_type size_typesize_type, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified width, size type, expanded and content alignment.
 horizontal_control_layout_style (bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified expanded and content alignment.
 horizontal_control_layout_style (float width, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified expanded and content alignment.
 horizontal_control_layout_style (xtd::int32 width, bool expanded, xtd::forms::content_alignment align)
 Initialises a new instance of horizontal control layout style class with specified expanded and content alignment.

Public Properties

auto width () const noexcept -> std::optional< float >
 Gets the width value for a control.
auto width (float value) -> horizontal_control_layout_style &
 Sets the width value for a control.

Public Methods

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

Additional Inherited Members

auto size_type () const noexcept -> xtd::forms::size_type
 Gets a flag indicating how a control should be sized relative to its containing layout container.
auto size_type (xtd::forms::size_type size_typesize_type) -> control_layout_style &
 Sets a flag indicating how a control should be sized relative to its containing layout container.
auto expanded () const noexcept -> bool
 Gets a flag indicating if control is expanded to its containing layout container.
auto expanded (bool expanded) -> control_layout_style &
 Sets a flag indicating if control is expanded to its containing layout container.
auto align () const noexcept -> xtd::forms::content_alignment
 Gets a flag indicating how a control should be align to its containing layout container.
auto align (xtd::forms::content_alignment align) -> control_layout_style &
 Sets a flag indicating how a control should be align to its containing layout container.
auto equals (const control_layout_style &other) const noexcept -> bool override
 Determines whether the specified object is equal to the current object.
 object ()=default
 Create a new instance of the ultimate base class object.
virtual auto get_type () const noexcept -> type_object
 Gets the type of the current instance.
template<typename object_t>
auto memberwise_clone () const -> xtd::unique_ptr_object< object_t >
 Creates a shallow copy of the current object.
virtual auto equals (const control_layout_style &) const noexcept -> bool=0
 Indicates whether the current object is equal to another object of the same type.
virtual auto equals (const horizontal_control_layout_style &) const noexcept -> bool=0
 Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
 Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
 Determines whether the specified object instances are the same instance.
 control_layout_style ()
 Initialises a new instance of control layout style class.
 control_layout_style (xtd::forms::size_type size_typesize_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_typesize_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_typesize_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_typesize_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

◆ horizontal_control_layout_style() [1/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( )
default

Initialises a new instance of horizontal control layout style class.

◆ horizontal_control_layout_style() [2/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width)
explicit

Initialises a new instance of horizontal control layout style class with specified width.

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

◆ horizontal_control_layout_style() [3/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width)
explicit

Initialises a new instance of horizontal control layout style class with specified width.

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

◆ horizontal_control_layout_style() [4/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::forms::size_type size_type)
explicit

Initialises a new instance of horizontal 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.

◆ horizontal_control_layout_style() [5/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
xtd::forms::size_type size_type )

Initialises a new instance of horizontal control layout style class with specified width and size type.

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [6/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
xtd::forms::size_type size_type )

Initialises a new instance of horizontal control layout style class with specified width and size type.

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [7/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( bool expanded)
explicit

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

Parameters
expandedtrue if control expanded; otherwise false.

◆ horizontal_control_layout_style() [8/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
bool expanded )

Initialises a new instance of horizontal control layout style class with specified width and expanded.

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

◆ horizontal_control_layout_style() [9/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
bool expanded )

Initialises a new instance of horizontal control layout style class with specified width and expanded.

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

◆ horizontal_control_layout_style() [10/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::forms::content_alignment align)
explicit

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

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

◆ horizontal_control_layout_style() [11/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
xtd::forms::content_alignment align )

Initialises a new instance of horizontal control layout style class with specified width and content alignment.

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [12/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
xtd::forms::content_alignment align )

Initialises a new instance of horizontal control layout style class with specified width and content alignment.

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [13/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::forms::size_type size_type,
bool expanded )

Initialises a new instance of horizontal 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.

◆ horizontal_control_layout_style() [14/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
xtd::forms::size_type size_type,
bool expanded )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [15/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
xtd::forms::size_type size_type,
bool expanded )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [16/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::forms::size_type size_type,
xtd::forms::content_alignment align )

Initialises a new instance of horizontal 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.

◆ horizontal_control_layout_style() [17/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
xtd::forms::size_type size_type,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [18/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
xtd::forms::size_type size_type,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [19/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::forms::size_type size_type,
bool expanded,
xtd::forms::content_alignment align )

Initialises a new instance of horizontal 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.

◆ horizontal_control_layout_style() [20/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
xtd::forms::size_type size_type,
bool expanded,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [21/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
xtd::forms::size_type size_type,
bool expanded,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [22/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( bool expanded,
xtd::forms::content_alignment align )

Initialises a new instance of horizontal 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.

◆ horizontal_control_layout_style() [23/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( float width,
bool expanded,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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.

◆ horizontal_control_layout_style() [24/24]

xtd::forms::horizontal_control_layout_style::horizontal_control_layout_style ( xtd::int32 width,
bool expanded,
xtd::forms::content_alignment align )

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

Parameters
widthThe preferred width, 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

◆ width() [1/2]

auto xtd::forms::horizontal_control_layout_style::width ( ) const -> std::optional< float >
nodiscardnoexcept

Gets the width value for a control.

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

◆ width() [2/2]

auto xtd::forms::horizontal_control_layout_style::width ( float value) -> horizontal_control_layout_style &

Sets the width value for a control.

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

◆ equals() [1/3]

auto xtd::forms::horizontal_control_layout_style::equals ( const horizontal_control_layout_style & other) const -> bool
nodiscardoverridenoexcept

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

auto xtd::forms::horizontal_control_layout_style::get_hash_code ( ) const -> xtd::usize
nodiscardoverridevirtualnoexcept

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

auto xtd::forms::horizontal_control_layout_style::to_string ( ) const -> xtd::string
nodiscardoverridevirtualnoexcept

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]

auto xtd::forms::control_layout_style::equals ( const xtd::object & obj) const -> bool
nodiscardoverridevirtualnoexcept

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]

auto xtd::forms::control_layout_style::equals ( const control_layout_style & other) const -> bool
nodiscardoverridenoexcept

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: