Micon functions

Functions
int	MiconCreate (MICONSTRUCT **icon, ICONID iconid, MPIXEL bgpixel, UINT8 width, UINT8 height, UINT32 flags)
int	MiconCreate (MICONSTRUCT **icon, const char *group, const char *name, MPIXEL bgpixel, UINT8 width, UINT8 height, UINT32 flags)
void	MiconDestroy (MICONSTRUCT *icon)
ICONID	MiconGenerateID (const char *name, const char *group=0, int size=16)
UINT8	MiconGetHeight (const MICONSTRUCT *icon)
UINT8	MiconGetWidth (const MICONSTRUCT *icon)
ERRVALUE	MiconOpen (RVC::STYLE &Object, const MIUNICODE *group)
ERRVALUE	MiconOpen (RVC::STYLE &Object, const FILEPATH &filepath, const MIUNICODE *group)
ERRVALUE	MiconRead (const char *group, const char *name, RVC::STYLEPATTERN_BITMAP &pattern)
ERRVALUE	MiconRead (ICONID iconid, RVC::STYLEPATTERN_BITMAP &pattern)
ERRVALUE	MiconRead (ICONID iconid, SIMPLE_ARRAY< UINT32 > &data)
ERRVALUE	MiconRead (ICONID iconid, MICONSTRUCT **normalicon, MICONSTRUCT **armselicon, MPIXEL normalbg, MPIXEL armselbg, MICONFLAGS flags=MICONFLAG_None)
ERRVALUE	MiconRead (ICONID iconid, MICONSTRUCT **normalicon, MICONSTRUCT **armselicon=0, MICONFLAGS flags=MICONFLAG_None)
int	MiconRead (const char *group, const char *name, MICONSTRUCT **normalicon, MICONSTRUCT **armeselicon, UINT32 flags)
int	MiconRead (const char *group, const char *name, MICONSTRUCT **normalicon, MICONSTRUCT **armselicon, MPIXEL normalbg, MPIXEL armselbg, UINT32 flags, RVC::STYLE *StyleObj=0)
int	MiconReadPatternExt (RVC::STYLE &StyleObj, INT32 pattnum, const MIUNICODE *name, int width, int height, RVC::STYLEPATTERN_BITMAP &Pattern)
int	MiconReadPatternExt (RVC::STYLE &StyleObj, INT32 pattnum, const MIUNICODE *name, int width, int height, SIMPLE_ARRAY< UINT8 > &pattdata)

---

Function Documentation

int MiconCreate	(	MICONSTRUCT **	icon,
		ICONID	iconid,
		MPIXEL	bgpixel,
		UINT8	width,
		UINT8	height,
		UINT32	flags
	)

Create new icon using ICONID.

Flags: MICONFLAG_DefaultBackground Use MxTopLevel()'s XmNbackground resource MICONFLAG_SizeMask Bit mask for sizes from 1 to 255 MICONFLAG_Size16 16 by 16 MICONFLAG_Size32 32 by 32 MICONFLAG_Stippled Create a "dimmed" pixmap as well as a normal pixmap

Parameters:

	icon	Icon returned
	iconid	Icon ID
	bgpixel	Background pixel
	width	Icon width (0 to use value from file)
	height	Icon height (0 to use value from file)
	flags	Flags

int MiconCreate	(	MICONSTRUCT **	icon,
		const char *	group,
		const char *	name,
		MPIXEL	bgpixel,
		UINT8	width,
		UINT8	height,
		UINT32	flags
	)

Create new icon.

Flags: MICONFLAG_DefaultBackground Use MxTopLevel()'s XmNbackground resource MICONFLAG_SizeMask Bit mask for sizes from 1 to 255 MICONFLAG_Size16 16 by 16 MICONFLAG_Size32 32 by 32 MICONFLAG_Stippled Create a "dimmed" pixmap as well as a normal pixmap

Parameters:

	icon	Icon returned
	group	Icon group, NULL for "standard"
	name	Icon name
	bgpixel	Background pixel
	width	Icon width (0 to use value from file)
	height	Icon height (0 to use value from file)
	flags	Flags

void MiconDestroy

(

MICONSTRUCT *

icon

)

Destroy icon.

Parameters:

icon

Icon to destroy

ICONID MiconGenerateID	(	const char *	name,
		const char *	group = 0,
		int	size = 16
	)

Generate ICONID from icon name/group.

Parameters:

	name	Icon name
	group	Icon group, NULL for "standard"
	size	Icon size

UINT8 MiconGetHeight

(

const MICONSTRUCT *

icon

)

[inline]

Get icon height in pixels.

Parameters:

icon

Icon to use

UINT8 MiconGetWidth

(

const MICONSTRUCT *

icon

)

[inline]

Get icon width in pixels.

Parameters:

icon

Icon to use

ERRVALUE MiconOpen	(	RVC::STYLE &	Object,
		const MIUNICODE *	group
	)

Open icon group in icons.ref.

Parameters:

	Object	Style object to open
	group	Icon group name

ERRVALUE MiconOpen	(	RVC::STYLE &	Object,
		const FILEPATH &	filepath,
		const MIUNICODE *	group
	)

Open icon group in user-specified icon file.

Parameters:

	Object	Style object to open
	filepath	Icon file to open
	group	Icon group name

ERRVALUE MiconRead	(	const char *	group,
		const char *	name,
		RVC::STYLEPATTERN_BITMAP &	pattern
	)

Read icon as bitmap pattern.

Parameters:

	group	Icon group, NULL for "standard"
	name	Icon name

ERRVALUE MiconRead	(	ICONID	iconid,
		RVC::STYLEPATTERN_BITMAP &	pattern
	)

Read icon as bitmap pattern.

ERRVALUE MiconRead	(	ICONID	iconid,
		SIMPLE_ARRAY< UINT32 > &	data
	)

Read icon for use as a _NET_WM_ICON X window property The data returned is an array of 32-bit values in the local byte-order (the X server worries about byte swapping if necessary).

Format is height followed by width, followed by height*width 32-bit color values in ARGB order.

Parameters:

	iconid	Icon ID
	data	Icon data returned

ERRVALUE MiconRead	(	ICONID	iconid,
		MICONSTRUCT **	normalicon,
		MICONSTRUCT **	armselicon,
		MPIXEL	normalbg,
		MPIXEL	armselbg,
		MICONFLAGS	flags = MICONFLAG_None
	)

Read icon for use with widget with background pixel override.

Parameters:

	iconid	Icon ID
	normalicon	Icon with "normal" colors returned, NULL if don't need
	armselicon	Icon with "armed/selected" colors returned, NULL if don't need
	normalbg	Normal background pixel if default not used
	armselbg	Armed/selected background pixel if default not used
	flags	Flags

ERRVALUE MiconRead	(	ICONID	iconid,
		MICONSTRUCT **	normalicon,
		MICONSTRUCT **	armselicon = 0,
		MICONFLAGS	flags = MICONFLAG_None
	)

Read icon for use with widget.

Parameters:

	iconid	Icon ID
	normalicon	Icon with "normal" colors returned, NULL if don't need
	armselicon	Icon with "armed/selected" colors returned, NULL if don't need
	flags	Flags

int MiconRead	(	const char *	group,
		const char *	name,
		MICONSTRUCT **	normalicon,
		MICONSTRUCT **	armeselicon,
		UINT32	flags
	)

Read icon(s) in standard format for use with widget.

Flags: MICONFLAG_DefaultBackground Use MxTopLevel()'s XmNbackground resource MICONFLAG_NoDarkenSelected Don't darken background for "armed/selected" state MICONFLAG_SizeMask Bit mask for sizes from 1 to 255 MICONFLAG_Size16 16 by 16 MICONFLAG_Size32 32 by 32 MICONFLAG_Stippled Create a "dimmed" pixmap as well as a normal pixmap

Parameters:

	group	Icon group, NULL for "standard"
	name	Icon name
	normalicon	Icon with "normal" colors returned, NULL if don't need
	armeselicon	Icon with "armed/selected" colors returned, NULL if don't need
	flags	Flags

int MiconRead	(	const char *	group,
		const char *	name,
		MICONSTRUCT **	normalicon,
		MICONSTRUCT **	armselicon,
		MPIXEL	normalbg,
		MPIXEL	armselbg,
		UINT32	flags,
		RVC::STYLE *	StyleObj = 0
	)

Read icon(s) in standard format for use with widget.

Flags: MICONFLAG_DefaultBackground Use MxTopLevel()'s XmNbackground resource MICONFLAG_NoDarkenSelected Don't darken background for "armed/selected" state MICONFLAG_SizeMask Bit mask for sizes from 1 to 255 MICONFLAG_Size16 16 by 16 MICONFLAG_Size32 32 by 32 MICONFLAG_Stippled Create a "dimmed" pixmap as well as a normal pixmap

Parameters:

	group	Icon group, NULL for "standard"
	name	Icon name
	normalicon	Icon with "normal" colors returned, NULL if don't need
	armselicon	Icon with "armed/selected" colors returned, NULL if don't need
	normalbg	Normal background pixel if default not used
	armselbg	Armed/selected background pixel if default not used
	flags	Flags

int MiconReadPatternExt	(	RVC::STYLE &	StyleObj,
		INT32	pattnum,
		const MIUNICODE *	name,
		int	width,
		int	height,
		RVC::STYLEPATTERN_BITMAP &	Pattern
	)

Parameters:

	pattnum	Pattern number if known
	name	Icon name
	width	Width, 0 for value from file
	height	Height, 0 for value from file

int MiconReadPatternExt	(	RVC::STYLE &	StyleObj,
		INT32	pattnum,
		const MIUNICODE *	name,
		int	width,
		int	height,
		SIMPLE_ARRAY< UINT8 > &	pattdata
	)

Parameters:

	pattnum	Pattern number if known
	name	Icon name
	width	Width, 0 for value from file
	height	Height, 0 for value from file
	pattdata	Pattern buffer allocated and returned