xtd 0.2.0
xtd::forms::style_sheets::theme Class Reference

Definition

The theme data allows you to specify the theme informations.

class forms_export_ theme : public xtd::object
Inheritance
xtd::objectxtd::forms::style_sheets::theme
Header
#include <xtd/forms/style_sheets/theme>
Namespace
xtd::forms::style_sheets
Library
xtd.forms

Constructors

 theme ()=default
 Initializes a new instance of the xtd::forms::style_sheets::theme class. More...
 
 theme (const xtd::ustring &name)
 Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name. More...
 
 theme (const xtd::ustring &name, const xtd::ustring &description)
 Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name and description. More...
 
 theme (const xtd::ustring &name, const xtd::ustring &description, const xtd::ustring &authors)
 Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name, description and authors. More...
 
 theme (const xtd::ustring &name, const xtd::ustring &description, const xtd::ustring &authors, const xtd::uri &website)
 Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name, description, authors and website. More...
 

Properties

const xtd::ustringauthors () const noexcept
 Gets the theme authors. More...
 
void authors (const xtd::ustring &value) noexcept
 Sets the theme authors. More...
 
const xtd::ustringdescription () const noexcept
 Gets the theme name. More...
 
void description (const xtd::ustring &value) noexcept
 Sets the theme name. More...
 
const xtd::ustringname () const noexcept
 Gets the theme name. More...
 
void name (const xtd::ustring &value) noexcept
 Sets the theme name. More...
 
const xtd::uriwebsite () const noexcept
 Gets the theme website. More...
 
void website (const xtd::uri &value) noexcept
 Sets the theme website. More...
 

Methods

bool equals (const theme &other) const noexcept override
 
xtd::ustring to_string () const noexcept override
 Returns a sxd::ustring that represents the current object. More...
 
xtd::ustring to_css () const noexcept
 Return a xtd::string that represents the css format of the current xtd::forms::style_sheets::theme object. More...
 
static bool from_css (const xtd::ustring &css_text, theme &result)
 Creates a xtd::forms::style_sheets::theme object from the specified css text. More...
 
static theme parse (const xtd::ustring &text)
 Creates a xtd::forms::style_sheets::theme object from the specified text. More...
 
static bool try_parse (const xtd::ustring &text, theme &result) noexcept
 Creates a xtd::forms::style_sheets::theme object from the specified text. More...
 

Additional Inherited Members

- Public Member Functions inherited from xtd::iequatable< theme >
virtual bool equals (const theme &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type. More...
 
- 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...
 
- 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

◆ theme() [1/5]

xtd::forms::style_sheets::theme::theme ( )
default

Initializes a new instance of the xtd::forms::style_sheets::theme class.

◆ theme() [2/5]

xtd::forms::style_sheets::theme::theme ( const xtd::ustring name)
explicit

Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name.

Parameters
nameThe theme name.
nameThe theme description.
nameThe theme authors.

◆ theme() [3/5]

xtd::forms::style_sheets::theme::theme ( const xtd::ustring name,
const xtd::ustring description 
)

Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name and description.

Parameters
nameThe theme name.
nameThe theme description.
nameThe theme authors.

◆ theme() [4/5]

xtd::forms::style_sheets::theme::theme ( const xtd::ustring name,
const xtd::ustring description,
const xtd::ustring authors 
)

Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name, description and authors.

Parameters
nameThe theme name.
nameThe theme description.
nameThe theme authors.

◆ theme() [5/5]

xtd::forms::style_sheets::theme::theme ( const xtd::ustring name,
const xtd::ustring description,
const xtd::ustring authors,
const xtd::uri website 
)

Initializes a new instance of the xtd::forms::style_sheets::theme class with specified name, description, authors and website.

Parameters
nameThe theme name.
nameThe theme description.
nameThe theme authors.
nameThe theme website.

Member Function Documentation

◆ authors() [1/2]

const xtd::ustring& xtd::forms::style_sheets::theme::authors ( ) const
noexcept

Gets the theme authors.

Returns
The theme authors.

◆ authors() [2/2]

void xtd::forms::style_sheets::theme::authors ( const xtd::ustring value)
noexcept

Sets the theme authors.

Parameters
valueThe theme authors.

◆ description() [1/2]

const xtd::ustring& xtd::forms::style_sheets::theme::description ( ) const
noexcept

Gets the theme name.

Returns
The theme name.

◆ description() [2/2]

void xtd::forms::style_sheets::theme::description ( const xtd::ustring value)
noexcept

Sets the theme name.

Parameters
valueThe theme name.

◆ from_css()

static bool xtd::forms::style_sheets::theme::from_css ( const xtd::ustring css_text,
theme result 
)
static

Creates a xtd::forms::style_sheets::theme object from the specified css text.

Parameters
css_textA css xtd::ustring that represents a xtd::forms::style_sheets::theme object.
resultThe xtd::forms::style_sheets::theme class that this method creates.
Returns
true if succeed; otherwise false.

◆ name() [1/2]

const xtd::ustring& xtd::forms::style_sheets::theme::name ( ) const
noexcept

Gets the theme name.

Returns
The theme name.

◆ name() [2/2]

void xtd::forms::style_sheets::theme::name ( const xtd::ustring value)
noexcept

Sets the theme name.

Parameters
valueThe theme name.

◆ parse()

static theme xtd::forms::style_sheets::theme::parse ( const xtd::ustring text)
static

Creates a xtd::forms::style_sheets::theme object from the specified text.

Parameters
textA xtd::ustring that represents a xtd::forms::style_sheets::theme object.
Returns
The xtd::forms::style_sheets::theme class that this method creates.
Exceptions
xtd::argument_exceptionThe text is not a xtd::forms::style_sheets::theme object.

◆ to_css()

xtd::ustring xtd::forms::style_sheets::theme::to_css ( ) const
noexcept

Return a xtd::string that represents the css format of the current xtd::forms::style_sheets::theme object.

Returns
A xtd::string that represents the css format of the current xtd::forms::style_sheets::theme object.

◆ to_string()

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

◆ try_parse()

static bool xtd::forms::style_sheets::theme::try_parse ( const xtd::ustring text,
theme result 
)
staticnoexcept

Creates a xtd::forms::style_sheets::theme object from the specified text.

Parameters
textA xtd::ustring that represents a xtd::forms::style_sheets::theme object.
resultThe xtd::forms::style_sheets::theme class that this method creates.
Returns
true if succeed; otherwise false.

◆ website() [1/2]

const xtd::uri& xtd::forms::style_sheets::theme::website ( ) const
noexcept

Gets the theme website.

Returns
The theme website.

◆ website() [2/2]

void xtd::forms::style_sheets::theme::website ( const xtd::uri value)
noexcept

Sets the theme website.

Parameters
valueThe theme website.

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