don't style using Doxygen tags; use <span> tags and CSS instead

[wxWidgets.git] / interface / imaglist.h

/////////////////////////////////////////////////////////////////////////////
// Name:        imaglist.h
// Purpose:     documentation for wxImageList class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @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
*/
class wxImageList : public wxObject
{
public:
    //@{
    /**
        Constructor specifying the image size, whether image masks should be created,
        and the initial size of the list.
        
        @param width
        Width of the images in the list.
        
        @param height
        Height of the images in the list.
        
        @param mask
        @true if masks should be created for all images.
        
        @param initialCount
        The initial size of the list.
        
        @sa Create()
    */
    wxImageList();
    wxImageList(int width, int height, bool mask = @true,
                int initialCount = 1);
    //@}

    //@{
    /**
        Adds a new image using an icon.
        
        @param bitmap
        Bitmap representing the opaque areas of the image.
        
        @param mask
        Monochrome mask bitmap, representing the transparent areas of the image.
        
        @param maskColour
        Colour indicating which parts of the image are transparent.
        
        @param icon
        Icon to use as the image.
        
        @returns The new zero-based image index.
        
        @remarks The original bitmap or icon is not affected by the Add
                   operation, and can be deleted afterwards.
    */
    int Add(const wxBitmap& bitmap,
            const wxBitmap& mask = wxNullBitmap);
    int Add(const wxBitmap& bitmap, const wxColour& maskColour);
    int Add(const wxIcon& icon);
    //@}

    /**
        Initializes the list. See wxImageList() for details.
    */
    bool Create(int width, int height, bool mask = @true,
                int initialCount = 1);

    /**
        Draws a specified image onto a device context.
        
        @param index
        Image index, starting from zero.
        
        @param dc
        Device context to draw on.
        
        @param x
        X position on the device context.
        
        @param y
        Y position on the device context.
        
        @param flags
        How to draw the image. A bitlist of a selection of the following:
        
        wxIMAGELIST_DRAW_NORMAL
        
        
        Draw the image normally.
        
        wxIMAGELIST_DRAW_TRANSPARENT
        
        
        Draw the image with transparency.
        
        wxIMAGELIST_DRAW_SELECTED
        
        
        Draw the image in selected state.
        
        wxIMAGELIST_DRAW_FOCUSED
        
        
        Draw the image in a focused state.
        
        @param solidBackground
        For optimisation - drawing can be faster if the function is told
        that the background is solid.
    */
    bool Draw(int index, wxDC& dc, int x, int y,
              int flags = wxIMAGELIST_DRAW_NORMAL,
              bool solidBackground = @false);

    /**
        Returns the bitmap corresponding to the given index.
    */
    wxBitmap GetBitmap(int index);

    /**
        Returns the icon corresponding to the given index.
    */
    wxIcon GetIcon(int index);

    /**
        Returns the number of images in the list.
    */
    int GetImageCount();

    /**
        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
        currently unused, should be 0
        
        @param width
        receives the width of the images in the list
        
        @param height
        receives the height of the images in the list
        
        @returns @true if the function succeeded, @false if it failed (for example,
                   if the image list was not yet initialized).
    */
    bool GetSize(int index, int& width, int & height);

    /**
        Removes the image at the given position.
    */
    bool Remove(int index);

    /**
        Removes all the images in the list.
    */
    bool RemoveAll();

    //@{
    /**
        Replaces the existing image with the new image.
        
        @param bitmap
        Bitmap representing the opaque areas of the image.
        
        @param mask
        Monochrome mask bitmap, representing the transparent areas of the image.
        
        @param icon
        Icon to use as the image.
        
        @returns @true if the replacement was successful, @false otherwise.
        
        @remarks The original bitmap or icon is not affected by the Replace
                   operation, and can be deleted afterwards.
    */
    bool Replace(int index, const wxBitmap& bitmap,
                 const wxBitmap& mask = wxNullBitmap);
    bool Replace(int index, const wxIcon& icon);
    //@}
};