Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
interface/imaglist.h
View File

@@ -9,18 +9,18 @@
/**
@class wxImageList
@wxheader{imaglist.h}
A wxImageList contains a list of images, which are stored in
an unspecified form. Images can have masks for transparent
drawing, and can be made from a variety of sources including bitmaps
and icons.
wxImageList is used principally in conjunction with wxTreeCtrl and
wxListCtrl classes.
@library{wxcore}
@category{gdi}
@seealso
wxTreeCtrl, wxListCtrl
*/
@@ -32,39 +32,39 @@ public:
Constructor specifying the image size, whether image masks should be created,
and the initial size of the list.
@param width
@param width
Width of the images in the list.
@param height
@param height
Height of the images in the list.
@param mask
@param mask
@true if masks should be created for all images.
@param initialCount
@param initialCount
The initial size of the list.
@sa Create()
*/
wxImageList();
wxImageList(int width, int height, bool mask = @true,
int initialCount = 1);
wxImageList(int width, int height, bool mask = @true,
int initialCount = 1);
//@}
//@{
/**
Adds a new image using an icon.
@param bitmap
@param bitmap
Bitmap representing the opaque areas of the image.
@param mask
@param mask
Monochrome mask bitmap, representing the transparent areas of the image.
@param maskColour
@param maskColour
Colour indicating which parts of the image are transparent.
@param icon
@param icon
Icon to use as the image.
@returns The new zero-based image index.
@@ -74,8 +74,8 @@ public:
*/
int Add(const wxBitmap& bitmap,
const wxBitmap& mask = wxNullBitmap);
int Add(const wxBitmap& bitmap, const wxColour& maskColour);
int Add(const wxIcon& icon);
int Add(const wxBitmap& bitmap, const wxColour& maskColour);
int Add(const wxIcon& icon);
//@}
/**
@@ -87,19 +87,19 @@ public:
/**
Draws a specified image onto a device context.
@param index
@param index
Image index, starting from zero.
@param dc
@param dc
Device context to draw on.
@param x
@param x
X position on the device context.
@param y
@param y
Y position on the device context.
@param flags
@param flags
How to draw the image. A bitlist of a selection of the following:
wxIMAGELIST_DRAW_NORMAL
@@ -122,7 +122,7 @@ public:
Draw the image in a focused state.
@param solidBackground
@param solidBackground
For optimisation - drawing can be faster if the function is told
that the background is solid.
*/
@@ -146,16 +146,16 @@ public:
int GetImageCount();
/**
Retrieves the size of the images in the list. Currently, the @e index
Retrieves the size of the images in the list. Currently, the @e index
parameter is ignored as all images in the list have the same size.
@param index
@param index
currently unused, should be 0
@param width
@param width
receives the width of the images in the list
@param height
@param height
receives the height of the images in the list
@returns @true if the function succeeded, @false if it failed (for example,
@@ -177,13 +177,13 @@ public:
/**
Replaces the existing image with the new image.
@param bitmap
@param bitmap
Bitmap representing the opaque areas of the image.
@param mask
@param mask
Monochrome mask bitmap, representing the transparent areas of the image.
@param icon
@param icon
Icon to use as the image.
@returns @true if the replacement was successful, @false otherwise.
@@ -193,6 +193,6 @@ public:
*/
bool Replace(int index, const wxBitmap& bitmap,
const wxBitmap& mask = wxNullBitmap);
bool Replace(int index, const wxIcon& icon);
bool Replace(int index, const wxIcon& icon);
//@}
};