MiniGUI API Reference (MiniGUI-Threads)  v3.2.0
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Macros | Functions
Icon operations

Macros

#define CreateIcon(hdc, w, h, AndBits, XorBits, colornum)   CreateIconEx(hdc, w, h, AndBits, XorBits, colornum, NULL)
 

Functions

MG_EXPORT HICON GUIAPI LoadIconFromFile (HDC hdc, const char *filename, int which)
 Loads an icon from a Windows ICO file. More...
 
MG_EXPORT HICON GUIAPI LoadIconFromMem (HDC hdc, const void *area, int which)
 Loads an icon from a memory area. More...
 
MG_EXPORT HICON GUIAPI CreateIconEx (HDC hdc, int w, int h, const BYTE *AndBits, const BYTE *XorBits, int colornum, const RGB *pal)
 Creates an icon object from the memory. More...
 
MG_EXPORT BOOL GUIAPI DestroyIcon (HICON hicon)
 Destroys an icon object. More...
 
MG_EXPORT BOOL GUIAPI GetIconSize (HICON hicon, int *w, int *h)
 Gets the size of an icon object. More...
 
MG_EXPORT void GUIAPI DrawIcon (HDC hdc, int x, int y, int w, int h, HICON hicon)
 Draws an icon into a box. More...
 

Detailed Description

Macro Definition Documentation

#define CreateIcon (   hdc,
  w,
  h,
  AndBits,
  XorBits,
  colornum 
)    CreateIconEx(hdc, w, h, AndBits, XorBits, colornum, NULL)
See also
CreateIconEx

Definition at line 5055 of file gdi.h.

Function Documentation

HICON GUIAPI CreateIconEx ( HDC  hdc,
int  w,
int  h,
const BYTE AndBits,
const BYTE XorBits,
int  colornum,
const RGB pal 
)

Creates an icon object from the memory.

This function creates an icon from memory data rather than icon file. w and h are the width and the height of the icon respectively. pANDBits and pXORBits are AND bitmask and XOR bitmask of the icon. MiniGUI currently support mono-color cursor 256-color icon and 16-color icon, colornum specifies the cursor's color depth. For mono-color, it should be 1, and for 16-color cursor, it should be 4.

Parameters
hdcThe device context.
wThe width of the icon.
hThe height of the icon.
AndBitsThe pointer to the AND bits of the icon.
XorBitsThe pointer to the XOR bits of the icon.
colornumThe bit-per-pixel of XOR bits.
palThe palette of icon.
Returns
The handle to the icon object, zero means error occurred.
See also
LoadIconFromFile

Referenced by SetPixelInBitmap().

BOOL GUIAPI DestroyIcon ( HICON  hicon)

Destroys an icon object.

This function destroys the icon object hicon.

Parameters
hiconThe icon object.
Returns
TRUE on success, otherwise FALSE.
See also
CreateIconEx, LoadIconFromFile
void GUIAPI DrawIcon ( HDC  hdc,
int  x,
int  y,
int  w,
int  h,
HICON  hicon 
)

Draws an icon into a box.

This function draws an icon object hicon into a box specified by (x,y,w,h).

Parameters
hdcThe device context.
xThe x coordinate of the upper-left corner of the box.
yThe y coordinate of the upper-left corner of the box.
wThe width of the box.
hThe height of the box.
hiconThe icon object.
See also
CreateIconEx, LoadIconFromFile
BOOL GUIAPI GetIconSize ( HICON  hicon,
int *  w,
int *  h 
)

Gets the size of an icon object.

This function gets the size of the icon object hicon.

Parameters
hiconThe icon object.
wThe width of the icon will be returned throught this buffer.
hThe height of the icon will be returned throught this buffer.
Returns
TRUE on success, otherwise FALSE.
See also
CreateIconEx, LoadIconFromFile
HICON GUIAPI LoadIconFromFile ( HDC  hdc,
const char *  filename,
int  which 
)

Loads an icon from a Windows ICO file.

This function loads an icon from a Windows ICO file named filename and creates an icon object. This function can load mono-,16-color and 256-color icons.Some Windows ICO file contain two icons in different sizes. You can tell this function to load which icon though which, 0 for the first icon, and 1 for the second icon. Generally, the later icon is the larger icon.

Parameters
hdcThe device context.
filenameThe file name of the ICO file.
whichTell the function to load which icon.
Returns
The handle to the icon object, zero means error occurred.
See also
CreateIconEx

Referenced by SetPixelInBitmap().

HICON GUIAPI LoadIconFromMem ( HDC  hdc,
const void *  area,
int  which 
)

Loads an icon from a memory area.

This function loads an icon from a memroy area pointed to by area. The memory area has the same layout as the M$ Windows ICO file. This function can load mono- ,16-color and 256-color icons. Some Windows ICO file contain two icons in different sizes. You can tell this function to load which icon though which, 0 for the first icon, and 1 for the second icon. Generally, the later icon is the larger icon.

Parameters
hdcThe device context.
areaThe pointer to the memory area.
whichTell the function to load which icon.
Returns
The handle to the icon object, zero means error occurred.
See also
CreateIconEx

Referenced by SetPixelInBitmap().