xtd::forms::emoticon Class Reference

Inheritance diagram for xtd::forms::emoticon:

Definition

Represent a emoticon with name and codepoints.

Header

#include <xtd/forms/emoticon>

Namespace

xtd::forms

Library

xtd.forms

Examples

The following code example demonstrates the use of emoticon class.

#include <xtd/xtd>
 
auto main() -> int {
  auto main_form = form::create("Emoticons example");
  main_form.client_size({500, 400}).padding(10);
  
  auto emoticon_label = label::create(main_form, "");
  emoticon_label.text_align(xtd::forms::content_alignment::middle_center).dock(dock_style::fill).font({main_form.font(), 192});
  
  auto emoticons_list_box = list_box::create(main_form, list_box::object_collection {});
  emoticons_list_box.dock(dock_style::left).width(200);
  for (const auto& emoticon : emoticons::get_emoticons())
    emoticons_list_box.items().add({string::format("{} {}", emoticon, emoticon.name()), emoticon});
  emoticons_list_box.selected_value_changed += delegate_ {
    emoticon_label.text(as<emoticon>(emoticons_list_box.selected_item().tag()).to_string());
  };
  emoticons_list_box.selected_index(0);
  
  application::run(main_form);
}

Public Fields
static auto	empty () -> emoticon
	Represents an empty emoticon.

Public Constructors
	emoticon (const xtd::string &name, std::initializer_list< xtd::char32 > codepoints)
	Initialize a new instance of emoticon class with specified name and codepoints.
	emoticon (const xtd::string &name, const xtd::array< xtd::char32 > &codepoints)
	Initialize a new instance of emoticon class with specified name and codepoints.
	emoticon (const xtd::string &name, xtd::char32 codepoint)
	Initialize a new instance of emoticon class with specified name and codepoint.
	emoticon (std::initializer_list< xtd::char32 > codepoints)
	Initialize a new instance of emoticon class with specified codepoints.
	emoticon (const xtd::array< xtd::char32 > &codepoints)
	Initialize a new instance of emoticon class with specified codepoints.
	emoticon (xtd::char32 codepoint)
	Initialize a new instance of emoticon class with specified codepoint.

Public Properties
auto	name () const noexcept -> const xtd::string &
	Gets name of emoticon.
auto	codepoints () const noexcept -> xtd::array< xtd::char32 >
	Gets codepoints of emoticon.

Public Methods
auto	compare_to (const emoticon &obj) 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 emoticon &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 codepoints of the emoticons.

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

emoticon() [1/6]

xtd::forms::emoticon::emoticon	(	const xtd::string &	name,
		std::initializer_list< xtd::char32 >	codepoints )

Initialize a new instance of emoticon class with specified name and codepoints.

Parameters

name	A string that represent the name of emoticon
codepoints	An initializer list of char32 that represent the emoticon.

emoticon() [2/6]

xtd::forms::emoticon::emoticon	(	const xtd::string &	name,
		const xtd::array< xtd::char32 > &	codepoints )

Initialize a new instance of emoticon class with specified name and codepoints.

Parameters

name	A string that represent the name of emoticon
codepoints	An array of char32 that represent the emoticon.

emoticon() [3/6]

xtd::forms::emoticon::emoticon	(	const xtd::string &	name,
		xtd::char32	codepoint )

Initialize a new instance of emoticon class with specified name and codepoint.

Parameters

name	A string that represent the name of emoticon
codepoint	A char32 that represent the emoticon.

emoticon() [4/6]

xtd::forms::emoticon::emoticon ( std::initializer_list< xtd::char32 > codepoints )

explicit

Initialize a new instance of emoticon class with specified codepoints.

Parameters

codepoints

An initializer list of char32 that represent the emoticon.

emoticon() [5/6]

xtd::forms::emoticon::emoticon ( const xtd::array< xtd::char32 > & codepoints )

explicit

Initialize a new instance of emoticon class with specified codepoints.

Parameters

codepoints

An array of char32 that represent the emoticon.

emoticon() [6/6]

xtd::forms::emoticon::emoticon ( xtd::char32 codepoint )

explicit

Initialize a new instance of emoticon class with specified codepoint.

Parameters

codepoints

A char32 that represent the emoticon.

Member Function Documentation

empty()

auto xtd::forms::emoticon::empty ( ) -> emoticon

static

Represents an empty emoticon.

name()

auto xtd::forms::emoticon::name ( ) const -> const xtd::string &

nodiscardnoexcept

Gets name of emoticon.

Returns

A string that represent the name of emoticon.

codepoints()

auto xtd::forms::emoticon::codepoints ( ) const -> xtd::array< xtd::char32 >

nodiscardnoexcept

Gets codepoints of emoticon.

Returns

An array of char32 that represent the emoticon.

compare_to()

auto xtd::forms::emoticon::compare_to ( const emoticon & obj ) 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::emoticon::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::emoticon::equals ( const emoticon & 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::emoticon::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::emoticon::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a string containing the codepoints of the emoticons.

Returns

A string containing the codepoints of the emoticon. Empty string ("") for none codepoints.

Reimplemented from xtd::object.

---

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

• xtd.forms/include/xtd/forms/emoticon.hpp