Inheritance diagram for xtd::forms::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_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.

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

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

Additional Inherited Members
	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.
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.

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

◆ 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

expanded true 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

expanded	true if control expanded; otherwise false.
align	One 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_type	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.
expanded	true 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_type	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.
align	One 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_type	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.
expanded	true if control expanded; otherwise false.
align	One 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

expanded	true if control expanded; otherwise false.
align	One of the content_alignment values..

Member Function Documentation

◆ size_type() [1/2]

auto xtd::forms::control_layout_style::size_type ( ) const -> xtd::forms::size_type

nodiscardnoexcept

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]

auto xtd::forms::control_layout_style::size_type ( xtd::forms::size_type size_type ) -> control_layout_style &

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

Parameters

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

◆ expanded() [1/2]

auto xtd::forms::control_layout_style::expanded ( ) const -> bool

nodiscardnoexcept

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]

auto xtd::forms::control_layout_style::expanded ( bool expanded ) -> control_layout_style &

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

Parameters

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

◆ align() [1/2]

auto xtd::forms::control_layout_style::align ( ) const -> xtd::forms::content_alignment

nodiscardnoexcept

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]

auto xtd::forms::control_layout_style::align ( xtd::forms::content_alignment align ) -> control_layout_style &

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

Parameters

align One of the content_alignment values. The default is top_left.

Remarks: This property work only if expanded = false.

◆ equals() [1/2]

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

obj	The 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]

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

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

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

◆ to_string()

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

xtd.forms/include/xtd/forms/control_layout_style.hpp

Definition

Protected Constructors

Public Properties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ control_layout_style() [1/8]

◆ control_layout_style() [2/8]

◆ control_layout_style() [3/8]

◆ control_layout_style() [4/8]

◆ control_layout_style() [5/8]

◆ control_layout_style() [6/8]

◆ control_layout_style() [7/8]

◆ control_layout_style() [8/8]

Member Function Documentation

◆ size_type() [1/2]

◆ size_type() [2/2]

◆ expanded() [1/2]

◆ expanded() [2/2]

◆ align() [1/2]

◆ align() [2/2]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ to_string()