Inheritance diagram for xtd::forms::style_sheets::lengths:

Definition

The length specifies the length of the borders.

class forms_export_ lengths : public xtd::iequatable<lengths>, public xtd::object

xtd::forms::style_sheets::lengths::lengths

lengths()=default

Initializes a new instance of the xtd::forms::style_sheets::lengths class.

xtd::iequatable

Defines a generalized method that a value type or class implements to create a type-specific method f...

Definition iequatable.hpp:23

xtd::object

Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....

Definition object.hpp:45

forms_export_

#define forms_export_

Define shared library export.

Definition forms_export.hpp:13

Inheritance: xtd::object → xtd::forms::style_sheets::lengths

Implements: xtd::iequatable <>

Header: #include <xtd/forms/style_sheets/lengths>

Namespace: xtd::forms::style_sheets

Library: xtd.forms

Public Fields
static const lengths	empty
	Provides a xtd::forms::style_sheets::lengths object with no xtd::forms::style_sheets::lengths.

Public Constructors
	lengths ()=default
	Initializes a new instance of the xtd::forms::style_sheets::lengths class.
	lengths (xtd::forms::style_sheets::length all)
	Initializes a new instance of the xtd::forms::style_sheets::lengths class using the supplied xtd::forms::style_sheets::lengths size for all edges.
	lengths (xtd::forms::style_sheets::length left, xtd::forms::style_sheets::length top, xtd::forms::style_sheets::length right, xtd::forms::style_sheets::length bottom)
	Initializes a new instance of the xtd::forms::style_sheets::lengths class using a separate xtd::forms::style_sheets::lengths size for each edge.

Peorperties
auto	all () const noexcept -> xtd::forms::style_sheets::length
	Gets the xtd::forms::style_sheets::lengths value for all the edges.
auto	all (xtd::forms::style_sheets::length all) noexcept -> void
	Sets the xtd::forms::style_sheets::lengths value for all the edges.
auto	bottom () const noexcept -> xtd::forms::style_sheets::length
	Gets the xtd::forms::style_sheets::lengths value for the bottom edge.
auto	bottom (xtd::forms::style_sheets::length bottom) noexcept -> void
	Sets the xtd::forms::style_sheets::lengths value for the bottom edge.
auto	left () const noexcept -> xtd::forms::style_sheets::length
	Gets the xtd::forms::style_sheets::lengths value for the left edge.
auto	left (xtd::forms::style_sheets::length left) noexcept -> void
	Sets the xtd::forms::style_sheets::lengths value for the left edge.
auto	right () const noexcept -> xtd::forms::style_sheets::length
	Gets the xtd::forms::style_sheets::lengths value for the right edge.
auto	right (xtd::forms::style_sheets::length right) noexcept -> void
	Sets the xtd::forms::style_sheets::lengths value for the right edge.
auto	top () const noexcept -> xtd::forms::style_sheets::length
	Gets the xtd::forms::style_sheets::lengths value for the top edge.
auto	top (xtd::forms::style_sheets::length top) noexcept -> void
	Sets the xtd::forms::style_sheets::lengths value for the top edge.

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 lengths &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 xtd::string that represents the current object.

Additional Inherited Members
virtual auto	equals (const lengths &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
	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.
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

◆ lengths() [1/3]

xtd::forms::style_sheets::lengths::lengths ( )

default

Initializes a new instance of the xtd::forms::style_sheets::lengths class.

◆ lengths() [2/3]

xtd::forms::style_sheets::lengths::lengths ( xtd::forms::style_sheets::length all )

explicit

Initializes a new instance of the xtd::forms::style_sheets::lengths class using the supplied xtd::forms::style_sheets::lengths size for all edges.

Parameters

all	The number of pixels to be used for xtd::forms::style_sheets::lengths for all edges.

Remarks: This constructor sets the right, left, bottom, top and all properties to the value of the all parameter.

◆ lengths() [3/3]

xtd::forms::style_sheets::lengths::lengths	(	xtd::forms::style_sheets::length	left,
		xtd::forms::style_sheets::length	top,
		xtd::forms::style_sheets::length	right,
		xtd::forms::style_sheets::length	bottom )

Initializes a new instance of the xtd::forms::style_sheets::lengths class using a separate xtd::forms::style_sheets::lengths size for each edge.

Parameters

left	The xtd::forms::style_sheets::lengths size, in pixels, for the left edge.
top	The xtd::forms::style_sheets::lengths size, in pixels, for the top edge.
right	The xtd::forms::style_sheets::lengths size, in pixels, for the right edge.
bottom	The xtd::forms::style_sheets::lengths size, in pixels, for the bottom edge.

Remarks: If all of the parameter values are equal, then the all property will reflect this common value.

Member Function Documentation

◆ all() [1/2]

auto xtd::forms::style_sheets::lengths::all ( ) const -> xtd::forms::style_sheets::length

nodiscardnoexcept

Gets the xtd::forms::style_sheets::lengths value for all the edges.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same xtd::forms::style_sheets::lengths value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::lengths values are not equal.

◆ all() [2/2]

auto xtd::forms::style_sheets::lengths::all ( xtd::forms::style_sheets::length all ) -> void

noexcept

Sets the xtd::forms::style_sheets::lengths value for all the edges.

Parameters

all	The xtd::forms::style_sheets::lengths, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same xtd::forms::style_sheets::lengths value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::lengths values are not equal.

◆ bottom() [1/2]

auto xtd::forms::style_sheets::lengths::bottom ( ) const -> xtd::forms::style_sheets::length

nodiscardnoexcept

Gets the xtd::forms::style_sheets::lengths value for the bottom edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ bottom() [2/2]

auto xtd::forms::style_sheets::lengths::bottom ( xtd::forms::style_sheets::length bottom ) -> void

noexcept

Sets the xtd::forms::style_sheets::lengths value for the bottom edge.

Parameters

bottom The xtd::forms::style_sheets::lengths, in pixels, for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ left() [1/2]

auto xtd::forms::style_sheets::lengths::left ( ) const -> xtd::forms::style_sheets::length

nodiscardnoexcept

Gets the xtd::forms::style_sheets::lengths value for the left edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the left edge.

Remarks: Setting this value can also alter the all property.

◆ left() [2/2]

auto xtd::forms::style_sheets::lengths::left ( xtd::forms::style_sheets::length left ) -> void

noexcept

Sets the xtd::forms::style_sheets::lengths value for the left edge.

Parameters

left	The xtd::forms::style_sheets::lengths, in pixels, for the left edge.

Remarks: Setting this value can also alter the all property.

◆ right() [1/2]

auto xtd::forms::style_sheets::lengths::right ( ) const -> xtd::forms::style_sheets::length

nodiscardnoexcept

Gets the xtd::forms::style_sheets::lengths value for the right edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the right edge.

Remarks: Setting this value can also alter the all property.

◆ right() [2/2]

auto xtd::forms::style_sheets::lengths::right ( xtd::forms::style_sheets::length right ) -> void

noexcept

Sets the xtd::forms::style_sheets::lengths value for the right edge.

Parameters

right The xtd::forms::style_sheets::lengths, in pixels, for the right edge.

Remarks: Setting this value can also alter the all property.

◆ top() [1/2]

auto xtd::forms::style_sheets::lengths::top ( ) const -> xtd::forms::style_sheets::length

nodiscardnoexcept

Gets the xtd::forms::style_sheets::lengths value for the top edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the top edge.

Remarks: Setting this value can also alter the all property.

◆ top() [2/2]

auto xtd::forms::style_sheets::lengths::top ( xtd::forms::style_sheets::length top ) -> void

noexcept

Sets the xtd::forms::style_sheets::lengths value for the top edge.

Parameters

top	The xtd::forms::style_sheets::lengths, in pixels, for the top edge.

Remarks: Setting this value can also alter the all property.

◆ equals() [1/2]

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

◆ equals() [2/2]

auto xtd::forms::style_sheets::lengths::equals ( const lengths & 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::style_sheets::lengths::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.

◆ to_string()

auto xtd::forms::style_sheets::lengths::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a xtd::string that represents the current object.

Returns: A string that represents the current object.

Examples: The following code example demonstrates what to_string returns.
#include <xtd/xtd>

namespace examples {

namespace object_test {

class object1 : public object {

};

}

}

auto main() -> int {

ptr<object> obj1 = new_ptr<examples::object_test::object1>();

console::write_line(obj1->to_string());

ptr<object> obj2 = new_ptr<date_time>(1971, 1, 5, 23, 5, 0);

console::write_line(obj2->to_string());

ptr<object> obj3 = new_ptr<boolean_object>();

console::write_line(obj3->to_string());

}

// This code produces the following output :

//

// examples::object_test::object1

// Tue Jan 5 23:05:00 1971

// false

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

xtd::object::object
object()=default
Create a new instance of the ultimate base class object.

xtd::ptr
xtd::sptr< type_t > ptr
The xtd::ptr object is a shared pointer.
Definition ptr.hpp:27

xtd::new_ptr
auto new_ptr(args_t &&... args) -> xtd::ptr< type_t >
The xtd::new_ptr operator creates a xtd::ptr object.
Definition new_ptr.hpp:24

Reimplemented from xtd::object.

Member Data Documentation

◆ empty

const lengths xtd::forms::style_sheets::lengths::empty

static

Provides a xtd::forms::style_sheets::lengths object with no xtd::forms::style_sheets::lengths.

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

xtd.forms/include/xtd/forms/style_sheets/lengths.hpp

Definition

Public Fields

Public Constructors

Peorperties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ lengths() [1/3]

◆ lengths() [2/3]

◆ lengths() [3/3]

Member Function Documentation

◆ all() [1/2]

◆ all() [2/2]

◆ bottom() [1/2]

◆ bottom() [2/2]

◆ left() [1/2]

◆ left() [2/2]

◆ right() [1/2]

◆ right() [2/2]

◆ top() [1/2]

◆ top() [2/2]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ to_string()

Member Data Documentation

◆ empty