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::ustring::empty_string and tag has no vlaue.

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

Public Properties
virtual const xtd::ustring &	value () const noexcept
	Gets the value of the item.
virtual std::any	tag () const noexcept
	Gets the tag of the item.

Public Methods
int32	compare_to (const item &value) const noexcept override
bool	equals (const item &value) const noexcept override
xtd::ustring	to_string () const noexcept override
	Returns a string containing the value of the item.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current 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 >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::icomparable< item >
virtual int32	compare_to (const item &obj) const noexcept=0
	Compares the current instance with another object of the same type.
Public Member Functions inherited from xtd::iequatable< item >
virtual bool	equals (const item &) 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
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &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::ustring &

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::ustring &	value,
		const std::any &	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

tag()

virtual std::any xtd::forms::list_control::item::tag ( ) const

virtualnoexcept

Gets the tag of the item.

Returns

A std::any that represent the tag of item.

to_string()

xtd::ustring 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.

value()

virtual const xtd::ustring & xtd::forms::list_control::item::value ( ) const

virtualnoexcept

Gets the value of the item.

Returns

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

Member Data Documentation

empty

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

static

Represents an empty item that value is equal to xtd::ustring::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.h