1 \section{\class{wxImageList
}}\label{wximagelist
}
3 A wxImageList contains a list of images, which are stored in
4 an unspecified form. Images can have masks for transparent
5 drawing, and can be made from a variety of sources including bitmaps
8 wxImageList is used principally in conjunction with
\helpref{wxTreeCtrl
}{wxtreectrl
} and
9 \rtfsp\helpref{wxListCtrl
}{wxlistctrl
} classes.
11 \wxheading{Derived from
}
13 \helpref{wxObject
}{wxobject
}
15 \wxheading{Include files
}
21 \helpref{wxTreeCtrl
}{wxtreectrl
},
\helpref{wxListCtrl
}{wxlistctrl
}
23 \latexignore{\rtfignore{\wxheading{Members
}}}
25 \membersection{wxImageList::wxImageList
}\label{wximagelistconstr
}
27 \func{}{wxImageList
}{\void}
31 \func{}{wxImageList
}{\param{int
}{width
},
\param{int
}{height
},
\param{const bool
}{mask = TRUE
},
\rtfsp
32 \param{int
}{initialCount =
1}}
34 Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
36 \wxheading{Parameters
}
38 \docparam{width
}{Width of the images in the list.
}
40 \docparam{height
}{Height of the images in the list.
}
42 \docparam{mask
}{TRUE if masks should be created for all images.
}
44 \docparam{initialCount
}{The initial size of the list.
}
48 \helpref{wxImageList::Create
}{wximagelistcreate
}
50 \membersection{wxImageList::Add
}\label{wximagelistadd
}
52 \func{int
}{Add
}{\param{const wxBitmap\&
}{ bitmap
},
\param{const wxBitmap\&
}{ mask = wxNullBitmap
}}
54 Adds a new image using a bitmap and optional mask bitmap.
56 \func{int
}{Add
}{\param{const wxBitmap\&
}{ bitmap
},
\param{const wxColour\&
}{ maskColour
}}
58 Adds a new image using a bitmap and mask colour.
60 \func{int
}{Add
}{\param{const wxIcon\&
}{ icon
}}
62 Adds a new image using an icon.
64 \wxheading{Parameters
}
66 \docparam{bitmap
}{Bitmap representing the opaque areas of the image.
}
68 \docparam{mask
}{Monochrome mask bitmap, representing the transparent areas of the image.
}
70 \docparam{maskColour
}{Colour indicating which parts of the image are transparent.
}
72 \docparam{icon
}{Icon to use as the image.
}
74 \wxheading{Return value
}
76 The new zero-based image index.
80 The original bitmap or icon is not affected by the
{\bf Add
} operation, and can be deleted afterwards.
82 \membersection{wxImageList::Create
}\label{wximagelistcreate
}
84 \func{bool
}{Create
}{\param{int
}{width
},
\param{int
}{height
},
\param{const bool
}{mask = TRUE
},
\rtfsp
85 \param{int
}{initialCount =
1}}
87 Initializes the list. See
\helpref{wxImageList::wxImageList
}{wximagelistconstr
} for details.
89 \membersection{wxImageList::Draw
}\label{wximagelistdraw
}
91 \func{bool
}{Draw
}{\param{int
}{ index
},
\param{wxDC\&
}{ dc
},
\param{int
}{x
},
\rtfsp
92 \param{int
}{x
},
\param{int
}{flags = wxIMAGELIST
\_DRAW\_NORMAL},
\rtfsp
93 \param{const bool
}{solidBackground = FALSE
}}
95 Draws a specified image onto a device context.
97 \wxheading{Parameters
}
99 \docparam{index
}{Image index, starting from zero.
}
101 \docparam{dc
}{Device context to draw on.
}
103 \docparam{x
}{X position on the device context.
}
105 \docparam{y
}{Y position on the device context.
}
107 \docparam{flags
}{How to draw the image. A bitlist of a selection of the following:
109 \begin{twocollist
}\itemsep=
0pt
110 \twocolitem{{\bf wxIMAGELIST
\_DRAW\_NORMAL}}{Draw the image normally.
}
111 \twocolitem{{\bf wxIMAGELIST
\_DRAW\_TRANSPARENT}}{Draw the image with transparency.
}
112 \twocolitem{{\bf wxIMAGELIST
\_DRAW\_SELECTED}}{Draw the image in selected state.
}
113 \twocolitem{{\bf wxIMAGELIST
\_DRAW\_FOCUSED}}{Draw the image in a focussed state.
}
117 \docparam{solidBackground
}{For optimisation - drawing can be faster if the function is told
118 that the background is solid.
}
120 \membersection{wxImageList::GetImageCount
}\label{wximagelistgetimagecount
}
122 \constfunc{int
}{GetImageCount
}{\void}
124 Returns the number of images in the list.
126 \membersection{wxImageList::Remove
}\label{wximagelistremove
}
128 \func{bool
}{Remove
}{\param{int
}{ index
}}
130 Removes the image at the given position.
132 \membersection{wxImageList::RemoveAll
}\label{wximagelistremoveall
}
134 \func{bool
}{RemoveAll
}{\void}
136 Removes all the images in the list.
138 \membersection{wxImageList::Replace
}\label{wximagelistreplace
}
140 \func{bool
}{Replace
}{\param{int
}{ index
},
\param{const wxBitmap\&
}{ bitmap
},
\param{const wxBitmap\&
}{ mask = wxNullBitmap
}}
142 Replaces the existing image with the new image.
144 \func{bool
}{Replace
}{\param{int
}{ index
},
\param{const wxIcon\&
}{ icon
}}
146 Replaces the existing image with the new image.
148 \wxheading{Parameters
}
150 \docparam{bitmap
}{Bitmap representing the opaque areas of the image.
}
152 \docparam{mask
}{Monochrome mask bitmap, representing the transparent areas of the image.
}
154 \docparam{icon
}{Icon to use as the image.
}
156 \wxheading{Return value
}
158 TRUE if the replacement was successful, FALSE otherwise.
162 The original bitmap or icon is not affected by the
{\bf Replace
} operation, and can be deleted afterwards.