patch 1306473

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

diff --git a/docs/latex/wx/statbmp.tex b/docs/latex/wx/statbmp.tex
index 201718e4cc52f746b6c53fef7ad26d846207398b..7c24e752143e1cb1e0ba4b42d0ab34f0ef2e271f 100644 (file)
--- a/docs/latex/wx/statbmp.tex
+++ b/docs/latex/wx/statbmp.tex
@@ -1,6 +1,10 @@
 \section{\class{wxStaticBitmap}}\label{wxstaticbitmap}
 
 \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}
 
 
 \wxheading{Derived from}
 


@@ -9,6 +13,10 @@ A static bitmap control displays a bitmap.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

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

 \wxheading{Window styles}
 
 There are no special styles for this control.
 \wxheading{Window styles}
 
 There are no special styles for this control.


@@ -26,6 +34,7 @@ palette problems.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxStaticBitmap::wxStaticBitmap}\label{wxstaticbitmapconstr}
 
 \func{}{wxStaticBitmap}{\void}
 \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
 Default constructor.
 
 \func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp

-\param{const wxBitmap\& }{label = ``"}, \param{const wxPoint\& }{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.
 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
 
 Constructor, creating and showing a text control.


@@ -58,14 +67,16 @@ Constructor, creating and showing a text control.
 
 \helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate}
 
 
 \helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate}
 

+

 \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp

-\param{const wxBitmap\& }{label = ``"}, \param{const wxPoint\& }{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}.
 
 \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}
 \membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap}
 
 \constfunc{wxBitmap\&}{GetBitmap}{\void}


@@ -76,6 +87,7 @@ Returns a reference to the label bitmap.
 
 \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
 
 
 \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
 

+

 \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 
 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
 \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 
 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}


@@ -88,5 +100,5 @@ Sets the bitmap label.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\docparam{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
+\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}