projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxStaticBitmap}}\label{wxstaticbitmap} |
| 2 | ||
| 3 | A static bitmap control displays a bitmap. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | \helpref{wxControl}{wxcontrol}\\ | |
| 8 | \helpref{wxWindow}{wxwindow}\\ | |
| 9 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 10 | \helpref{wxObject}{wxobject} | |
| 11 | ||
| 954b8ae6 JS |
12 | \wxheading{Include files} |
| 13 | ||
| 14 | <wx/statbmp.h> | |
| 15 | ||
| a660d684 KB |
16 | \wxheading{Window styles} |
| 17 | ||
| 18 | There are no special styles for this control. | |
| 19 | ||
| 20 | See also \helpref{window styles overview}{windowstyles}. | |
| 21 | ||
| 22 | \wxheading{See also} | |
| 23 | ||
| 24 | \helpref{wxStaticBitmap}{wxstaticbitmap}, \helpref{wxStaticBox}{wxstaticbox} | |
| 25 | ||
| 26 | \wxheading{Remarks} | |
| 27 | ||
| 28 | The bitmap to be displayed should have a small number of colours, such as 16, to avoid | |
| 29 | palette problems. | |
| 30 | ||
| 31 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 32 | ||
| 33 | \membersection{wxStaticBitmap::wxStaticBitmap}\label{wxstaticbitmapconstr} | |
| 34 | ||
| 35 | \func{}{wxStaticBitmap}{\void} | |
| 36 | ||
| 37 | Default constructor. | |
| 38 | ||
| eaaa6a06 | 39 | \func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp |
| 2b5f62a0 | 40 | \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp |
| eaaa6a06 | 41 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}} |
| a660d684 KB |
42 | |
| 43 | Constructor, creating and showing a text control. | |
| 44 | ||
| 45 | \wxheading{Parameters} | |
| 46 | ||
| 47 | \docparam{parent}{Parent window. Should not be NULL.} | |
| 48 | ||
| 49 | \docparam{id}{Control identifier. A value of -1 denotes a default value.} | |
| 50 | ||
| 51 | \docparam{label}{Bitmap label.} | |
| 52 | ||
| 53 | \docparam{pos}{Window position.} | |
| 54 | ||
| 55 | \docparam{size}{Window size.} | |
| 56 | ||
| 57 | \docparam{style}{Window style. See \helpref{wxStaticBitmap}{wxstaticbitmap}.} | |
| 58 | ||
| 59 | \docparam{name}{Window name.} | |
| 60 | ||
| 61 | \wxheading{See also} | |
| 62 | ||
| 63 | \helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate} | |
| 64 | ||
| 65 | \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate} | |
| 66 | ||
| eaaa6a06 | 67 | \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp |
| 2b5f62a0 | 68 | \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp |
| eaaa6a06 | 69 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}} |
| a660d684 KB |
70 | |
| 71 | Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}. | |
| 72 | ||
| 73 | \membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap} | |
| 74 | ||
| 75 | \constfunc{wxBitmap\&}{GetBitmap}{\void} | |
| 76 | ||
| 77 | Returns a reference to the label bitmap. | |
| 78 | ||
| 79 | \wxheading{See also} | |
| 80 | ||
| 81 | \helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap} | |
| 82 | ||
| 83 | \membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap} | |
| 84 | ||
| 85 | \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}} | |
| 86 | ||
| 87 | Sets the bitmap label. | |
| 88 | ||
| 89 | \wxheading{Parameters} | |
| 90 | ||
| 91 | \docparam{label}{The new bitmap.} | |
| 92 | ||
| 93 | \wxheading{See also} | |
| 94 | ||
| fa482912 | 95 | \helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap} |
| a660d684 | 96 |