← Back to branch summary

~ubuntu-dev/wxwidgets2.6/upstream-debian

« back to all changes in this revision

Viewing changes to docs/latex/wx/statbmp.tex

  • Committer: Daniel T Chen
  • Date: 2006-06-26 10:15:11 UTC
  • Revision ID: crimsun@ubuntu.com-20060626101511-a4436cec4c6d9b35
Import Debian 2.6.3.2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
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{Window styles}
 
21
 
 
22
There are no special styles for this control.
 
23
 
 
24
See also \helpref{window styles overview}{windowstyles}.
 
25
 
 
26
\wxheading{See also}
 
27
 
 
28
\helpref{wxStaticBitmap}{wxstaticbitmap}, \helpref{wxStaticBox}{wxstaticbox}
 
29
 
 
30
\wxheading{Remarks}
 
31
 
 
32
The bitmap to be displayed should have a small number of colours, such as 16, to avoid
 
33
palette problems.
 
34
 
 
35
\latexignore{\rtfignore{\wxheading{Members}}}
 
36
 
 
37
 
 
38
\membersection{wxStaticBitmap::wxStaticBitmap}\label{wxstaticbitmapconstr}
 
39
 
 
40
\func{}{wxStaticBitmap}{\void}
 
41
 
 
42
Default constructor.
 
43
 
 
44
\func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 
45
\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 
46
\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
 
47
 
 
48
Constructor, creating and showing a text control.
 
49
 
 
50
\wxheading{Parameters}
 
51
 
 
52
\docparam{parent}{Parent window. Should not be NULL.}
 
53
 
 
54
\docparam{id}{Control identifier. A value of -1 denotes a default value.}
 
55
 
 
56
\docparam{label}{Bitmap label.}
 
57
 
 
58
\docparam{pos}{Window position.}
 
59
 
 
60
\docparam{size}{Window size.}
 
61
 
 
62
\docparam{style}{Window style. See \helpref{wxStaticBitmap}{wxstaticbitmap}.}
 
63
 
 
64
\docparam{name}{Window name.}
 
65
 
 
66
\wxheading{See also}
 
67
 
 
68
\helpref{wxStaticBitmap::Create}{wxstaticbitmapcreate}
 
69
 
 
70
 
 
71
\membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
 
72
 
 
73
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 
74
\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 
75
\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
 
76
 
 
77
Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}.
 
78
 
 
79
 
 
80
\membersection{wxStaticBitmap::GetBitmap}\label{wxstaticbitmapgetbitmap}
 
81
 
 
82
\constfunc{wxBitmap\&}{GetBitmap}{\void}
 
83
 
 
84
Returns a reference to the label bitmap.
 
85
 
 
86
\wxheading{See also}
 
87
 
 
88
\helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
 
89
 
 
90
 
 
91
\membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
 
92
 
 
93
\func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
 
94
 
 
95
Sets the bitmap label.
 
96
 
 
97
\wxheading{Parameters}
 
98
 
 
99
\docparam{label}{The new bitmap.}
 
100
 
 
101
\wxheading{See also}
 
102
 
 
103
\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
 
104