corrected ancient event type constant in an example

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

diff --git a/docs/latex/wx/statbmp.tex b/docs/latex/wx/statbmp.tex
index f6afca75b4350c06d3337d339c993ac3ae3a8e61..2b88fd850628ba5df24227fb7f9de74abf04b204 100644 (file)
--- a/docs/latex/wx/statbmp.tex
+++ b/docs/latex/wx/statbmp.tex
@@ -1,6 +1,10 @@
 \section{\class{wxStaticBitmap}}\label{wxstaticbitmap}
 
-A static bitmap control displays a bitmap.
+A static bitmap control displays a bitmap. It is meant for display of the
+small icons in the dialog boxes and is not meant to be a general purpose image
+display control. In particular, under Windows 9x the size of bitmap is limited
+to $64*64$ pixels and thus you should use your own control if you want to
+display larger images portably.
 
 \wxheading{Derived from}
 
@@ -9,6 +13,10 @@ A static bitmap control displays a bitmap.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/statbmp.h>
+
 \wxheading{Window styles}
 
 There are no special styles for this control.
@@ -26,6 +34,7 @@ palette problems.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxStaticBitmap::wxStaticBitmap}\label{wxstaticbitmapconstr}
 
 \func{}{wxStaticBitmap}{\void}
@@ -33,7 +42,7 @@ palette problems.
 Default constructor.
 
 \func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
-\param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
 
 Constructor, creating and showing a text control.
@@ -58,24 +67,42 @@ Constructor, creating and showing a text control.
 
 \helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate}
 
+
 \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
-\param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
 
 Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}.
 
+
 \membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap}
 
-\constfunc{wxBitmap\&}{GetBitmap}{\void}
+\constfunc{wxBitmap}{GetBitmap}{\void}
 
-Returns a reference to the label bitmap.
+Returns the bitmap currently used in the control. Notice that this method can
+be called even if \helpref{SetIcon}{wxstaticbitmapseticon} had been used.
 
 \wxheading{See also}
 
 \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
 
+
+\membersection{wxStaticIcon::GetIcon}\label{wxstaticbitmapgeticon}
+
+\constfunc{wxIcon}{GetIcon}{\void}
+
+Returns the icon currently used in the control. Notice that this method can
+only be called if \helpref{SetIcon}{wxstaticbitmapseticon} had been used: an icon
+can't be retrieved from the control if a bitmap had been set (using 
+\helpref{SetBitmap}{wxstaticbitmapsetbitmap}).
+
+\wxheading{See also}
+
+\helpref{wxStaticIcon::SetIcon}{wxstaticbitmapseticon}
+
+
 \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 
 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
@@ -88,5 +115,20 @@ Sets the bitmap label.
 
 \wxheading{See also}
 
-\docparam{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
+\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
+
+
+\membersection{wxStaticIcon::SetIcon}\label{wxstaticbitmapseticon}
+
+\func{virtual void}{SetIcon}{\param{const wxIcon\& }{ label}}
+
+Sets the label to the given icon.
+
+\wxheading{Parameters}
+
+\docparam{label}{The new icon.}
+
+\wxheading{See also}
+
+\helpref{wxStaticIcon::GetIcon}{wxstaticbitmapgeticon}