docs/latex/wx/statbmp.tex

   1 \section{\class{wxStaticBitmap}}\label{wxstaticbitmap}
   2
   3 A static bitmap control displays a bitmap. It is meant for display of the
   4 small icons in the dialog boxes and is not meant to be a general purpose image
   5 display control. In particular, under Windows 9x the size of bitmap is limited
   6 to $64*64$ pixels and thus you should use your own control if you want to
   7 display larger images portably.
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxControl}{wxcontrol}\\
  12 \helpref{wxWindow}{wxwindow}\\
  13 \helpref{wxEvtHandler}{wxevthandler}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/statbmp.h>
  19
  20 \wxheading{Library}
  21
  22 \helpref{wxCore}{librarieslist}
  23
  24 \wxheading{Window styles}
  25
  26 There are no special styles for this control.
  27
  28 See also \helpref{window styles overview}{windowstyles}.
  29
  30 \wxheading{See also}
  31
  32 \helpref{wxStaticBitmap}{wxstaticbitmap}, \helpref{wxStaticBox}{wxstaticbox}
  33
  34 \wxheading{Remarks}
  35
  36 The bitmap to be displayed should have a small number of colours, such as 16, to avoid
  37 palette problems.
  38
  39 \latexignore{\rtfignore{\wxheading{Members}}}
  40
  41
  42 \membersection{wxStaticBitmap::wxStaticBitmap}\label{wxstaticbitmapconstr}
  43
  44 \func{}{wxStaticBitmap}{\void}
  45
  46 Default constructor.
  47
  48 \func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
  49 \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  50 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
  51
  52 Constructor, creating and showing a static bitmap control.
  53
  54 \wxheading{Parameters}
  55
  56 \docparam{parent}{Parent window. Should not be NULL.}
  57
  58 \docparam{id}{Control identifier. A value of -1 denotes a default value.}
  59
  60 \docparam{label}{Bitmap label.}
  61
  62 \docparam{pos}{Window position.}
  63
  64 \docparam{size}{Window size.}
  65
  66 \docparam{style}{Window style. See \helpref{wxStaticBitmap}{wxstaticbitmap}.}
  67
  68 \docparam{name}{Window name.}
  69
  70 \wxheading{See also}
  71
  72 \helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate}
  73
  74
  75 \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
  76
  77 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
  78 \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  79 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
  80
  81 Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}.
  82
  83
  84 \membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap}
  85
  86 \constfunc{wxBitmap}{GetBitmap}{\void}
  87
  88 Returns the bitmap currently used in the control. Notice that this method can
  89 be called even if \helpref{SetIcon}{wxstaticbitmapseticon} had been used.
  90
  91 \wxheading{See also}
  92
  93 \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
  94
  95
  96 \membersection{wxStaticBitmap::GetIcon}\label{wxstaticbitmapgeticon}
  97
  98 \constfunc{wxIcon}{GetIcon}{\void}
  99
 100 Returns the icon currently used in the control. Notice that this method can
 101 only be called if \helpref{SetIcon}{wxstaticbitmapseticon} had been used: an icon
 102 can't be retrieved from the control if a bitmap had been set (using
 103 \helpref{SetBitmap}{wxstaticbitmapsetbitmap}).
 104
 105 \wxheading{See also}
 106
 107 \helpref{wxStaticBitmap::SetIcon}{wxstaticbitmapseticon}
 108
 109
 110 \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 111
 112 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
 113
 114 Sets the bitmap label.
 115
 116 \wxheading{Parameters}
 117
 118 \docparam{label}{The new bitmap.}
 119
 120 \wxheading{See also}
 121
 122 \helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
 123
 124
 125 \membersection{wxStaticBitmap::SetIcon}\label{wxstaticbitmapseticon}
 126
 127 \func{virtual void}{SetIcon}{\param{const wxIcon\& }{ label}}
 128
 129 Sets the label to the given icon.
 130
 131 \wxheading{Parameters}
 132
 133 \docparam{label}{The new icon.}
 134
 135 \wxheading{See also}
 136
 137 \helpref{wxStaticBitmap::GetIcon}{wxstaticbitmapgeticon}
 138