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.

Static Public Member Functions
static icon	from_handle (intptr handle)
	Creates a GDI+ xtd::drawing::icon from the specified Windows handle to an icon (HICON).
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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.

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 icon &icon) const noexcept override
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.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename 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.

Public Static Methods
static icon	from_bitmap (const xtd::drawing::bitmap &bitmap)
	Creates a GDI+ xtd::drawing::icon from the specified bitmap.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename 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 wheth er the current object is equal to another object of the same type.

---

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

• xtd.drawing/include/xtd/drawing/icon.h