contrib/docs/latex/fl/cbfloatedbarwindow.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % toolwnd.h at 21/Jan/02 21:14:17
   4 %
   5
   6
   7 \section{\class{cbFloatedBarWindow}}\label{cbfloatedbarwindow}
   8
   9
  10 cbFloatedBarWindow is a kind of wxToolWindow,
  11 implementing floating toolbars.
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{wxToolWindow}{wxtoolwindow}
  16
  17 \wxheading{Include files}
  18
  19 <toolwnd.h>
  20
  21 \wxheading{Data structures}
  22
  23 \latexignore{\rtfignore{\wxheading{Members}}}
  24
  25
  26 \membersection{cbFloatedBarWindow::cbFloatedBarWindow}\label{cbfloatedbarwindowcbfloatedbarwindow}
  27
  28 \func{}{cbFloatedBarWindow}{\void}
  29
  30 Default constructor.
  31
  32
  33 \membersection{cbFloatedBarWindow::GetBar}\label{cbfloatedbarwindowgetbar}
  34
  35 \func{cbBarInfo*}{GetBar}{\void}
  36
  37 Returns the bar information for this window.
  38
  39
  40 \membersection{cbFloatedBarWindow::GetPreferredSize}\label{cbfloatedbarwindowgetpreferredsize}
  41
  42 \func{wxSize}{GetPreferredSize}{\param{const wxSize\& }{given}}
  43
  44 Overridden function returning the preferred size.
  45
  46
  47 \membersection{cbFloatedBarWindow::HandleTitleClick}\label{cbfloatedbarwindowhandletitleclick}
  48
  49 \func{bool}{HandleTitleClick}{\param{wxMouseEvent\& }{event}}
  50
  51 Overridden function responding to mouse button clicks on the titlebar.
  52
  53
  54 \membersection{cbFloatedBarWindow::OnDblClick}\label{cbfloatedbarwindowondblclick}
  55
  56 \func{void}{OnDblClick}{\param{wxMouseEvent\& }{event}}
  57
  58 Responds to double-click mouse events.
  59
  60
  61 \membersection{cbFloatedBarWindow::OnMiniButtonClicked}\label{cbfloatedbarwindowonminibuttonclicked}
  62
  63 \func{void}{OnMiniButtonClicked}{\param{int }{btnIdx}}
  64
  65 Overridden function responding to mouse clicks on mini-buttons.
  66
  67
  68 \membersection{cbFloatedBarWindow::PositionFloatedWnd}\label{cbfloatedbarwindowpositionfloatedwnd}
  69
  70 \func{void}{PositionFloatedWnd}{\param{int }{scrX}, \param{int }{scrY}, \param{int }{width}, \param{int }{height}}
  71
  72 Position the floating window. The given coordinates
  73 are those of the bar itself; the floated container window's
  74 position and size are ajusted accordingly.
  75
  76
  77 \membersection{cbFloatedBarWindow::SetBar}\label{cbfloatedbarwindowsetbar}
  78
  79 \func{void}{SetBar}{\param{cbBarInfo* }{pBar}}
  80
  81 Sets the bar information for this window.
  82
  83
  84 \membersection{cbFloatedBarWindow::SetLayout}\label{cbfloatedbarwindowsetlayout}
  85
  86 \func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
  87
  88 Sets the layout for this window.
  89