Definition

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

Header: #include <xtd/forms/button_images>

Namespace: xtd::forms

Library: xtd.forms

Methods
static xtd::drawing::image	add ()
	Add image object. More...

static xtd::drawing::image	add (const xtd::ustring &theme)
	Add image object with specified theme. More...

static xtd::drawing::image	add (const xtd::drawing::size &size)
	Add image object with specified size. More...

static xtd::drawing::image	add (const xtd::ustring &theme, const xtd::drawing::size &size)
	Add image object with specified theme and size. More...

static xtd::drawing::image	apply ()
	Apply image object. More...

static xtd::drawing::image	apply (const xtd::ustring &theme)
	Apply image object with specified theme. More...

static xtd::drawing::image	apply (const xtd::drawing::size &size)
	Apply image object with specified size. More...

static xtd::drawing::image	apply (const xtd::ustring &theme, const xtd::drawing::size &size)
	Apply image object with specified theme and size. More...

static xtd::drawing::image	ok ()
	Ok image object. More...

static xtd::drawing::image	ok (const xtd::ustring &theme)
	Ok image object with specified theme. More...

static xtd::drawing::image	ok (const xtd::drawing::size &size)
	Ok image object with specified size. More...

static xtd::drawing::image	ok (const xtd::ustring &theme, const xtd::drawing::size &size)
	Ok image object with specified theme and size. More...

static xtd::drawing::image	cancel ()
	Cancel image object. More...

static xtd::drawing::image	cancel (const xtd::ustring &theme)
	Cancel image object with specified theme. More...

static xtd::drawing::image	cancel (const xtd::drawing::size &size)
	Cancel image object with specified size. More...

static xtd::drawing::image	cancel (const xtd::ustring &theme, const xtd::drawing::size &size)
	Cancel image object with specified theme and size. More...

static xtd::drawing::image	next ()
	Next image object. More...

static xtd::drawing::image	next (const xtd::ustring &theme)
	Next image object with specified theme. More...

static xtd::drawing::image	next (const xtd::drawing::size &size)
	Next image object with specified size. More...

static xtd::drawing::image	next (const xtd::ustring &theme, const xtd::drawing::size &size)
	Next image object with specified theme and size. More...

static xtd::drawing::image	no ()
	No image object. More...

static xtd::drawing::image	no (const xtd::ustring &theme)
	No image object with specified theme. More...

static xtd::drawing::image	no (const xtd::drawing::size &size)
	No image object with specified size. More...

static xtd::drawing::image	no (const xtd::ustring &theme, const xtd::drawing::size &size)
	No image object with specified theme and size. More...

static xtd::drawing::image	previous ()
	Previous image object. More...

static xtd::drawing::image	previous (const xtd::ustring &theme)
	Previous image object with specified theme. More...

static xtd::drawing::image	previous (const xtd::drawing::size &size)
	Previous image object with specified size. More...

static xtd::drawing::image	previous (const xtd::ustring &theme, const xtd::drawing::size &size)
	Previous image object with specified theme and size. More...

static xtd::drawing::image	remove ()
	Remove image object. More...

static xtd::drawing::image	remove (const xtd::ustring &theme)
	Remove image object with specified theme. More...

static xtd::drawing::image	remove (const xtd::drawing::size &size)
	Remove image object with specified size. More...

static xtd::drawing::image	remove (const xtd::ustring &theme, const xtd::drawing::size &size)
	Remove image object with specified theme and size. More...

static xtd::drawing::image	yes ()
	Yes image object. More...

static xtd::drawing::image	yes (const xtd::ustring &theme)
	Yes image object with specified theme. More...

static xtd::drawing::image	yes (const xtd::drawing::size &size)
	Yes image object with specified size. More...

static xtd::drawing::image	yes (const xtd::ustring &theme, const xtd::drawing::size &size)
	Yes image object with specified theme and size. More...

static xtd::drawing::size	size ()
	Gets the height and width of the button images. More...

static xtd::drawing::image	from_name (const xtd::ustring &name)
	Gets image object with specified name. More...

static xtd::drawing::image	from_name (const xtd::ustring &theme, const xtd::ustring &name)
	Gets image object with specified theme and name. More...

static xtd::drawing::image	from_name (const xtd::ustring &name, const xtd::drawing::size &size)
	Gets image object with specified name and size. More...

static xtd::drawing::image	from_name (const xtd::ustring &theme, const xtd::ustring &name, const xtd::drawing::size &size)
	Gets image object with specified theme, name and size. More...

Member Function Documentation

◆ add() [1/4]

static xtd::drawing::image xtd::forms::button_images::add ( )

inlinestatic

Add image object.

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

Examples:: button_images.cpp.

◆ add() [2/4]

static xtd::drawing::image xtd::forms::button_images::add ( const xtd::ustring & theme )

inlinestatic

Add image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ add() [3/4]

static xtd::drawing::image xtd::forms::button_images::add ( const xtd::drawing::size & size )

inlinestatic

Add image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ add() [4/4]

static xtd::drawing::image xtd::forms::button_images::add	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Add image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ apply() [1/4]

static xtd::drawing::image xtd::forms::button_images::apply ( )

inlinestatic

Apply image object.

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

Examples:: button_images.cpp.

◆ apply() [2/4]

static xtd::drawing::image xtd::forms::button_images::apply ( const xtd::ustring & theme )

inlinestatic

Apply image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ apply() [3/4]

static xtd::drawing::image xtd::forms::button_images::apply ( const xtd::drawing::size & size )

inlinestatic

Apply image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ apply() [4/4]

static xtd::drawing::image xtd::forms::button_images::apply	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Apply image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ cancel() [1/4]

static xtd::drawing::image xtd::forms::button_images::cancel ( )

inlinestatic

Cancel image object.

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

Examples:: button_images.cpp.

◆ cancel() [2/4]

static xtd::drawing::image xtd::forms::button_images::cancel ( const xtd::ustring & theme )

inlinestatic

Cancel image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ cancel() [3/4]

static xtd::drawing::image xtd::forms::button_images::cancel ( const xtd::drawing::size & size )

inlinestatic

Cancel image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ cancel() [4/4]

static xtd::drawing::image xtd::forms::button_images::cancel	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Cancel image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ from_name() [1/4]

static xtd::drawing::image xtd::forms::button_images::from_name ( const xtd::ustring & name )

inlinestatic

Gets image object with specified name.

Parameters

name	the 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.

Examples:: button_images.cpp, system_sound.cpp, and track_bar2.cpp.

◆ from_name() [2/4]

static xtd::drawing::image xtd::forms::button_images::from_name	(	const xtd::ustring &	theme,
		const xtd::ustring &	name
	)

inlinestatic

Gets image object with specified theme and name.

Parameters

theme	the theme name that contains the image to get.
name	the 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]

static xtd::drawing::image xtd::forms::button_images::from_name	(	const xtd::ustring &	name,
		const xtd::drawing::size &	size
	)

inlinestatic

Gets image object with specified name and size.

Parameters

name	the image name to get.
size	The 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]

static xtd::drawing::image xtd::forms::button_images::from_name	(	const xtd::ustring &	theme,
		const xtd::ustring &	name,
		const xtd::drawing::size &	size
	)

inlinestatic

Gets image object with specified theme, name and size.

Parameters

theme	the theme name that contains the image to get.
name	the image name to get.
size	The 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.

◆ next() [1/4]

static xtd::drawing::image xtd::forms::button_images::next ( )

inlinestatic

Next image object.

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

Examples:: button_images.cpp.

◆ next() [2/4]

static xtd::drawing::image xtd::forms::button_images::next ( const xtd::ustring & theme )

inlinestatic

Next image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ next() [3/4]

static xtd::drawing::image xtd::forms::button_images::next ( const xtd::drawing::size & size )

inlinestatic

Next image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ next() [4/4]

static xtd::drawing::image xtd::forms::button_images::next	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Next image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ no() [1/4]

static xtd::drawing::image xtd::forms::button_images::no ( )

inlinestatic

No image object.

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

Examples:: button_images.cpp.

◆ no() [2/4]

static xtd::drawing::image xtd::forms::button_images::no ( const xtd::ustring & theme )

inlinestatic

No image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ no() [3/4]

static xtd::drawing::image xtd::forms::button_images::no ( const xtd::drawing::size & size )

inlinestatic

No image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ no() [4/4]

static xtd::drawing::image xtd::forms::button_images::no	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

No image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ ok() [1/4]

static xtd::drawing::image xtd::forms::button_images::ok ( )

inlinestatic

Ok image object.

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

Examples:: button_images.cpp.

◆ ok() [2/4]

static xtd::drawing::image xtd::forms::button_images::ok ( const xtd::ustring & theme )

inlinestatic

Ok image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ ok() [3/4]

static xtd::drawing::image xtd::forms::button_images::ok ( const xtd::drawing::size & size )

inlinestatic

Ok image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ ok() [4/4]

static xtd::drawing::image xtd::forms::button_images::ok	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Ok image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ previous() [1/4]

static xtd::drawing::image xtd::forms::button_images::previous ( )

inlinestatic

Previous image object.

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

Examples:: button_images.cpp.

◆ previous() [2/4]

static xtd::drawing::image xtd::forms::button_images::previous ( const xtd::ustring & theme )

inlinestatic

Previous image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ previous() [3/4]

static xtd::drawing::image xtd::forms::button_images::previous ( const xtd::drawing::size & size )

inlinestatic

Previous image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ previous() [4/4]

static xtd::drawing::image xtd::forms::button_images::previous	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Previous image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ remove() [1/4]

static xtd::drawing::image xtd::forms::button_images::remove ( )

inlinestatic

Remove image object.

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

Examples:: button_images.cpp.

◆ remove() [2/4]

static xtd::drawing::image xtd::forms::button_images::remove ( const xtd::ustring & theme )

inlinestatic

Remove image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ remove() [3/4]

static xtd::drawing::image xtd::forms::button_images::remove ( const xtd::drawing::size & size )

inlinestatic

Remove image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ remove() [4/4]

static xtd::drawing::image xtd::forms::button_images::remove	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Remove image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

◆ size()

static xtd::drawing::size xtd::forms::button_images::size ( )

inlinestatic

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).

◆ yes() [1/4]

static xtd::drawing::image xtd::forms::button_images::yes ( )

inlinestatic

Yes image object.

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

Examples:: button_images.cpp.

◆ yes() [2/4]

static xtd::drawing::image xtd::forms::button_images::yes ( const xtd::ustring & theme )

inlinestatic

Yes image object with specified theme.

Parameters

theme A string that represent a theme

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

◆ yes() [3/4]

static xtd::drawing::image xtd::forms::button_images::yes ( const xtd::drawing::size & size )

inlinestatic

Yes image object with specified size.

Parameters

size	A xtd::drawing::size size for the image

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

◆ yes() [4/4]

static xtd::drawing::image xtd::forms::button_images::yes	(	const xtd::ustring &	theme,
		const xtd::drawing::size &	size
	)

inlinestatic

Yes image object with specified theme and size.

Parameters

theme	A string that represent a theme
size	A xtd::drawing::size size for the image

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

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

xtd.forms/include/xtd/forms/button_images.h

Definition

Methods

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ apply() [1/4]

◆ apply() [2/4]

◆ apply() [3/4]

◆ apply() [4/4]

◆ cancel() [1/4]

◆ cancel() [2/4]

◆ cancel() [3/4]

◆ cancel() [4/4]

◆ from_name() [1/4]

◆ from_name() [2/4]

◆ from_name() [3/4]

◆ from_name() [4/4]

◆ next() [1/4]

◆ next() [2/4]

◆ next() [3/4]

◆ next() [4/4]

◆ no() [1/4]

◆ no() [2/4]

◆ no() [3/4]

◆ no() [4/4]

◆ ok() [1/4]

◆ ok() [2/4]

◆ ok() [3/4]

◆ ok() [4/4]

◆ previous() [1/4]

◆ previous() [2/4]

◆ previous() [3/4]

◆ previous() [4/4]

◆ remove() [1/4]

◆ remove() [2/4]

◆ remove() [3/4]

◆ remove() [4/4]

◆ size()

◆ yes() [1/4]

◆ yes() [2/4]

◆ yes() [3/4]

◆ yes() [4/4]