System bitmap/icon operations
[Window creating/destroying]

Defines

• #define GetLargeSystemIcon(iItem)   GetLargeSystemIconEx(HWND_NULL, iItem)

  Retrives a large (32x32) system icon by its identifier in default renderer.
  

• #define GetSmallSystemIcon(iItem)   GetSmallSystemIconEx(HWND_NULL, iItem)

  Retrives a small (16x16) system icon by its identifier in default renderer.
  

Functions

• MG_EXPORT const BITMAP *GUIAPI GetSystemBitmapEx (const char *rdr_name, const char *id)

  Retrives the system bitmap object by identifier.
  

• MG_EXPORT const BITMAP *GUIAPI GetSystemBitmapByHwnd (HWND hWnd, const char *id)

  Retrives the system bitmap object by identifier.
  

• MG_EXPORT const BITMAP *GUIAPI GetSystemBitmap (HWND hWnd, const char *id)

  Retrives the system bitmap object by identifier.
  

• MG_EXPORT void GUIAPI TermSystemBitmapEx (const char *id, const char *rdr_name, PBITMAP bmp)

  Release the system bitmap object by identifier.
  

• MG_EXPORT void GUIAPI TermSystemBitmap (HWND hWnd, const char *id, PBITMAP bmp)

  Release the system bitmap object by identifier.
  

• MG_EXPORT HICON GUIAPI LoadSystemIconEx (HDC hdc, const char *rdr_name, const char *szItemName, int which)

  Loads an icon from information defined in MiniGUI.cfg.
  

• MG_EXPORT HICON GUIAPI LoadSystemIcon (const char *szItemName, int which)

  Uses default renderer and HDC_SCREEN to load an icon from information defined in MiniGUI.cfg.
  

• MG_EXPORT HICON GUIAPI GetLargeSystemIconEx (HWND hWnd, int iItem)

  Retrives a large system icon by its identifier in default renderer.
  

• MG_EXPORT HICON GUIAPI GetSmallSystemIconEx (HWND hWnd, int iItem)

  Retrives a small system icon by its identifier.
  

---

Define Documentation

#define GetLargeSystemIcon

(

iItem

)

GetLargeSystemIconEx(HWND_NULL, iItem)

Retrives a large (32x32) system icon by its identifier in default renderer.

See also:

GetSmallSystemIconEx

Definition at line 6614 of file window.h.

#define GetSmallSystemIcon

(

iItem

)

GetSmallSystemIconEx(HWND_NULL, iItem)

Retrives a small (16x16) system icon by its identifier in default renderer.

See also:

GetSmallSystemIconEx

Definition at line 6622 of file window.h.

---

Function Documentation

HICON GUIAPI GetLargeSystemIconEx	(	HWND	hWnd,
		int	iItem
	)

Retrives a large system icon by its identifier in default renderer.

This function retrives the handle to a large (32x32) system icon by its identifier id.

Parameters:

	hWnd	The handle to the window.
	iItem	The identifier of the icon. It can be one of the following values: IDI_APPLICATION The application icon. IDI_STOP The stop icon. IDI_QUESTION The question mark icon. IDI_EXCLAMATION The exclamation mark icon. IDI_INFORMATION The information mark icon.

Returns:

The handle to the icon.

See also:

GetSystemBitmap

HICON GUIAPI GetSmallSystemIconEx	(	HWND	hWnd,
		int	iItem
	)

Retrives a small system icon by its identifier.

This function retrives the handle to a small (16x16) system icon by its identifier id.

Parameters:

	hWnd	The handle to the window.
	iItem	The identifier of the icon. It can be one of the following values: IDI_APPLICATION The application icon. IDI_STOP The stop icon. IDI_QUESTION The question mark icon. IDI_EXCLAMATION The exclamation mark icon. IDI_INFORMATION The information mark icon.

Returns:

The handle to the icon.

See also:

GetSystemBitmap

PBITMAP GUIAPI GetSystemBitmap	(	HWND	hWnd,
		const char *	id
	)

Retrives the system bitmap object by identifier.

This function returns the system bitmap object by its identifier.

Parameters:

	hWnd	The handle to the window.
	id	The identifier of the system bitmap object, can be one of the following values:

• SYSBMP_RADIOBUTTON
  
• SYSBMP_CHECKBUTTON
  
• SYSBMP_BGPICTURE
  

Returns:

The pointer to the system bitmap object.

See also:

GetLargeSystemIcon, GetSmallSystemIcon

PBITMAP GUIAPI GetSystemBitmapByHwnd	(	HWND	hWnd,
		const char *	id
	)

Retrives the system bitmap object by identifier.

This function returns the system bitmap object by its identifier.

Parameters:

	hWnd	The handle to the window.
	id	The identifier of the system bitmap object, can be one of the following values:

• SYSBMP_RADIOBUTTON
  
• SYSBMP_CHECKBUTTON
  
• SYSBMP_BGPICTURE
  

Returns:

The pointer to the system bitmap object.

See also:

GetLargeSystemIcon, GetSmallSystemIcon

MG_EXPORT const BITMAP *GUIAPI GetSystemBitmapEx	(	const char *	rdr_name,
		const char *	id
	)

Retrives the system bitmap object by identifier.

This function returns the system bitmap object by its identifier.

Parameters:

	rdr_name	The renderer name.
	id	The identifier of the system bitmap object, can be one of the following values:

• SYSBMP_RADIOBUTTON
  
• SYSBMP_CHECKBUTTON
  
• SYSBMP_BGPICTURE
  

Returns:

The pointer to the system bitmap object.

See also:

GetLargeSystemIcon, GetSmallSystemIcon

HICON GUIAPI LoadSystemIcon	(	const char *	szItemName,
		int	which
	)

Uses default renderer and HDC_SCREEN to load an icon from information defined in MiniGUI.cfg.

This function loads an icon from information defined in MiniGUI.cfg.

Parameters:

	szItemName	The key name in the section of renderer name in MiniGUI.cfg.
	which	Tell the function to load which icon.

Returns:

The handle to the loaded icon.

See also:

LoadSystemBitmap, LoadIconFromFile, DestroyIcon

HICON GUIAPI LoadSystemIconEx	(	HDC	hdc,
		const char *	rdr_name,
		const char *	szItemName,
		int	which
	)

Loads an icon from information defined in MiniGUI.cfg.

This function loads an icon from information defined in MiniGUI.cfg.

Parameters:

	hdc	The device context.
	rdr_name	The renderer name.
	szItemName	The key name in the section of renderer name in MiniGUI.cfg.
	which	Tell the function to load which icon. 0 for the small icon, and 1 for large icon.

Returns:

The handle to the loaded icon.

See also:

LoadSystemBitmap, LoadIconFromFile, DestroyIcon

void GUIAPI TermSystemBitmap	(	HWND	hWnd,
		const char *	id,
		PBITMAP	bmp
	)

Release the system bitmap object by identifier.

Parameters:

	hWnd	The handle to the window.
	id	The identifier of the system bitmap object, can be one of the following values:

• SYSBMP_RADIOBUTTON
  
• SYSBMP_CHECKBUTTON
  
• SYSBMP_BGPICTURE
  

Parameters:

bmp

The pointer to the system bitmap object.

Returns:

none.

See also:

GetSystemBitmap

void GUIAPI TermSystemBitmapEx	(	const char *	id,
		const char *	rdr_name,
		PBITMAP	bmp
	)

Release the system bitmap object by identifier.

Parameters:

id

The identifier of the system bitmap object, can be one of the following values:

• SYSBMP_RADIOBUTTON
  
• SYSBMP_CHECKBUTTON
  
• SYSBMP_BGPICTURE
  

Parameters:

	rdr_name	The renderer name.
	bmp	The pointer to the system bitmap object.

Returns:

none.

See also:

GetSystemBitmap