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

bool	expanded () const noexcept
	Gets a flag indicating if control is expanded to its containing layout container.

control_layout_style &	expanded (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_style &	align (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 control_layout_style &value) const noexcept override

xtd::string	to_string () const noexcept override
	Returns a string that represent xtd::forms::control_layout_style.

virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.

template<typename object_a_t , typename 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.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.

virtual type_object	get_type () const noexcept
	Gets the type of the current instance.

template<typename 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<typename object_a_t , typename 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<typename object_a_t , typename 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_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]

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_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]

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

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

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

Remarks: This property work only if expanded = false.

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

◆ equals() [1/2]

virtual bool xtd::object::equals ( const object & obj ) const

virtualnoexcept

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.

Examples: The following code example compares the current instance with another object.
#include <xtd/console>

using namespace xtd;

auto main() -> int {

auto object1 = new_ptr<object>();

auto object2 = new_ptr<object>();

auto object3 = object2;

console::write_line(object1->equals(*object3));

console::write_line(*object1 == *object3);

object3 = object1;

console::write_line(object1->equals(*object3));

console::write_line(*object1 == *object3);

}

// This code produces the following output :

//

// false

// false

// true

// true

xtd::console::write_line
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.hpp:10

Reimplemented from xtd::object.

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

◆ equals() [2/2]

template<typename object_a_t , typename object_b_t >

static bool xtd::object::equals	(	const object_a_t &	object_a,
		const object_b_t &	object_b
	)

inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters

object_a	The first object to compare.
object_b	The second object to compare.

Returns: true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.

Examples: The following code example compares different objects.
#include <xtd/console>

using namespace xtd;

auto main() -> int {

string s1 = "Tom";

string s2 = "Carol";

console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));

s1 = "Tom";

s2 = "Tom";

console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));

s1 = "";

s2 = "Tom";

console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));

s1 = "Carol";

s2 = "";

console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));

s1 = "";

s2 = "";

console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));

}

// This code produces the following output :

//

// object::equals("Tom", "Carol") => false

// object::equals("Tom", "Tom") => true

// object::equals("", "Tom") => false

// object::equals("Carol", "") => false

// object::equals("", "") => true

xtd::object::equals
virtual bool equals(const object &obj) const noexcept
Determines whether the specified object is equal to the current object.

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]

◆ to_string()

◆ equals() [1/2]

◆ equals() [2/2]