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 | Protected Member Functions | List of all members
xtd::forms::control_layout_style Class Reference

#include <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

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...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represent xtd::forms::control_layout_style. 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...
 

Protected Member Functions

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

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

Constructor & Destructor Documentation

◆ control_layout_style() [1/8]

xtd::forms::control_layout_style::control_layout_style ( )
protecteddefault

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

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

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

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

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

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

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

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

◆ align() [1/2]

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

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

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.

◆ expanded() [1/2]

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

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

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

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

◆ size_type() [1/2]

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

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

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.

◆ to_string()

xtd::ustring xtd::forms::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::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: