git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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