TNTsdk: Micon functions

int MiconCreate	(	MICON *	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	(	MICON *	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

int MiconCreate	(	MICON *	icon,
		int	ihandle,
		const MIUNICODE *	group,
		const MIUNICODE *	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
ihandle	Icon group handle (0 for standard file)
group	Icon group name
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 ( MICON icon )

Destroy icon.

Parameters:

icon

Icon to destroy

UINT8 MiconGetHeight ( const MICON icon ) [inline]

Get icon height in pixels.

Parameters:

icon

Icon to use

Definition at line 158 of file micon.h.

UINT8 MiconGetWidth ( const MICON icon ) [inline]

Get icon width in pixels.

Parameters:

icon

Icon to use

Definition at line 163 of file micon.h.

void MiconGroupClose ( int ihandle )

Close icon group.

Parameters:

ihandle

Icon group handle

int MiconGroupOpen	(	const MIUNICODE *	filename,
		const MIUNICODE *	group
	)

Open icon group.

Returns:: Icon handle or error < 0.

Parameters:

filename	Icon file name, NULL for "icons.ref"
group	Icon group name

ERRVALUE MiconRead	(	ICONID	iconid,
		MICON *	normalicon,
		MICON *	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,
		MICON *	normalicon,
		MICON *	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 MiconReadPattern	(	int	ihandle,
		INT32	pattnum,
		const MIUNICODE *	name,
		int	width,
		int	height,
		void **	pattdata
	)

Read icon as bitmap pattern.

Parameters:

ihandle	Icon group handle
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

int MiconReadStandard	(	int	ihandle,
		const char *	group,
		const char *	name,
		MICON *	normalicon,
		MICON *	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:

ihandle	Icon group handle, 0 for standard file
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 MiconReadStandard	(	int	ihandle,
		const char *	group,
		const char *	name,
		MICON *	normalicon,
		MICON *	armselicon,
		MPIXEL	normalbg,
		MPIXEL	armselbg,
		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:

ihandle	Icon group handle, 0 for standard file
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


Functions
int	MiconCreate (MICON *icon, ICONID iconid, MPIXEL bgpixel, UINT8 width, UINT8 height, UINT32 flags)
int	MiconCreate (MICON icon, const char group, const char *name, MPIXEL bgpixel, UINT8 width, UINT8 height, UINT32 flags)
int	MiconCreate (MICON icon, int ihandle, const MIUNICODE group, const MIUNICODE *name, MPIXEL bgpixel, UINT8 width, UINT8 height, UINT32 flags)
void	MiconDestroy (MICON icon)
UINT8	MiconGetHeight (const MICON icon)
UINT8	MiconGetWidth (const MICON icon)
void	MiconGroupClose (int ihandle)
int	MiconGroupOpen (const MIUNICODE filename, const MIUNICODE group)
ERRVALUE	MiconRead (ICONID iconid, MICON normalicon, MICON armselicon, MPIXEL normalbg, MPIXEL armselbg, MICONFLAGS flags=MICONFLAG_None)
ERRVALUE	MiconRead (ICONID iconid, MICON normalicon, MICON armselicon=0, MICONFLAGS flags=MICONFLAG_None)
int	MiconReadPattern (int ihandle, INT32 pattnum, const MIUNICODE name, int width, int height, void *pattdata)
int	MiconReadStandard (int ihandle, const char group, const char name, MICON normalicon, MICON armeselicon, UINT32 flags)
int	MiconReadStandard (int ihandle, const char group, const char name, MICON normalicon, MICON armselicon, MPIXEL normalbg, MPIXEL armselbg, UINT32 flags)

Micon functions

Functions

Detailed Description

Function Documentation