git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/fl/newbitmapbutton.tex

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen $Revision$ from
	3	% newbmpbtn.h at 21/Jan/02 21:14:19
	4	%
	5
	6
	7	\section{\class{wxNewBitmapButton}}\label{wxnewbitmapbutton}
	8
	9
	10	This is an alternative class to wxBitmapButton. It is used
	11	in the implementation of dynamic toolbars.
	12
	13	\wxheading{Derived from}
	14
	15	\helpref{wxPanel}{wxpanel}
	16
	17	\wxheading{Include files}
	18
	19	<newbmpbtn.h>
	20
	21	\wxheading{Data structures}
	22
	23	\latexignore{\rtfignore{\wxheading{Members}}}
	24
	25
	26	\membersection{wxNewBitmapButton::wxNewBitmapButton}\label{wxnewbitmapbuttonwxnewbitmapbutton}
	27
	28	\func{}{wxNewBitmapButton}{\param{const wxBitmap\& }{labelBitmap = wxNullBitmap}, \param{const wxString\& }{labelText = ""}, \param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{bool }{isFlat = TRUE}, \param{int }{firedEventType = wxEVT\_COMMAND\_MENU\_SELECTED}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}, \param{bool }{isSticky = FALSE}}
	29
	30	Constructor.
	31
	32
	33	\func{}{wxNewBitmapButton}{\param{const wxString\& }{bitmapFileName}, \param{const wxBitmapType }{bitmapFileType = wxBITMAP\_TYPE\_BMP}, \param{const wxString\& }{labelText = ""}, \param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{bool }{isFlat = TRUE}, \param{int }{firedEventType = wxEVT\_COMMAND\_MENU\_SELECTED}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}, \param{bool }{isSticky = FALSE}}
	34
	35	Use this constructor if buttons have to be persistant
	36
	37
	38	\membersection{wxNewBitmapButton::\destruct{wxNewBitmapButton}}\label{wxnewbitmapbuttondtor}
	39
	40	\func{}{\destruct{wxNewBitmapButton}}{\void}
	41
	42	Destructor.
	43
	44
	45	\membersection{wxNewBitmapButton::DestroyLabels}\label{wxnewbitmapbuttondestroylabels}
	46
	47	\func{void}{DestroyLabels}{\void}
	48
	49	Internal function for destroying labels.
	50
	51
	52	\membersection{wxNewBitmapButton::DrawDecorations}\label{wxnewbitmapbuttondrawdecorations}
	53
	54	\func{void}{DrawDecorations}{\param{wxDC\& }{dc}}
	55
	56	Draws the decorations.
	57
	58
	59	\membersection{wxNewBitmapButton::DrawLabel}\label{wxnewbitmapbuttondrawlabel}
	60
	61	\func{void}{DrawLabel}{\param{wxDC\& }{dc}}
	62
	63	Draws the label.
	64
	65
	66	\membersection{wxNewBitmapButton::DrawShade}\label{wxnewbitmapbuttondrawshade}
	67
	68	\func{void}{DrawShade}{\param{int }{outerLevel}, \param{wxDC\& }{dc}, \param{wxPen\& }{upperLeftSidePen}, \param{wxPen\& }{lowerRightSidePen}}
	69
	70	Draws shading on the button.
	71
	72
	73	\membersection{wxNewBitmapButton::GetStateLabel}\label{wxnewbitmapbuttongetstatelabel}
	74
	75	\func{wxBitmap*}{GetStateLabel}{\void}
	76
	77	Returns the label that matches the current button state.
	78
	79
	80	\membersection{wxNewBitmapButton::IsInWindow}\label{wxnewbitmapbuttonisinwindow}
	81
	82	\func{bool}{IsInWindow}{\param{int }{x}, \param{int }{y}}
	83
	84	Returns TRUE if the given point is in the window.
	85
	86
	87	\membersection{wxNewBitmapButton::OnEraseBackground}\label{wxnewbitmapbuttononerasebackground}
	88
	89	\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
	90
	91	Responds to an erase background event.
	92
	93
	94	\membersection{wxNewBitmapButton::OnKillFocus}\label{wxnewbitmapbuttononkillfocus}
	95
	96	\func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
	97
	98	Responds to a kill focus event.
	99
	100
	101	\membersection{wxNewBitmapButton::OnLButtonDown}\label{wxnewbitmapbuttononlbuttondown}
	102
	103	\func{void}{OnLButtonDown}{\param{wxMouseEvent\& }{event}}
	104
	105	Responds to a left mouse button down event.
	106
	107
	108	\membersection{wxNewBitmapButton::OnLButtonUp}\label{wxnewbitmapbuttononlbuttonup}
	109
	110	\func{void}{OnLButtonUp}{\param{wxMouseEvent\& }{event}}
	111
	112	Responds to a left mouse button up event.
	113
	114
	115	\membersection{wxNewBitmapButton::OnMouseMove}\label{wxnewbitmapbuttononmousemove}
	116
	117	\func{void}{OnMouseMove}{\param{wxMouseEvent\& }{event}}
	118
	119	Responds to a mouse move event.
	120
	121
	122	\membersection{wxNewBitmapButton::OnPaint}\label{wxnewbitmapbuttononpaint}
	123
	124	\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
	125
	126	Responds to a paint event.
	127
	128
	129	\membersection{wxNewBitmapButton::OnSize}\label{wxnewbitmapbuttononsize}
	130
	131	\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
	132
	133	Responds to a size event.
	134
	135
	136	\membersection{wxNewBitmapButton::RenderAllLabelImages}\label{wxnewbitmapbuttonrenderalllabelimages}
	137
	138	\func{void}{RenderAllLabelImages}{\void}
	139
	140	Renders label images.
	141
	142
	143	\membersection{wxNewBitmapButton::RenderLabelImage}\label{wxnewbitmapbuttonrenderlabelimage}
	144
	145	\func{void}{RenderLabelImage}{\param{wxBitmap\& }{destBmp}, \param{wxBitmap }{srcBmp}, \param{bool }{isEnabled = TRUE}, \param{bool }{isPressed = FALSE}}
	146
	147	Renders the label image.
	148
	149
	150	\membersection{wxNewBitmapButton::RenderLabelImages}\label{wxnewbitmapbuttonrenderlabelimages}
	151
	152	\func{void}{RenderLabelImages}{\void}
	153
	154	Renders label images.
	155
	156
	157	\membersection{wxNewBitmapButton::Reshape}\label{wxnewbitmapbuttonreshape}
	158
	159	\func{void}{Reshape}{\void}
	160
	161	This function should be called after Create. It renders the labels, having
	162	reloaded the button image if necessary.
	163
	164
	165	\membersection{wxNewBitmapButton::SetAlignments}\label{wxnewbitmapbuttonsetalignments}
	166
	167	\func{void}{SetAlignments}{\param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}}
	168
	169	Sets the text alignment and margins.
	170
	171
	172	\membersection{wxNewBitmapButton::SetLabel}\label{wxnewbitmapbuttonsetlabel}
	173
	174	\func{void}{SetLabel}{\param{const wxBitmap\& }{labelBitmap}, \param{const wxString\& }{labelText = ""}}
	175
	176	Sets the label and optionally label text.
	177