contrib/docs/latex/fl/newbitmapbutton.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % newbmpbtn.h at 05/Jan/02 22:50:57
   4 %
   5
   6
   7 \section{\class{wxNewBitmapButton}}\label{wxnewbitmapbutton}
   8
   9
  10 alternative class for wxBmpButton
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxPanel}{wxpanel}
  15
  16 \wxheading{Data structures}
  17
  18 \latexignore{\rtfignore{\wxheading{Members}}}
  19
  20
  21 \membersection{wxNewBitmapButton::wxNewBitmapButton}\label{wxnewbitmapbuttonwxnewbitmapbutton}
  22
  23 \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}}
  24
  25
  26 \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}}
  27
  28 use this constructor if buttons have to be persistant
  29
  30
  31 \membersection{wxNewBitmapButton::\destruct{wxNewBitmapButton}}\label{wxnewbitmapbuttondtor}
  32
  33 \func{}{\destruct{wxNewBitmapButton}}{\void}
  34
  35
  36 \membersection{wxNewBitmapButton::DestroyLabels}\label{wxnewbitmapbuttondestroylabels}
  37
  38 \func{void}{DestroyLabels}{\void}
  39
  40
  41 \membersection{wxNewBitmapButton::DrawDecorations}\label{wxnewbitmapbuttondrawdecorations}
  42
  43 \func{void}{DrawDecorations}{\param{wxDC\& }{dc}}
  44
  45
  46 \membersection{wxNewBitmapButton::DrawLabel}\label{wxnewbitmapbuttondrawlabel}
  47
  48 \func{void}{DrawLabel}{\param{wxDC\& }{dc}}
  49
  50
  51 \membersection{wxNewBitmapButton::DrawShade}\label{wxnewbitmapbuttondrawshade}
  52
  53 \func{void}{DrawShade}{\param{int }{outerLevel}, \param{wxDC\& }{dc}, \param{wxPen\& }{upperLeftSidePen}, \param{wxPen\& }{lowerRightSidePen}}
  54
  55
  56 \membersection{wxNewBitmapButton::GetStateLabel}\label{wxnewbitmapbuttongetstatelabel}
  57
  58 \func{wxBitmap*}{GetStateLabel}{\void}
  59
  60 returns the label which match the current button state
  61
  62
  63 \membersection{wxNewBitmapButton::IsInWindow}\label{wxnewbitmapbuttonisinwindow}
  64
  65 \func{bool}{IsInWindow}{\param{int }{x}, \param{int }{y}}
  66
  67
  68 \membersection{wxNewBitmapButton::OnEraseBackground}\label{wxnewbitmapbuttononerasebackground}
  69
  70 \func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
  71
  72
  73 \membersection{wxNewBitmapButton::OnKillFocus}\label{wxnewbitmapbuttononkillfocus}
  74
  75 \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
  76
  77
  78 \membersection{wxNewBitmapButton::OnLButtonDown}\label{wxnewbitmapbuttononlbuttondown}
  79
  80 \func{void}{OnLButtonDown}{\param{wxMouseEvent\& }{event}}
  81
  82 event handlers
  83
  84
  85 \membersection{wxNewBitmapButton::OnLButtonUp}\label{wxnewbitmapbuttononlbuttonup}
  86
  87 \func{void}{OnLButtonUp}{\param{wxMouseEvent\& }{event}}
  88
  89
  90 \membersection{wxNewBitmapButton::OnMouseMove}\label{wxnewbitmapbuttononmousemove}
  91
  92 \func{void}{OnMouseMove}{\param{wxMouseEvent\& }{event}}
  93
  94
  95 \membersection{wxNewBitmapButton::OnPaint}\label{wxnewbitmapbuttononpaint}
  96
  97 \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
  98
  99
 100 \membersection{wxNewBitmapButton::OnSize}\label{wxnewbitmapbuttononsize}
 101
 102 \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
 103
 104
 105 \membersection{wxNewBitmapButton::RenderAllLabelImages}\label{wxnewbitmapbuttonrenderalllabelimages}
 106
 107 \func{void}{RenderAllLabelImages}{\void}
 108
 109
 110 \membersection{wxNewBitmapButton::RenderLabelImage}\label{wxnewbitmapbuttonrenderlabelimage}
 111
 112 \func{void}{RenderLabelImage}{\param{wxBitmap*\& }{destBmp}, \param{wxBitmap* }{srcBmp}, \param{bool }{isEnabled = TRUE}, \param{bool }{isPressed = FALSE}}
 113
 114
 115 \membersection{wxNewBitmapButton::RenderLabelImages}\label{wxnewbitmapbuttonrenderlabelimages}
 116
 117 \func{void}{RenderLabelImages}{\void}
 118
 119
 120 \membersection{wxNewBitmapButton::Reshape}\label{wxnewbitmapbuttonreshape}
 121
 122 \func{void}{Reshape}{\void}
 123
 124 should be called after Create();
 125
 126
 127 \membersection{wxNewBitmapButton::SetAlignments}\label{wxnewbitmapbuttonsetalignments}
 128
 129 \func{void}{SetAlignments}{\param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}}
 130
 131
 132 \membersection{wxNewBitmapButton::SetLabel}\label{wxnewbitmapbuttonsetlabel}
 133
 134 \func{void}{SetLabel}{\param{const wxBitmap\& }{labelBitmap}, \param{const wxString\& }{labelText = ""}}
 135
 136 overridables
 137