xtd 0.2.0
xtd::toolkit Class Reference

Definition

Represents a toolkit.

Namespace
xtd::forms
Library
xtd.forms

Constructors

 toolkit ()=default
 Initializes a new instance of the xtd::toolkit class. More...
 
 toolkit (const xtd::ustring &name, const xtd::version &version, const xtd::ustring &description)
 Initializes a new instance of the xtd::toolkit class with the specified name and version. More...
 

Properties

const xtd::ustringdescription () const noexcept
 Gets the toolkit description. More...
 
const xtd::ustringname () const noexcept
 Gets the toolkit name. More...
 
const xtd::versionversion () const noexcept
 Gets the toolkit version. More...
 

Methods

bool equals (const toolkit &other) const noexcept override
 Indicates whether the current object is equal to another object of the same type. More...
 
xtd::ustring to_string () const noexcept override
 Returns a sxd::ustring that represents the current object. More...
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
- Public Member Functions inherited from xtd::iequatable< toolkit >
- 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. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ toolkit() [1/2]

xtd::toolkit::toolkit ( )
default

Initializes a new instance of the xtd::toolkit class.

Remarks
The xtd::toolkit class is used by xtd::system_information::toolkit_version method.

◆ toolkit() [2/2]

xtd::toolkit::toolkit ( const xtd::ustring name,
const xtd::version version,
const xtd::ustring description 
)

Initializes a new instance of the xtd::toolkit class with the specified name and version.

Parameters
nameThe toolkit name.
versionThe toolkit version.
descriptionThe toolkit description.

Member Function Documentation

◆ description()

const xtd::ustring& xtd::toolkit::description ( ) const
noexcept

Gets the toolkit description.

Returns
The toolkit description.

◆ equals()

bool xtd::toolkit::equals ( const toolkit ) const
overridevirtualnoexcept

Indicates whether the current object is equal to another object of the same type.

Parameters
objAn object to compare with this object.
Returns
true if the current object is equal to the other parameter; otherwise, false.

Implements xtd::iequatable< toolkit >.

◆ name()

const xtd::ustring& xtd::toolkit::name ( ) const
noexcept

Gets the toolkit name.

Returns
The toolkit name.

◆ to_string()

xtd::ustring xtd::toolkit::to_string ( ) const
overridevirtualnoexcept

Returns a sxd::ustring that represents the current object.

Returns
A string that represents the current object.
Examples
The following code example demonstrates what to_string returns.

Reimplemented from xtd::object.

◆ version()

const xtd::version& xtd::toolkit::version ( ) const
noexcept

Gets the toolkit version.

Returns
The toolkit version.

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