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 std::any &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 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::string	to_string () const noexcept override
	Returns a string containing the vague of the item.
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::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
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

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

value()

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

virtualnoexcept

Gets the value of the item.

Returns

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

tag()

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

virtualnoexcept

Gets the tag of the item.

Returns

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

to_string()

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

overridevirtualnoexcept

Returns a string containing the vague of the item.

Returns

A string containing the value of the item.

Reimplemented from xtd::object.

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

Reimplemented from xtd::object.

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

---

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

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