xtd::forms::domain_up_down::item Class Reference

Inheritance diagram for xtd::forms::domain_up_down::item:

Definition

Represent an item contained in the domain_up_down::object_collection collection.

Public Constructors
	item ()=default
	Initializes a new instance of the item class.
	item (const xtd::string &value)
	Initializes a new instance of the item class with specified value.
	item (const xtd::string &value, const xtd::any_object &tag)
	Initializes a new instance of the item class with specified value and tag.

Public Properties
virtual auto	value () const noexcept -> const xtd::string &
	Gets the value of the item.
virtual auto	tag () const noexcept -> const xtd::any_object &
	Gets the tag of the item.

Public Methods
auto	compare_to (const item &value) const noexcept -> xtd::int32 override
	Compares the current instance with another object of the same type.
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const item &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 containing the vague of the item.

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	compare_to (const item &obj) const noexcept -> xtd::int32=0
	Compares the current instance with another object of the same type.
virtual auto	equals (const item &) 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

item() [1/3]

xtd::forms::domain_up_down::item::item ( )

default

Initializes a new instance of the item class.

item() [2/3]

xtd::forms::domain_up_down::item::item

(

const xtd::string &

value

)

Initializes a new instance of the item class with specified value.

Parameters

value

a string that represent the item.

item() [3/3]

xtd::forms::domain_up_down::item::item	(	const xtd::string &	value,
		const xtd::any_object &	tag )

Initializes a new instance of the item class with specified value and tag.

Parameters

value	a string that represent the item.
tag	an object that contains data about the item.

Member Function Documentation

value()

virtual auto xtd::forms::domain_up_down::item::value ( ) const -> const xtd::string &

nodiscardvirtualnoexcept

Gets the value of the item.

Returns

A xtd::string that represent the value of item.

tag()

virtual auto xtd::forms::domain_up_down::item::tag ( ) const -> const xtd::any_object &

virtualnoexcept

Gets the tag of the item.

Returns

A xtd::any_object that represent the tag of item.

compare_to()

auto xtd::forms::domain_up_down::item::compare_to ( const item & value ) const -> xtd::int32

nodiscardoverridenoexcept

Compares the current instance with another object of the same type.

Parameters

obj	An object to compare with this instance.

Returns

A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Condition
Less than zero	This instance is less than obj.
Zero	This instance is equal to obj.
Greater than zero	This instance is greater than obj.

equals() [1/2]

auto xtd::forms::domain_up_down::item::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::domain_up_down::item::equals ( const item & 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::domain_up_down::item::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::domain_up_down::item::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a string containing the vague of the item.

Returns

A string containing the value of the item.

Reimplemented from xtd::object.

---

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

• xtd.forms/include/xtd/forms/domain_up_down.hpp