xtd 1.0.0
Loading...
Searching...
No Matches
xtd::forms::button_images Class Referencefinal
Inheritance diagram for xtd::forms::button_images:
xtd::static_object

Definition

Provides a button images factories for use by a button control.

Header
#include <xtd/forms/button_images>
Namespace
xtd::forms
Library
xtd.forms

Static porperties

static auto add () -> xtd::drawing::image
 Add image object.
static auto add (const xtd::string &theme) -> xtd::drawing::image
 Add image object with specified theme.
static auto add (const xtd::drawing::size &size) -> xtd::drawing::image
 Add image object with specified size.
static auto add (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Add image object with specified theme and size.
static auto apply () -> xtd::drawing::image
 Apply image object.
static auto apply (const xtd::string &theme) -> xtd::drawing::image
 Apply image object with specified theme.
static auto apply (const xtd::drawing::size &size) -> xtd::drawing::image
 Apply image object with specified size.
static auto apply (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Apply image object with specified theme and size.
static auto ok () -> xtd::drawing::image
 Ok image object.
static auto ok (const xtd::string &theme) -> xtd::drawing::image
 Ok image object with specified theme.
static auto ok (const xtd::drawing::size &size) -> xtd::drawing::image
 Ok image object with specified size.
static auto ok (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Ok image object with specified theme and size.
static auto cancel () -> xtd::drawing::image
 Cancel image object.
static auto cancel (const xtd::string &theme) -> xtd::drawing::image
 Cancel image object with specified theme.
static auto cancel (const xtd::drawing::size &size) -> xtd::drawing::image
 Cancel image object with specified size.
static auto cancel (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Cancel image object with specified theme and size.
static auto next () -> xtd::drawing::image
 Next image object.
static auto next (const xtd::string &theme) -> xtd::drawing::image
 Next image object with specified theme.
static auto next (const xtd::drawing::size &size) -> xtd::drawing::image
 Next image object with specified size.
static auto next (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Next image object with specified theme and size.
static auto no () -> xtd::drawing::image
 No image object.
static auto no (const xtd::string &theme) -> xtd::drawing::image
 No image object with specified theme.
static auto no (const xtd::drawing::size &size) -> xtd::drawing::image
 No image object with specified size.
static auto no (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 No image object with specified theme and size.
static auto previous () -> xtd::drawing::image
 Previous image object.
static auto previous (const xtd::string &theme) -> xtd::drawing::image
 Previous image object with specified theme.
static auto previous (const xtd::drawing::size &size) -> xtd::drawing::image
 Previous image object with specified size.
static auto previous (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Previous image object with specified theme and size.
static auto remove () -> xtd::drawing::image
 Remove image object.
static auto remove (const xtd::string &theme) -> xtd::drawing::image
 Remove image object with specified theme.
static auto remove (const xtd::drawing::size &size) -> xtd::drawing::image
 Remove image object with specified size.
static auto remove (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Remove image object with specified theme and size.
static auto yes () -> xtd::drawing::image
 Yes image object.
static auto yes (const xtd::string &theme) -> xtd::drawing::image
 Yes image object with specified theme.
static auto yes (const xtd::drawing::size &size) -> xtd::drawing::image
 Yes image object with specified size.
static auto yes (const xtd::string &theme, const xtd::drawing::size &size) -> xtd::drawing::image
 Yes image object with specified theme and size.
static auto size () -> xtd::drawing::size
 Gets the height and width of the button images.

Public Static Methods

static auto from_name (const xtd::string &name) -> xtd::drawing::image
 Gets image object with specified name.
static auto from_name (const xtd::string &theme, const xtd::string &name) -> xtd::drawing::image
 Gets image object with specified theme and name.
static auto from_name (const xtd::string &name, const xtd::drawing::size &size) -> xtd::drawing::image
 Gets image object with specified name and size.
static auto from_name (const xtd::string &theme, const xtd::string &name, const xtd::drawing::size &size) -> xtd::drawing::image
 Gets image object with specified theme, name and size.

Member Function Documentation

◆ add() [1/4]

auto xtd::forms::button_images::add ( ) -> xtd::drawing::image
inlinestaticnodiscard

Add image object.

Returns
A xtd::drawing::image that represent "list-add".

◆ add() [2/4]

auto xtd::forms::button_images::add ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Add image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "list-add".

◆ add() [3/4]

auto xtd::forms::button_images::add ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Add image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "list-add".

◆ add() [4/4]

auto xtd::forms::button_images::add ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Add image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "list-add".

◆ apply() [1/4]

auto xtd::forms::button_images::apply ( ) -> xtd::drawing::image
inlinestaticnodiscard

Apply image object.

Returns
A xtd::drawing::image that represent "dialog-ok-apply".

◆ apply() [2/4]

auto xtd::forms::button_images::apply ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Apply image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "dialog-ok-apply".

◆ apply() [3/4]

auto xtd::forms::button_images::apply ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Apply image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok-apply".

◆ apply() [4/4]

auto xtd::forms::button_images::apply ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Apply image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok-apply".

◆ ok() [1/4]

auto xtd::forms::button_images::ok ( ) -> xtd::drawing::image
inlinestaticnodiscard

Ok image object.

Returns
A xtd::drawing::image that represent "dialog-ok".

◆ ok() [2/4]

auto xtd::forms::button_images::ok ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Ok image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ ok() [3/4]

auto xtd::forms::button_images::ok ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Ok image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ ok() [4/4]

auto xtd::forms::button_images::ok ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Ok image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ cancel() [1/4]

auto xtd::forms::button_images::cancel ( ) -> xtd::drawing::image
inlinestaticnodiscard

Cancel image object.

Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ cancel() [2/4]

auto xtd::forms::button_images::cancel ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Cancel image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ cancel() [3/4]

auto xtd::forms::button_images::cancel ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Cancel image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ cancel() [4/4]

auto xtd::forms::button_images::cancel ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Cancel image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ next() [1/4]

auto xtd::forms::button_images::next ( ) -> xtd::drawing::image
inlinestaticnodiscard

Next image object.

Returns
A xtd::drawing::image that represent "go-next".

◆ next() [2/4]

auto xtd::forms::button_images::next ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Next image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "go-next".

◆ next() [3/4]

auto xtd::forms::button_images::next ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Next image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "go-next".

◆ next() [4/4]

auto xtd::forms::button_images::next ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Next image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "go-next".

◆ no() [1/4]

auto xtd::forms::button_images::no ( ) -> xtd::drawing::image
inlinestaticnodiscard

No image object.

Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ no() [2/4]

auto xtd::forms::button_images::no ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

No image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ no() [3/4]

auto xtd::forms::button_images::no ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

No image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ no() [4/4]

auto xtd::forms::button_images::no ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

No image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-cancel".

◆ previous() [1/4]

auto xtd::forms::button_images::previous ( ) -> xtd::drawing::image
inlinestaticnodiscard

Previous image object.

Returns
A xtd::drawing::image that represent "go-previous".

◆ previous() [2/4]

auto xtd::forms::button_images::previous ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Previous image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "go-previous".

◆ previous() [3/4]

auto xtd::forms::button_images::previous ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Previous image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "go-previous".

◆ previous() [4/4]

auto xtd::forms::button_images::previous ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Previous image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "go-previous".

◆ remove() [1/4]

auto xtd::forms::button_images::remove ( ) -> xtd::drawing::image
inlinestaticnodiscard

Remove image object.

Returns
A xtd::drawing::image that represent "list-remove".

◆ remove() [2/4]

auto xtd::forms::button_images::remove ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Remove image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "list-remove".

◆ remove() [3/4]

auto xtd::forms::button_images::remove ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Remove image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "list-remove".

◆ remove() [4/4]

auto xtd::forms::button_images::remove ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Remove image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "list-remove".

◆ yes() [1/4]

auto xtd::forms::button_images::yes ( ) -> xtd::drawing::image
inlinestaticnodiscard

Yes image object.

Returns
A xtd::drawing::image that represent add.

◆ yes() [2/4]

auto xtd::forms::button_images::yes ( const xtd::string & theme) -> xtd::drawing::image
inlinestaticnodiscard

Yes image object with specified theme.

Parameters
themeA string that represent a theme
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ yes() [3/4]

auto xtd::forms::button_images::yes ( const xtd::drawing::size & size) -> xtd::drawing::image
inlinestaticnodiscard

Yes image object with specified size.

Parameters
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ yes() [4/4]

auto xtd::forms::button_images::yes ( const xtd::string & theme,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Yes image object with specified theme and size.

Parameters
themeA string that represent a theme
sizeA xtd::drawing::size size for the image
Returns
A xtd::drawing::image that represent "dialog-ok".

◆ size()

auto xtd::forms::button_images::size ( ) -> xtd::drawing::size
inlinestaticnodiscard

Gets the height and width of the button images.

Returns
The size that represents the height and width of the button images in pixels (16 x 16).

◆ from_name() [1/4]

auto xtd::forms::button_images::from_name ( const xtd::string & name) -> xtd::drawing::image
inlinestaticnodiscard

Gets image object with specified name.

Parameters
namethe image name to get.
Returns
A xtd::drawing::image that represent the specified name.
Remarks
Use xtd::drawing::system_images::context_names to get names by context.

◆ from_name() [2/4]

auto xtd::forms::button_images::from_name ( const xtd::string & theme,
const xtd::string & name ) -> xtd::drawing::image
inlinestaticnodiscard

Gets image object with specified theme and name.

Parameters
themethe theme name that contains the image to get.
namethe image name to get.
Returns
A xtd::drawing::image that represent the specified name.
Remarks
Use xtd::drawing::system_images::themes to get valid themes.
Use xtd::drawing::system_images::context_names to get valid names by context.

◆ from_name() [3/4]

auto xtd::forms::button_images::from_name ( const xtd::string & name,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Gets image object with specified name and size.

Parameters
namethe image name to get.
sizeThe size that represents the height and width of the button images in pixels.
Returns
A xtd::drawing::image that represent the specified name.
Remarks
Use xtd::drawing::system_images::themes to get valid themes.
Use xtd::drawing::system_images::context_names to get valid names by context.

◆ from_name() [4/4]

auto xtd::forms::button_images::from_name ( const xtd::string & theme,
const xtd::string & name,
const xtd::drawing::size & size ) -> xtd::drawing::image
inlinestaticnodiscard

Gets image object with specified theme, name and size.

Parameters
themethe theme name that contains the image to get.
namethe image name to get.
sizeThe size that represents the height and width of the button images in pixels.
Returns
A xtd::drawing::image that represent the specified name.
Remarks
Use xtd::drawing::system_images::themes to get valid themes.
Use xtd::drawing::system_images::context_names to get valid names by context.

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