xtd::drawing::icon Class Reference

Inheritance diagram for xtd::drawing::icon:

Definition

Represents a Windows icon, which is a small bitmap image that is used to represent an object. Icons can be thought of as transparent bitmaps, although their size is determined by the system.

class drawing_export_ icon : public xtd::object

Inheritance

xtd::object → xtd::drawing::icon

Namespace

xtd::drawing

Library

xtd.drawing

Examples

minesweeper.cpp, and stopwatch_form.cpp.

Fileds
static icon	empty

Public Constructors
	icon (const xtd::string &filename)
	Initializes a new instance of the xtd::drawing::icon class from the specified file name.
	icon (const xtd::string &filename, const xtd::drawing::size &size)
	Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified file.
	icon (const xtd::string &filename, int32 width, int32 height)
	Initializes a new instance of the xtd::drawing::icon class with the specified width and height from the specified file.
	icon (std::istream &stream)
	Initializes a new instance of the xtd::drawing::icon class from the specified data stream.
	icon (std::istream &stream, const xtd::drawing::size &size)
	Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified stream.
	icon (std::istream &stream, int32 width, int32 height)
	Initializes a new instance of the xtd::drawing::icon class from the specified data stream and with the specified width and height.
	icon (const char *const *bits)
	Initializes a new instance of the xtd::drawing::icon class from the specified data.
	icon (const char *const *bits, const xtd::drawing::size &size)
	Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified data.
	icon (const char *const *bits, int32 width, int32 height)
	Initializes a new instance of the xtd::drawing::icon class from the specified data and with the specified width and height.
	icon (const icon &original, const xtd::drawing::size &size)
	Initializes a new instance of the xtd::drawing::icon class and attempts to find a version of the icon that matches the requested size.
	icon (const icon &original, int32 width, int32 height)
	Initializes a new instance of the xtd::drawing::icon class and attempts to find a version of the icon that matches the requested size.

Public Properties
intptr	handle () const noexcept
	Gets the handle of this icon. This is not a copy of the handle; do not free it.
int32	height () const noexcept
	Gets the height of this xtd::drawing::icon.
const xtd::drawing::size &	size () const noexcept
	Gets the size of this xtd::drawing::icon.
int32	width () const noexcept
	Gets the width of this xtd::drawing::icon.

Public Methods
bool	equals (const object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const icon &other) const noexcept override
	Indicates whether the current object is equal to another object of the same type.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
void	save (const xtd::string &filename) const
	Saves this xtd::drawing::icon to the specified output filename.
void	save (std::ostream &stream) const
	Saves this xtd::drawing::icon to the specified output std::ostream.
xtd::drawing::bitmap	to_bitmap () const
	Converts this xtd::drawing::icon to a GDI+ xtd::drawing::bitmap.
xtd::string	to_string () const noexcept override
	Gets a human-readable string that describes the xtd::drawing::icon.

Public Static Methods
static icon	from_bitmap (const xtd::drawing::bitmap &bitmap)
	Creates a GDI+ xtd::drawing::icon from the specified bitmap.
static icon	from_handle (intptr handle)
	Creates a GDI+ xtd::drawing::icon from the specified Windows handle to an icon (HICON).

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< icon >
virtual bool	equals (const icon &) 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<class object_a_t , class 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<class object_a_t , class 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

icon() [1/11]

xtd::drawing::icon::icon ( const xtd::string &  filename )

explicit

Initializes a new instance of the xtd::drawing::icon class from the specified file name.

Parameters

filename

The file to load the xtd::drawing::icon from.

Remarks

An icon resource can contain multiple icon images. One icon file may contain images in several sizes and color depths. The image that is used in an application depends on the operating system and settings. The following list details the typical sizes for an icon:

• 16 pixels x 16 pixels
• 32 pixels x 32 pixels
• 48 pixels x 48 pixels

This constructor returns the smallest image that is contained in the specified file.

icon() [2/11]

xtd::drawing::icon::icon	(	const xtd::string &	filename,
		const xtd::drawing::size &	size
	)

Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified file.

Parameters

filename	The file to load the xtd::drawing::icon from.
size	The desired size of the icon.

Remarks

If the specified file does not contain an image that matches the desired size, the icon that has the closest size is returned.

The filename should include the complete path if it is not in the current application directory.

icon() [3/11]

xtd::drawing::icon::icon	(	const xtd::string &	filename,
		int32	width,
		int32	height
	)

Initializes a new instance of the xtd::drawing::icon class with the specified width and height from the specified file.

Parameters

filename	The file to load the xtd::drawing::icon from.
width	The desired width of the xtd::drawing::icon.
height	The desired height of the xtd::drawing::icon.

Remarks

If the specified file does not contain an image that matches the desired height and width, the icon that has the closest size is returned.

The filename should include the complete path if it is not in the current application directory.

icon() [4/11]

xtd::drawing::icon::icon ( std::istream &  stream )

explicit

Initializes a new instance of the xtd::drawing::icon class from the specified data stream.

Parameters

stream

The data stream from which to load the xtd::drawing::icon.

Remarks

An icon resource can contain multiple icon images. One icon file may contain images in several sizes and color depths. The image that is used in an application depends on the operating system and settings. The following list details the typical sizes for an icon:

• 16 pixels x 16 pixels
• 32 pixels x 32 pixels
• 48 pixels x 48 pixels

This constructor returns the smallest image that is contained in the specified stream.

icon() [5/11]

xtd::drawing::icon::icon	(	std::istream &	stream,
		const xtd::drawing::size &	size
	)

Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified stream.

Parameters

stream	The data stream from which to load the xtd::drawing::icon.
size	The desired size of the icon.

icon() [6/11]

xtd::drawing::icon::icon	(	std::istream &	stream,
		int32	width,
		int32	height
	)

Initializes a new instance of the xtd::drawing::icon class from the specified data stream and with the specified width and height.

Parameters

stream	The data stream from which to load the xtd::drawing::icon.
width	The width, in pixels, of the icon.
height	The height, in pixels, of the icon.

icon() [7/11]

xtd::drawing::icon::icon ( const char *const *  bits )

explicit

Initializes a new instance of the xtd::drawing::icon class from the specified data.

Parameters

stream

The data stream from which to load the xtd::drawing::icon.

Remarks

An icon resource can contain multiple icon images. One icon file may contain images in several sizes and color depths. The image that is used in an application depends on the operating system and settings. The following list details the typical sizes for an icon:

• 16 pixels x 16 pixels
• 32 pixels x 32 pixels
• 48 pixels x 48 pixels

This constructor returns the smallest image that is contained in the specified data.

This constructor is used for creating a xtd::drawing::icon from an xpm (or xbm) image.

icon() [8/11]

xtd::drawing::icon::icon	(	const char *const *	bits,
		const xtd::drawing::size &	size
	)

Initializes a new instance of the xtd::drawing::icon class of the specified size from the specified data.

Parameters

stream	The data stream from which to load the xtd::drawing::icon.
size	The desired size of the icon.

Remarks

This constructor is used for creating a xtd::drawing::icon from an xpm (or xbm) image.

icon() [9/11]

xtd::drawing::icon::icon	(	const char *const *	bits,
		int32	width,
		int32	height
	)

Initializes a new instance of the xtd::drawing::icon class from the specified data and with the specified width and height.

Parameters

stream	The data stream from which to load the xtd::drawing::icon.
width	The width, in pixels, of the icon.
height	The height, in pixels, of the icon.

Remarks

This constructor is used for creating a xtd::drawing::icon from an xpm (or xbm) image.

icon() [10/11]

xtd::drawing::icon::icon	(	const icon &	original,
		const xtd::drawing::size &	size
	)

Initializes a new instance of the xtd::drawing::icon class and attempts to find a version of the icon that matches the requested size.

Parameters

original	The xtd::drawing::icon from which to load the newly sized icon.
size	A xtd::drawing::size structure that specifies the height and width of the new xtd::drawing::icon.

Remarks

If a version cannot be found that exactly matches the size, the closest match is used. If the original parameter is an xtd::drawing::icon that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the xtd::graphics::drawing::draw_image method to resize the icon.

icon() [11/11]

xtd::drawing::icon::icon	(	const icon &	original,
		int32	width,
		int32	height
	)

Initializes a new instance of the xtd::drawing::icon class and attempts to find a version of the icon that matches the requested size.

Parameters

original	The xtd::drawing::icon from which to load the newly sized icon.
width	The width of the new icon.
height	The height of the new icon.

Remarks

If a version cannot be found that exactly matches the size, the closest match is used. If the original parameter is an xtd::drawing::icon that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the xtd::graphics::drawing::draw_image method to resize the icon.

Member Function Documentation

handle()

intptr xtd::drawing::icon::handle ( ) const

noexcept

Gets the handle of this icon. This is not a copy of the handle; do not free it.

Returns

The Windows handle for the icon.

height()

int32 xtd::drawing::icon::height ( ) const

noexcept

Gets the height of this xtd::drawing::icon.

Returns

The height of this xtd::drawing::icon.

size()

const xtd::drawing::size & xtd::drawing::icon::size ( ) const

noexcept

Gets the size of this xtd::drawing::icon.

Returns

The size of this xtd::drawing::icon.

width()

int32 xtd::drawing::icon::width ( ) const

noexcept

Gets the width of this xtd::drawing::icon.

Returns

The width of this xtd::drawing::icon.

equals() [1/2]

bool xtd::drawing::icon::equals ( const object &  obj ) const

overridevirtualnoexcept

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.

Reimplemented from xtd::object.

equals() [2/2]

bool xtd::drawing::icon::equals ( const icon &  other ) const

overridenoexcept

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

Parameters

other

An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

get_hash_code()

xtd::size xtd::drawing::icon::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

save() [1/2]

void xtd::drawing::icon::save

(

const xtd::string &

filename

)

const

Saves this xtd::drawing::icon to the specified output filename.

Parameters

filename

The file to save to.

save() [2/2]

void xtd::drawing::icon::save

(

std::ostream &

stream

)

const

Saves this xtd::drawing::icon to the specified output std::ostream.

Parameters

stream

The std::ostream to save to.

to_bitmap()

xtd::drawing::bitmap xtd::drawing::icon::to_bitmap

(

)

const

Converts this xtd::drawing::icon to a GDI+ xtd::drawing::bitmap.

Returns

A Bitmap that represents the converted xtd::drawing::icon.

Remarks

The transparent areas of the icon are lost when it is converted to a bitmap, and the transparent color of the resulting bitmap is set to RGB(13,11,12). The returned bitmap has the same height and width as the original icon.

to_string()

xtd::string xtd::drawing::icon::to_string ( ) const

overridevirtualnoexcept

Gets a human-readable string that describes the xtd::drawing::icon.

Returns

A string that describes the xtd::drawing::icon.

Reimplemented from xtd::object.

from_bitmap()

static icon xtd::drawing::icon::from_bitmap ( const xtd::drawing::bitmap &  bitmap )

static

Creates a GDI+ xtd::drawing::icon from the specified bitmap.

Parameters

bitmap

A xtd::drawing::bitmap use to create xtd::drawing::icon.

Returns

The xtd::drawing::icon this method creates.

from_handle()

static icon xtd::drawing::icon::from_handle ( intptr  handle )

static

Creates a GDI+ xtd::drawing::icon from the specified Windows handle to an icon (HICON).

Parameters

handle

A Windows handle to an icon.

Returns

The xtd::drawing::icon this method creates.

Remarks

When using this method, you must dispose of the original icon by using the DestroyIcon method in the Windows API to ensure that the resources are released.

---

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

• xtd.drawing/include/xtd/drawing/icon.hpp