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/forms/application>
#include <xtd/forms/emoticons>
#include <xtd/forms/form>
#include <xtd/forms/label>
#include <xtd/forms/list_box>
 
using namespace xtd;
using namespace xtd::forms;
 
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().push_back({string::format("{} {}", emoticon, emoticon.name()), emoticon});
  emoticons_list_box.selected_value_changed += [&] {
    emoticon_label.text(as<emoticon>(emoticons_list_box.selected_item().tag()).to_string());
  };
  emoticons_list_box.selected_index(0);
  
  application::run(main_form);
}

Examples

emoticons.cpp.

Public Fields
static const emoticon	empty ()
	Represents an empty emoticon.

Public Methods
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.
bool	equals (const emoticon &value) const noexcept override
xtd::string	to_string () const noexcept override
	Returns a string containing the codepoints of the emoticons.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.

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

Public Properties
const xtd::string &	name () const noexcept
	Gets name of emoticon.
const std::vector< char32 > &	codepoints () const noexcept
	Gets codepoints of emoticon.

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::iequatable< emoticon >
virtual bool	equals (const emoticon &) 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

emoticon() [1/6]

xtd::forms::emoticon::emoticon	(	const xtd::string &	name,
		std::initializer_list< 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 std::vector< 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,
		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< 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 std::vector< 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 ( 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()

static const emoticon xtd::forms::emoticon::empty ( )

static

Represents an empty emoticon.

name()

const xtd::string & xtd::forms::emoticon::name ( ) const

noexcept

Gets name of emoticon.

Returns

A string that represent the name of emoticon.

Examples

emoticons.cpp.

codepoints()

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

noexcept

Gets codepoints of emoticon.

Returns

An array of char32 that represent the emoticon.

to_string()

xtd::string xtd::forms::emoticon::to_string ( ) const

overridevirtualnoexcept

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.

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/emoticon.h