xtd::drawing::native::icon Class Reference

Inheritance diagram for xtd::drawing::native::icon:

Definition

Contains icon native API.

Namespace

xtd::drawing::native

Library

xtd.drawing.native

Warning

Internal use only

Protected Static Methods
static intptr	create (const xtd::string &filename)
	Creates an icon from specified filename.
static intptr	create (const xtd::string &filename, int32 width, int32 height)
	Creates an icon from specified filename, and size.
static intptr	create (std::istream &stream)
	Creates an icon from specified std::stream.
static intptr	create (std::istream &stream, int32 width, int32 height)
	Creates an icon from specified std::stream, and size.
static intptr	create (const char *const *bits)
	Creates an icon from bits.
static intptr	create (const char *const *bits, int32 width, int32 height)
	Creates an icon from specified bits, and size.
static intptr	create (intptr image)
	Creates an icon from image.
static intptr	create (intptr icon, int32 width, int32 height)
	Creates an icon from specified icon, and size.
static void	destroy (intptr icon)
	Destroys the icon.
static intptr	from_handle (intptr handle)
	Creates an icon from handle.
static int32	get_height (intptr icon)
	Gets the height of icon.
static int32	get_width (intptr icon)
	Gets the width of icon.
static void	save (intptr icon, const xtd::string &filename)
	Saves icon to the specified output filename.
static void	save (intptr icon, std::ostream &stream, size_t raw_format)
	Saves icon to the specified output std::ostream.
static intptr	to_image (intptr icon)
	Converts icon to an image.

Member Function Documentation

create() [1/8]

static intptr xtd::drawing::native::icon::create ( const xtd::string &  filename )

staticprotected

Creates an icon from specified filename.

Parameters

filename

The filename of the icon.

Returns

A new icon handle.

Warning

Internal use only

create() [2/8]

static intptr xtd::drawing::native::icon::create ( const xtd::string &  filename, int32  width, int32  height  )

staticprotected

Creates an icon from specified filename, and size.

Parameters

filename	The filename of the icon.
width	The desired width of the icon.
height	The desired height of the icon.

Returns

A new icon handle.

Warning

Internal use only

create() [3/8]

static intptr xtd::drawing::native::icon::create ( std::istream &  stream )

staticprotected

Creates an icon from specified std::stream.

Parameters

stream

The stream containing the icon.

Returns

A new icon handle.

Warning

Internal use only

create() [4/8]

static intptr xtd::drawing::native::icon::create ( std::istream &  stream, int32  width, int32  height  )

staticprotected

Creates an icon from specified std::stream, and size.

Parameters

stream	The stream containing the icon.
width	The desired width of the icon.
height	The desired height of the icon.

Returns

A new icon handle.

Warning

Internal use only

create() [5/8]

static intptr xtd::drawing::native::icon::create ( const char *const *  bits )

staticprotected

Creates an icon from bits.

Parameters

bits	The bits containing the icon.

Returns

A new icon handle.

Warning

Internal use only

Remarks

This method is used for creating an icon from an XPM (or XBM) image.

create() [6/8]

static intptr xtd::drawing::native::icon::create ( const char *const *  bits, int32  width, int32  height  )

staticprotected

Creates an icon from specified bits, and size.

Parameters

stream	The bits containing the icon.
width	The desired width of the icon.
height	The desired height of the icon.

Returns

A new icon handle.

Remarks

This method is used for creating an icons from an XPM (or XBM) image.

Warning

Internal use only

create() [7/8]

static intptr xtd::drawing::native::icon::create ( intptr  image )

staticprotected

Creates an icon from image.

Parameters

image

The image handle containing the icon.

Returns

A new icon handle.

Warning

Internal use only

create() [8/8]

static intptr xtd::drawing::native::icon::create ( intptr  icon, int32  width, int32  height  )

staticprotected

Creates an icon from specified icon, and size.

Parameters

icon	The icon handle containing the icon.
width	The desired width of the icon.
height	The desired height of the icon.

Returns

A new icon handle.

Warning

Internal use only

destroy()

static void xtd::drawing::native::icon::destroy ( intptr  icon )

staticprotected

Destroys the icon.

Parameters

icon	The icon handle to destroy.

Warning

Internal use only

from_handle()

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

staticprotected

Creates an icon from handle.

Parameters

handle

The icon handle .

Returns

A new icon handle.

Warning

Internal use only

get_height()

static int32 xtd::drawing::native::icon::get_height ( intptr  icon )

staticprotected

Gets the height of icon.

Parameters

icon	The icon handle .

Returns

The height of icon.

Warning

Internal use only

get_width()

static int32 xtd::drawing::native::icon::get_width ( intptr  icon )

staticprotected

Gets the width of icon.

Parameters

icon	The icon handle .

Returns

The width of icon.

Warning

Internal use only

save() [1/2]

static void xtd::drawing::native::icon::save ( intptr  icon, const xtd::string &  filename  )

staticprotected

Saves icon to the specified output filename.

Parameters

icon	The icon handle .
filename	The file to save to.

Warning

Internal use only

save() [2/2]

static void xtd::drawing::native::icon::save ( intptr  icon, std::ostream &  stream, size_t  raw_format  )

staticprotected

Saves icon to the specified output std::ostream.

Parameters

icon	The icon handle .
stream	The std::ostream to save to.

Warning

Internal use only

to_image()

static intptr xtd::drawing::native::icon::to_image ( intptr  icon )

staticprotected

Converts icon to an image.

Parameters

icon	The icon handle .

Returns

A image handle that represents the converted icon.

Warning

Internal use only

---

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

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