ugh. Nesting the (per class) plugin sentries can require them to

[wxWidgets.git] / docs / latex / wx / imaglist.tex

diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex
index aeab0536044d35d533058335cee65be2be56a512..548b3dae78430fc8e58097f2cbb44e6fdc61271f 100644 (file)
--- a/docs/latex/wx/imaglist.tex
+++ b/docs/latex/wx/imaglist.tex
@@ -79,6 +79,14 @@ The new zero-based image index.
 
 The original bitmap or icon is not affected by the {\bf Add} operation, and can be deleted afterwards.
 
 
 The original bitmap or icon is not affected by the {\bf Add} operation, and can be deleted afterwards.
 

+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Add(bitmap, mask=wxNullBitmap)}}{}
+\twocolitem{{\bf AddWithColourMask(bitmap, colour)}}{}
+\twocolitem{{\bf AddIcon(icon)}}{}
+\end{twocollist}}
+}

 \membersection{wxImageList::Create}\label{wximagelistcreate}
 
 \func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
 \membersection{wxImageList::Create}\label{wximagelistcreate}
 
 \func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp


@@ -123,6 +131,26 @@ that the background is solid.}
 
 Returns the number of images in the list.
 
 
 Returns the number of images in the list.
 

+\membersection{wxImageList::GetSize}\label{wximagelistgetsize}
+
+\constfunc{bool}{GetSize}{\param{int }{index}, \param{int\& }{width}, \param{int \&}{height}}
+
+Retrieves the size of the images in the list. Currently, the {\it index} 
+parameter is ignored as all images in the list have the same size.
+
+\wxheading{Parameters}
+
+\docparam{index}{currently unused, should be 0}
+
+\docparam{width}{receives the width of the images in the list}
+
+\docparam{height}{receives the height of the images in the list}
+
+\wxheading{Return value}
+
+TRUE if the function succeeded, FALSE if it failed (for example, if the image
+list was not yet initialized).
+

 \membersection{wxImageList::Remove}\label{wximagelistremove}
 
 \func{bool}{Remove}{\param{int}{ index}}
 \membersection{wxImageList::Remove}\label{wximagelistremove}
 
 \func{bool}{Remove}{\param{int}{ index}}


@@ -161,4 +189,6 @@ TRUE if the replacement was successful, FALSE otherwise.
 
 The original bitmap or icon is not affected by the {\bf Replace} operation, and can be deleted afterwards.
 
 
 The original bitmap or icon is not affected by the {\bf Replace} operation, and can be deleted afterwards.
 

+\pythonnote{The second form is called {\tt ReplaceIcon} in wxPython.}
+