]> git.saurik.com Git - wxWidgets.git/blob - contrib/docs/latex/fl/toolwindow.tex
Tidied/commented FL header files, regenerated docs and filled out Category section.
[wxWidgets.git] / contrib / docs / latex / fl / toolwindow.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{wxToolWindow}}\label{wxtoolwindow}
8
9
10 A tool window is a special kind of frame that paints its own title, and
11 can be used to implement small floating windows.
12
13 \wxheading{Derived from}
14
15 \helpref{wxFrame}{wxframe}
16
17 \wxheading{Include files}
18
19 <toolwnd.h>
20
21 \wxheading{Data structures}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25
26 \membersection{wxToolWindow::wxToolWindow}\label{wxtoolwindowwxtoolwindow}
27
28 \func{}{wxToolWindow}{\void}
29
30 Default constructor.
31
32
33 \membersection{wxToolWindow::\destruct{wxToolWindow}}\label{wxtoolwindowdtor}
34
35 \func{}{\destruct{wxToolWindow}}{\void}
36
37 Destructor.
38
39
40 \membersection{wxToolWindow::AddMiniButton}\label{wxtoolwindowaddminibutton}
41
42 \func{void}{AddMiniButton}{\param{cbMiniButton* }{pBtn}}
43
44 Adds a button. Buttons are added in right-to-left order.
45
46
47 \membersection{wxToolWindow::AdjustRectPos}\label{wxtoolwindowadjustrectpos}
48
49 \func{void}{AdjustRectPos}{\param{const wxRect\& }{original}, \param{const wxSize\& }{newDim}, \param{wxRect\& }{newRect}}
50
51 Helper function.
52
53
54 \membersection{wxToolWindow::CalcResizedRect}\label{wxtoolwindowcalcresizedrect}
55
56 \func{void}{CalcResizedRect}{\param{wxRect\& }{rect}, \param{wxPoint\& }{delta}, \param{const wxSize\& }{minDim}}
57
58 Calculate resized rectangle.
59
60
61 \membersection{wxToolWindow::DrawHintRect}\label{wxtoolwindowdrawhintrect}
62
63 \func{void}{DrawHintRect}{\param{const wxRect\& }{r}}
64
65 Draws the hint rectangle.
66
67
68 \membersection{wxToolWindow::GetClient}\label{wxtoolwindowgetclient}
69
70 \func{wxWindow*}{GetClient}{\void}
71
72 Returns the client window.
73
74
75 \membersection{wxToolWindow::GetMinimalWndDim}\label{wxtoolwindowgetminimalwnddim}
76
77 \func{wxSize}{GetMinimalWndDim}{\void}
78
79 Helper function.
80
81
82 \membersection{wxToolWindow::GetPreferredSize}\label{wxtoolwindowgetpreferredsize}
83
84 \func{wxSize}{GetPreferredSize}{\param{const wxSize\& }{given}}
85
86 Returns the preferred size for the window.
87
88
89 \membersection{wxToolWindow::GetScrMousePos}\label{wxtoolwindowgetscrmousepos}
90
91 \func{void}{GetScrMousePos}{\param{wxMouseEvent\& }{event}, \param{wxPoint\& }{pos}}
92
93 Gets the mouse position in screen coordinates.
94
95
96 \membersection{wxToolWindow::GetScrWindowRect}\label{wxtoolwindowgetscrwindowrect}
97
98 \func{void}{GetScrWindowRect}{\param{wxRect\& }{r}}
99
100 Maps client coordinates to screen coordinates.
101
102
103 \membersection{wxToolWindow::HandleTitleClick}\label{wxtoolwindowhandletitleclick}
104
105 \func{bool}{HandleTitleClick}{\param{wxMouseEvent\& }{event}}
106
107 Handles clicking on the title. By default, does nothing.
108
109
110 \membersection{wxToolWindow::HitTestWindow}\label{wxtoolwindowhittestwindow}
111
112 \func{int}{HitTestWindow}{\param{wxMouseEvent\& }{event}}
113
114 Tests if the mouse position is in this window.
115
116
117 \membersection{wxToolWindow::LayoutMiniButtons}\label{wxtoolwindowlayoutminibuttons}
118
119 \func{void}{LayoutMiniButtons}{\void}
120
121 Lays out the buttons.
122
123
124 \membersection{wxToolWindow::OnEraseBackground}\label{wxtoolwindowonerasebackground}
125
126 \func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
127
128 Responds to an erase background event.
129
130
131 \membersection{wxToolWindow::OnLeftDown}\label{wxtoolwindowonleftdown}
132
133 \func{void}{OnLeftDown}{\param{wxMouseEvent\& }{event}}
134
135 Responds to a mouse left down event.
136
137
138 \membersection{wxToolWindow::OnLeftUp}\label{wxtoolwindowonleftup}
139
140 \func{void}{OnLeftUp}{\param{wxMouseEvent\& }{event}}
141
142 Responds to a mouse left up event.
143
144
145 \membersection{wxToolWindow::OnMiniButtonClicked}\label{wxtoolwindowonminibuttonclicked}
146
147 \func{void}{OnMiniButtonClicked}{\param{int }{btnIdx}}
148
149 Called when a mini button is clicked.
150 By default, does nothing.
151
152
153 \membersection{wxToolWindow::OnMotion}\label{wxtoolwindowonmotion}
154
155 \func{void}{OnMotion}{\param{wxMouseEvent\& }{event}}
156
157 Responds to a mouse move event.
158
159
160 \membersection{wxToolWindow::OnPaint}\label{wxtoolwindowonpaint}
161
162 \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
163
164 Responds to a paint event.
165
166
167 \membersection{wxToolWindow::OnSize}\label{wxtoolwindowonsize}
168
169 \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
170
171 Responds to a size event.
172
173
174 \membersection{wxToolWindow::SetClient}\label{wxtoolwindowsetclient}
175
176 \func{void}{SetClient}{\param{wxWindow* }{pWnd}}
177
178 Sets the client for this tool window.
179
180
181 \membersection{wxToolWindow::SetHintCursor}\label{wxtoolwindowsethintcursor}
182
183 \func{void}{SetHintCursor}{\param{int }{type}}
184
185 Sets the hint cursor.
186
187
188 \membersection{wxToolWindow::SetTitleFont}\label{wxtoolwindowsettitlefont}
189
190 \func{void}{SetTitleFont}{\param{wxFont\& }{font}}
191
192 Sets the title font.
193