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

Definition

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

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

Protected Constructors

 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.
 

Public Properties

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.
 

Public Methods

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

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ control_layout_style() [1/8]

xtd::forms::control_layout_style::control_layout_style ( )
protected

Initialises a new instance of control layout style class.

◆ control_layout_style() [2/8]

xtd::forms::control_layout_style::control_layout_style ( xtd::forms::size_type  size_type)
explicitprotected

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

◆ control_layout_style() [3/8]

xtd::forms::control_layout_style::control_layout_style ( bool  expanded)
explicitprotected

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

Parameters
expandedtrue if control expanded; otherwise false.

◆ control_layout_style() [4/8]

xtd::forms::control_layout_style::control_layout_style ( xtd::forms::content_alignment  align)
explicitprotected

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

Parameters
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values..

◆ control_layout_style() [5/8]

xtd::forms::control_layout_style::control_layout_style ( xtd::forms::size_type  size_type,
bool  expanded 
)
protected

Initialises a new instance of 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.
expandedtrue if control expanded; otherwise false.

◆ control_layout_style() [6/8]

xtd::forms::control_layout_style::control_layout_style ( xtd::forms::size_type  size_type,
xtd::forms::content_alignment  align 
)
protected

Initialises a new instance of 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.
alignOne of the content_alignment values.

◆ control_layout_style() [7/8]

xtd::forms::control_layout_style::control_layout_style ( xtd::forms::size_type  size_type,
bool  expanded,
xtd::forms::content_alignment  align 
)
protected

Initialises a new instance of 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.
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values.

◆ control_layout_style() [8/8]

xtd::forms::control_layout_style::control_layout_style ( bool  expanded,
xtd::forms::content_alignment  align 
)
protected

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

Parameters
expandedtrue if control expanded; otherwise false.
alignOne of the content_alignment values..

Member Function Documentation

◆ size_type() [1/2]

xtd::forms::size_type xtd::forms::control_layout_style::size_type ( ) const
noexcept

Gets a flag indicating how a control should be sized relative to its containing layout container.

Returns
One 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::absolute.

◆ size_type() [2/2]

control_layout_style & xtd::forms::control_layout_style::size_type ( xtd::forms::size_type  size_type)

Sets a flag indicating how a control should be sized relative to its containing layout container.

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

◆ expanded() [1/2]

bool xtd::forms::control_layout_style::expanded ( ) const
noexcept

Gets a flag indicating if control is expanded to its containing layout container.

Returns
true if control expanded; otherwise false. The default is false.

◆ expanded() [2/2]

control_layout_style & xtd::forms::control_layout_style::expanded ( bool  expanded)

Sets a flag indicating if control is expanded to its containing layout container.

Parameters
expandedtrue if control expanded; otherwise false. The default is false.

◆ align() [1/2]

xtd::forms::content_alignment xtd::forms::control_layout_style::align ( ) const
noexcept

Gets a flag indicating how a control should be align to its containing layout container.

Returns
align One of the content_alignment values. The default is top_left.
Remarks
This property work only if expanded = false.

◆ align() [2/2]

control_layout_style & xtd::forms::control_layout_style::align ( xtd::forms::content_alignment  align)

Sets a flag indicating how a control should be align to its containing layout container.

Parameters
alignOne of the content_alignment values. The default is top_left.
Remarks
This property work only if expanded = false.

◆ equals() [1/2]

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

Reimplemented in xtd::forms::horizontal_control_layout_style, and xtd::forms::vertical_control_layout_style.

◆ equals() [2/2]

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.

◆ get_hash_code()

xtd::size xtd::forms::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::object.

Reimplemented in xtd::forms::horizontal_control_layout_style, and xtd::forms::vertical_control_layout_style.

◆ to_string()

xtd::string xtd::forms::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::object.

Reimplemented in xtd::forms::horizontal_control_layout_style, and xtd::forms::vertical_control_layout_style.


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