xtd::forms::list_control::item Class Reference

Inheritance diagram for xtd::forms::list_control::item:

Definition

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

Classes
class	sorter
	Represent the sorter class used by list_control::object_collection collection. More...

Public Fields
static const item	empty
	Represents an empty item that value is equal to xtd::string::empty_string and tag has no vlaue.

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 const xtd::string &	value () const noexcept
	Gets the value of the item.
virtual const xtd::any_object &	tag () const noexcept
	Gets the tag of the item.

Public Methods
int32	compare_to (const item &value) const noexcept override
	Compares the current instance with another object of the same type.
bool	equals (const xtd::object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const item &other) const noexcept override
	Determines whether the specified object is equal to the current object.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
xtd::string	to_string () const noexcept override
	Returns a string containing the value of the item.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual int32	compare_to (const item &obj) const noexcept=0
	Compares the current instance with another object of the same type.
virtual bool	equals (const item &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
template<class object_a_t, class 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<class object_a_t, class 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

item() [1/3]

xtd::forms::list_control::item::item ( )

default

Initializes a new instance of the item class.

item() [2/3]

xtd::forms::list_control::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::list_control::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 const xtd::string & xtd::forms::list_control::item::value ( ) const

virtualnoexcept

Gets the value of the item.

Returns

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

tag()

virtual const xtd::any_object & xtd::forms::list_control::item::tag ( ) const

virtualnoexcept

Gets the tag of the item.

Returns

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

compare_to()

int32 xtd::forms::list_control::item::compare_to ( const item & value ) const

overridenoexcept

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

Parameters

value

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]

bool xtd::forms::list_control::item::equals ( const xtd::object & obj ) const

overridevirtualnoexcept

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]

bool xtd::forms::list_control::item::equals ( const item & other ) const

overridenoexcept

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

xtd::size xtd::forms::list_control::item::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

to_string()

xtd::string xtd::forms::list_control::item::to_string ( ) const

overridevirtualnoexcept

Returns a string containing the value of the item.

Returns

A string containing the value of the item.

Reimplemented from xtd::object.

Member Data Documentation

empty

const item xtd::forms::list_control::item::empty

static

Represents an empty item that value is equal to xtd::string::empty_string and tag has no vlaue.

---

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

• xtd.forms/include/xtd/forms/list_control.hpp