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. 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 the bitmap currently used in the control. Notice that this method can
	85	be called even if \helpref{SetIcon}{wxstaticbitmapseticon} had been used.
	86
	87	\wxheading{See also}
	88
	89	\helpref{wxStaticBitmap::SetBitmap}{wxstaticbitmapsetbitmap}
	90
	91
	92	\membersection{wxStaticIcon::GetIcon}\label{wxstaticbitmapgeticon}
	93
	94	\constfunc{wxIcon}{GetIcon}{\void}
	95
	96	Returns the icon currently used in the control. Notice that this method can
	97	only be called if \helpref{SetIcon}{wxstaticbitmapseticon} had been used: an icon
	98	can't be retrieved from the control if a bitmap had been set (using
	99	\helpref{SetBitmap}{wxstaticbitmapsetbitmap}).
	100
	101	\wxheading{See also}
	102
	103	\helpref{wxStaticIcon::SetIcon}{wxstaticbitmapseticon}
	104
	105
	106	\membersection{wxStaticBitmap::SetBitmap}\label{wxstaticbitmapsetbitmap}
	107
	108	\func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{ label}}
	109
	110	Sets the bitmap label.
	111
	112	\wxheading{Parameters}
	113
	114	\docparam{label}{The new bitmap.}
	115
	116	\wxheading{See also}
	117
	118	\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
	119
	120
	121	\membersection{wxStaticIcon::SetIcon}\label{wxstaticbitmapseticon}
	122
	123	\func{virtual void}{SetIcon}{\param{const wxIcon\& }{ label}}
	124
	125	Sets the label to the given icon.
	126
	127	\wxheading{Parameters}
	128
	129	\docparam{label}{The new icon.}
	130
	131	\wxheading{See also}
	132
	133	\helpref{wxStaticIcon::GetIcon}{wxstaticbitmapgeticon}
	134