remove duplicate m_popupInterface (patch 1509424)

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

diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex
index a1f79912d9e5377cc5ab24a2204cefe99e69e086..6b71f3a53e303337d6cd901c3df4c8bedf3c31de 100644 (file)
--- a/docs/latex/wx/imaglist.tex
+++ b/docs/latex/wx/imaglist.tex
@@ -12,6 +12,10 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/imaglist.h>
+

 \wxheading{See also}
 
 \helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxListCtrl}{wxlistctrl}
 \wxheading{See also}
 
 \helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxListCtrl}{wxlistctrl}


@@ -24,7 +28,7 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
+\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp

 \param{int }{initialCount = 1}}
 
 Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
 \param{int }{initialCount = 1}}
 
 Constructor specifying the image size, whether image masks should be created, and the initial size of the list.


@@ -35,7 +39,7 @@ Constructor specifying the image size, whether image masks should be created, an
 
 \docparam{height}{Height of the images in the list.}
 
 
 \docparam{height}{Height of the images in the list.}
 

-\docparam{mask}{TRUE if masks should be created for all images.}
+\docparam{mask}{true if masks should be created for all images.}

 
 \docparam{initialCount}{The initial size of the list.}
 
 
 \docparam{initialCount}{The initial size of the list.}
 


@@ -47,11 +51,11 @@ Constructor specifying the image size, whether image masks should be created, an
 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}}
 
 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}}
 

-Adds a new image using a bitmap and optional mask bitmap.
+Adds a new image or images using a bitmap and optional mask bitmap.

 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxColour\&}{ maskColour}}
 
 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxColour\&}{ maskColour}}
 

-Adds a new image using a bitmap and mask colour.
+Adds a new image or images using a bitmap and mask colour.

 
 \func{int}{Add}{\param{const wxIcon\&}{ icon}}
 
 
 \func{int}{Add}{\param{const wxIcon\&}{ icon}}
 


@@ -75,9 +79,19 @@ 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.
 

+If the bitmap is wider than the images in the list, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list.  This does not apply when adding icons.
+
+\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}
 
 \membersection{wxImageList::Create}\label{wximagelistcreate}
 

-\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
+\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp

 \param{int }{initialCount = 1}}
 
 Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details.
 \param{int }{initialCount = 1}}
 
 Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details.


@@ -85,8 +99,8 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr}
 \membersection{wxImageList::Draw}\label{wximagelistdraw}
 
 \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp
 \membersection{wxImageList::Draw}\label{wximagelistdraw}
 
 \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp

-\param{int }{x}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp
-\param{const bool }{solidBackground = FALSE}}
+\param{int }{y}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp
+\param{const bool }{solidBackground = false}}

 
 Draws a specified image onto a device context.
 
 
 Draws a specified image onto a device context.
 


@@ -106,19 +120,51 @@ Draws a specified image onto a device context.
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_NORMAL}}{Draw the image normally.}
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_TRANSPARENT}}{Draw the image with transparency.}
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_SELECTED}}{Draw the image in selected state.}
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_NORMAL}}{Draw the image normally.}
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_TRANSPARENT}}{Draw the image with transparency.}
 \twocolitem{{\bf wxIMAGELIST\_DRAW\_SELECTED}}{Draw the image in selected state.}

-\twocolitem{{\bf wxIMAGELIST\_DRAW\_FOCUSED}}{Draw the image in a focussed state.}
+\twocolitem{{\bf wxIMAGELIST\_DRAW\_FOCUSED}}{Draw the image in a focused state.}

 \end{twocollist}
 }
 
 \docparam{solidBackground}{For optimisation - drawing can be faster if the function is told
 that the background is solid.}
 
 \end{twocollist}
 }
 
 \docparam{solidBackground}{For optimisation - drawing can be faster if the function is told
 that the background is solid.}
 

+\membersection{wxImageList::GetBitmap}\label{wximagelistgetbitmap}
+
+\constfunc{wxBitmap}{GetBitmap}{\param{int }{index}}
+
+Returns the bitmap corresponding to the given index.
+
+\membersection{wxImageList::GetIcon}\label{wximagelistgeticon}
+
+\constfunc{wxIcon}{GetIcon}{\param{int }{index}}
+
+Returns the icon corresponding to the given index.
+

 \membersection{wxImageList::GetImageCount}\label{wximagelistgetimagecount}
 
 \constfunc{int}{GetImageCount}{\void}
 
 Returns the number of images in the list.
 
 \membersection{wxImageList::GetImageCount}\label{wximagelistgetimagecount}
 
 \constfunc{int}{GetImageCount}{\void}
 
 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}}


@@ -137,6 +183,8 @@ Removes all the images in the list.
 
 Replaces the existing image with the new image.
 
 
 Replaces the existing image with the new image.
 

+Windows only.
+

 \func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}}
 
 Replaces the existing image with the new image.
 \func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}}
 
 Replaces the existing image with the new image.


@@ -151,10 +199,12 @@ Replaces the existing image with the new image.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the replacement was successful, FALSE otherwise.
+true if the replacement was successful, false otherwise.

 
 \wxheading{Remarks}
 
 The original bitmap or icon is not affected by the {\bf Replace} operation, and can be deleted afterwards.
 
 
 \wxheading{Remarks}
 
 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.}
+