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