Groups | |
ICONFLAG | |
Macros | |
#define | LIBRARY_ICON_COLLECTION |
Functions | |
Bool | RegisterIcon (Int32 lIconID, BaseBitmap *pBmp, Int32 x=0, Int32 y=0, Int32 w=-1, Int32 h=-1, ICONFLAG lFlags=ICONFLAG::NONE) |
Bool | RegisterIcon (Int32 lIconID, Filename fn, Int32 x=0, Int32 y=0, Int32 w=-1, Int32 h=-1, ICONFLAG lFlags=ICONFLAG::NONE) |
Bool | GetIcon (Int32 lIconID, IconData *pData) |
Bool | UnregisterIcon (Int32 lIconID) |
#define LIBRARY_ICON_COLLECTION |
Icon collection library ID.
Bool RegisterIcon | ( | Int32 | lIconID, |
BaseBitmap * | pBmp, | ||
Int32 | x = 0 , |
||
Int32 | y = 0 , |
||
Int32 | w = -1 , |
||
Int32 | h = -1 , |
||
ICONFLAG | lFlags = ICONFLAG::NONE |
||
) |
Registers an icon from a bitmap.
Optionally a sub-icon can be specified within a larger image by giving a rectangle from (x,y) to (x+w, y+h).
If no rectangle is specified the whole bitmap is used.
[in] | lIconID | A unique plugin ID. Must be obtained from http://www.plugincafe.com |
[in] | pBmp | The bitmap to use for the icon. The caller owns the pointed bitmap. |
[in] | x | Optional X coordinate of the top left corner of the sub-icon rectangle. |
[in] | y | Optional Y coordinate of the top left corner of the sub-icon rectangle. |
[in] | w | Optional width of the sub-icon rectangle. |
[in] | h | Optional height of the sub-icon rectangle. |
[in] | lFlags | The flags: ICONFLAG |
Bool RegisterIcon | ( | Int32 | lIconID, |
Filename | fn, | ||
Int32 | x = 0 , |
||
Int32 | y = 0 , |
||
Int32 | w = -1 , |
||
Int32 | h = -1 , |
||
ICONFLAG | lFlags = ICONFLAG::NONE |
||
) |
Registers an icon from an image file.
Optionally a sub-icon can be specified within a larger image by giving a rectangle from (x,y) to (x+w, y+h).
If no rectangle is specified the whole bitmap is used.
[in] | lIconID | A unique plugin ID. Must be obtained from http://www.plugincafe.com |
[in] | fn | The filename of the image file to use for the icon. |
[in] | x | Optional X coordinate of the top left corner of the sub-icon rectangle. |
[in] | y | Optional Y coordinate of the top left corner of the sub-icon rectangle. |
[in] | w | Optional width of the sub-icon rectangle. |
[in] | h | Optional height of the sub-icon rectangle. |
[in] | lFlags | The flags: ICONFLAG |
Retrieves an icon registered with RegisterIcon().
[in] | lIconID | The ID of the icon. |
[in,out] | pData | Filled with information about the found icon. The caller owns the pointed icon data. |
Unregisters an icon registered with RegisterIcon().
[in] | lIconID | The ID of the icon. |