]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/toolbar.tex
Removed some old doc targets
[wxWidgets.git] / docs / latex / wx / toolbar.tex
1 \section{\class{wxToolBar}}\label{wxtoolbar}
2
3 The name wxToolBar is defined to be a synonym for one of the following classes:
4
5 \begin{itemize}\itemsep=0pt
6 \item {\bf wxToolBar95} The native Windows 95 toolbar. Used on Windows 95, NT 4 and above.
7 \item {\bf wxToolBarMSW} A Windows implementation. Used on 16-bit Windows.
8 \item {\bf wxToolBarGTK} The GTK toolbar.
9 \item {\bf wxToolBarSimple} A simple implementation, with scrolling.
10 Used on platforms with no native toolbar control, or where scrolling is required.
11 \end{itemize}
12
13 Note that the base class {\bf wxToolBarBase} defines
14 automatic scrolling management functionality which is similar
15 to \helpref{wxScrolledWindow}{wxscrolledwindow}, so please refer to this class also.
16 Not all toolbars support scrolling, but wxToolBarSimple does.
17
18 \wxheading{Derived from}
19
20 wxToolBarBase\\
21 \helpref{wxControl}{wxcontrol}\\
22 \helpref{wxWindow}{wxwindow}\\
23 \helpref{wxEvtHandler}{wxevthandler}\\
24 \helpref{wxObject}{wxobject}
25
26 \wxheading{Include files}
27
28 <wx/toolbar.h> (to allow wxWindows to select an appropriate toolbar class)\\
29 <wx/tbarbase.h> (the base class)\\
30 <wx/tbarmsw.h> (the non-Windows 95 Windows toolbar class)\\
31 <wx/tbar95.h> (the Windows 95/98 toolbar class)\\
32 <wx/tbarsmpl.h> (the generic simple toolbar class)
33
34 \wxheading{Remarks}
35
36 You may also create a toolbar that is managed by the frame, by
37 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
38
39 Due to the use of native toolbars on the various platforms, certain adaptions will
40 often have to be made in order to get optimal look on all platforms as some platforms
41 ignore the values for explicit placement and use their own layout and the meaning
42 of a "separator" is a vertical line under Windows95 vs. simple space under GTK etc.
43
44 {\bf wxToolBar95:} Note that this toolbar paints tools to reflect user-selected colours.
45
46 \wxheading{Window styles}
47
48 \twocolwidtha{5cm}
49 \begin{twocollist}\itemsep=0pt
50 \twocolitem{\windowstyle{wxTB\_FLAT}}{Gives the toolbar a flat look (Windows and GTK only).}
51 \twocolitem{\windowstyle{wxTB\_DOCKABLE}}{Makes the toolbar floatable and dockable (GTK only).}
52 \twocolitem{\windowstyle{wxTB\_HORIZONTAL}}{Specifies horizontal layout (default).}
53 \twocolitem{\windowstyle{wxTB\_VERTICAL}}{Specifies vertical layout.}
54 \twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Only for wxToolBarSimple: gives a mild 3D look to its buttons.}
55 \twocolitem{\windowstyle{wxTB\_TEXT}}{Show the text in the toolbar buttons; by default only icons are shown.}
56 \twocolitem{\windowstyle{wxTB\_NOICONS}}{Specifies no icons in the toolbar buttons; by default they are shown.}
57 \twocolitem{\windowstyle{wxTB\_NODIVIDER}}{Specifies no divider (border) above the toolbar (Windows only).}
58 \twocolitem{\windowstyle{wxTB\_NOALIGN}}{Specifies no alignment with the parent window (Windows only, not very useful).}
59 \twocolitem{\windowstyle{wxTB\_HORZ\_LAYOUT}}{Show the text and the icons alongside, not vertically stacked (Windows and GTK
60 2 only). This style must be used with wxTB\_TEXT.}
61 \twocolitem{\windowstyle{wxTB\_HORZ\_TEXT}}{Combination of wxTB\_HORZ\_LAYOUT and wxTB\_TEXT.}
62 \end{twocollist}
63
64 See also \helpref{window styles overview}{windowstyles}. Note that the Win32
65 native toolbar ignores {\tt wxTB\_NOICONS} style. Also, toggling the
66 {\tt wxTB\_TEXT} works only if the style was initially on.
67
68 \wxheading{Event handling}
69
70 The toolbar class emits menu commands in the same was that a frame menubar does,
71 so you can use one EVT\_MENU macro for both a menu item and a toolbar button.
72 The event handler functions take a wxCommandEvent argument. For most event macros,
73 the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar
74 window is passed and the tool id is retrieved from the wxCommandEvent.
75 This is because the id may be -1 when the mouse moves off a tool, and -1 is not
76 allowed as an identifier in the event system.
77
78 Note that tool commands (and UI update events for tools) are first sent to
79 the focus window within the frame that contains the toolbar. If no window within the frame has the focus,
80 then the events are sent directly to the toolbar (and up the hierarchy to the
81 frame, depending on where the application has put its event handlers). This allows command and UI update
82 handling to be processed by specific windows and controls, and not necessarily
83 by the application frame.
84
85 \twocolwidtha{7cm}
86 \begin{twocollist}\itemsep=0pt
87 \twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
88 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
89 \twocolitem{{\bf EVT\_MENU(id, func)}}{The same as EVT\_TOOL.}
90 \twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
91 for a range id identifiers. Pass the ids of the tools.}
92 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{The same as EVT\_TOOL\_RANGE.}
93 \twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
94 Pass the id of the tool.}
95 \twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
96 for a range of ids. Pass the ids of the tools.}
97 \twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
98 Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool.}
99 \end{twocollist}
100
101 \wxheading{See also}
102
103 \overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
104 \helpref{wxScrolledWindow}{wxscrolledwindow}
105
106 \latexignore{\rtfignore{\wxheading{Members}}}
107
108 \membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
109
110 \func{}{wxToolBar}{\void}
111
112 Default constructor.
113
114 \func{}{wxToolBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
115 \param{const wxPoint\& }{pos = wxDefaultPosition},
116 \param{const wxSize\& }{size = wxDefaultSize},
117 \param{long }{style = wxTB\_HORIZONTAL \pipe wxNO\_BORDER},
118 \param{const wxString\& }{name = wxPanelNameStr}}
119
120 Constructs a toolbar.
121
122 \wxheading{Parameters}
123
124 \docparam{parent}{Pointer to a parent window.}
125
126 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
127
128 \docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows
129 should generate a default position for the window. If using the wxWindow class directly, supply
130 an actual position.}
131
132 \docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows
133 should generate a default size for the window.}
134
135 \docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}
136
137 \docparam{name}{Window name.}
138
139 \wxheading{Remarks}
140
141 After a toolbar is created, you use \helpref{wxToolBar::AddTool}{wxtoolbaraddtool} and
142 perhaps \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}, and then you
143 must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} to construct and display the toolbar
144 tools.
145
146 You may also create a toolbar that is managed by the frame, by
147 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
148
149 \membersection{wxToolBar::\destruct{wxToolBar}}
150
151 \func{void}{\destruct{wxToolBar}}{\void}
152
153 Toolbar destructor.
154
155 \membersection{wxToolBar::AddControl}\label{wxtoolbaraddcontrol}
156
157 \func{bool}{AddControl}{\param{wxControl*}{ control}}
158
159 Adds any control to the toolbar, typically e.g. a combobox.
160
161 \docparam{control}{The control to be added.}
162
163 \membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
164
165 \func{void}{AddSeparator}{\void}
166
167 Adds a separator for spacing groups of tools.
168
169 \wxheading{See also}
170
171 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
172
173 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
174
175 \func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
176 \param{const wxString\&}{ label},\rtfsp
177 \param{const wxBitmap\&}{ bitmap1},\rtfsp
178 \param{const wxString\& }{shortHelpString = ""},\rtfsp
179 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
180
181 \func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
182 \param{const wxString\&}{ label},\rtfsp
183 \param{const wxBitmap\&}{ bitmap1},\rtfsp
184 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp
185 \param{wxItemKind}{ kind = wxITEM\_NORMAL},\rtfsp
186 \param{const wxString\& }{shortHelpString = ""},
187 \param{const wxString\& }{longHelpString = ""},\rtfsp
188 \param{wxObject* }{clientData = NULL}}
189
190 \func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{tool}}
191
192 Adds a tool to the toolbar. The first (short and most commonly used) version
193 has fewer parameters than the full version at the price of not being able to
194 specify some of the more rarely used button features. The last version allows
195 to add an existing tool.
196
197 \wxheading{Parameters}
198
199 \docparam{toolId}{An integer by which
200 the tool may be identified in subsequent operations.}
201
202 \docparam{kind}{May be wxITEM\_NORMAL for a normal button (default),
203 wxITEM\_CHECK for a checkable tool (such tool stays pressed after it had been
204 toggled) or wxITEM\_RADIO for a checkable tool which makes part of a radio
205 group of tools each of which is automatically unchecked whenever another button
206 in the group is checked}
207
208 \docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
209
210 \docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
211 tool. If this is wxNullBitmap, either an inverted version of the primary bitmap is
212 used for the on-state of a toggle tool (monochrome displays) or a black
213 border is drawn around the tool (colour displays) or the pixmap is shown
214 as a pressed button (GTK). }
215
216 \docparam{shortHelpString}{This string is used for the tools tooltip}
217
218 \docparam{longHelpString}{This string is shown in the statusbar (if any) of the
219 parent frame when the mouse pointer is inside the tool}
220
221 \docparam{clientData}{An optional pointer to client data which can be
222 retrieved later using \helpref{wxToolBar::GetToolClientData}{wxtoolbargettoolclientdata}.}
223
224 \docparam{tool}{The tool to be added.}
225
226 \wxheading{Remarks}
227
228 After you have added tools to a toolbar, you must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} in
229 order to have the tools appear.
230
231 \wxheading{See also}
232
233 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator},\rtfsp
234 \helpref{wxToolBar::AddCheckTool}{wxtoolbaraddchecktool},\rtfsp
235 \helpref{wxToolBar::AddRadioTool}{wxtoolbaraddradiotool},\rtfsp
236 \helpref{wxToolBar::InsertTool}{wxtoolbarinserttool},\rtfsp
237 \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},\rtfsp
238 \helpref{wxToolBar::Realize}{wxtoolbarrealize}
239
240 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
241
242 \func{wxToolBarTool*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
243 \param{const wxString\&}{ label},\rtfsp
244 \param{const wxBitmap\&}{ bitmap1},\rtfsp
245 \param{const wxBitmap\&}{ bitmap2},\rtfsp
246 \param{const wxString\& }{shortHelpString = ""},\rtfsp
247 \param{const wxString\& }{longHelpString = ""},\rtfsp
248 \param{wxObject* }{clientData = NULL}}
249
250 Adds a new check (or toggle) tool to the toolbar. The parameters are the same
251 as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
252
253 \wxheading{See also}
254
255 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
256
257 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
258
259 \func{wxToolBarTool*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
260 \param{const wxString\&}{ label},\rtfsp
261 \param{const wxBitmap\&}{ bitmap1},\rtfsp
262 \param{const wxBitmap\&}{ bitmap2},\rtfsp
263 \param{const wxString\& }{shortHelpString = ""},\rtfsp
264 \param{const wxString\& }{longHelpString = ""},\rtfsp
265 \param{wxObject* }{clientData = NULL}}
266
267 Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
268 group such that exactly one button in the group is pressed at any moment, in
269 other words whenever a button in the group is pressed the previously pressed
270 button is automatically released. You should avoid having the radio groups of
271 only one element as it would be impossible for the user to use such button.
272
273 By default, the first button in the radio group is initially pressed, the
274 others are not.
275
276 \wxheading{See also}
277
278 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
279
280 \membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}
281
282 \func{bool}{DeleteTool}{\param{int }{toolId}}
283
284 Removes the specified tool from the toolbar and deletes it. If you don't want
285 to delete the tool, but just to remove it from the toolbar (to possibly add it
286 back later), you may use \helpref{RemoveTool}{wxtoolbarremovetool} instead.
287
288 Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the
289 change to take place, it will happen immediately.
290
291 Returns true if the tool was deleted, false otherwise.
292
293 \wxheading{See also}
294
295 \helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}
296
297 \membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}
298
299 \func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}
300
301 This function behaves like \helpref{DeleteTool}{wxtoolbardeletetool} but it
302 deletes the tool at the specified position and not the one with the given id.
303
304 \membersection{wxToolBar::EnableTool}\label{wxtoolbarenabletool}
305
306 \func{void}{EnableTool}{\param{int }{toolId}, \param{const bool}{ enable}}
307
308 Enables or disables the tool.
309
310 \wxheading{Parameters}
311
312 \docparam{toolId}{Tool to enable or disable.}
313
314 \docparam{enable}{If true, enables the tool, otherwise disables it.}
315
316 {\bf NB:} This function should only be called after
317 \helpref{Realize}{wxtoolbarrealize}.
318
319 \wxheading{Remarks}
320
321 For wxToolBarSimple, does nothing. Some other implementations
322 will change the visible state of the tool to indicate that it is disabled.
323
324 \wxheading{See also}
325
326 \helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
327 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
328
329 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
330
331 \func{wxControl*}{FindControl}{\param{int }{id}}
332
333 Returns a pointer to the control identified by {\it id} or
334 NULL if no corresponding control is found.
335
336 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
337
338 \constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
339
340 Finds a tool for the given mouse position.
341
342 \wxheading{Parameters}
343
344 \docparam{x}{X position.}
345
346 \docparam{y}{Y position.}
347
348 \wxheading{Return value}
349
350 A pointer to a tool if a tool is found, or NULL otherwise.
351
352 \wxheading{Remarks}
353
354 Used internally, and should not need to be used by the programmer.
355
356 \membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}
357
358 \func{wxSize}{GetToolSize}{\void}
359
360 Returns the size of a whole button, which is usually larger than a tool bitmap because
361 of added 3D effects.
362
363 \wxheading{See also}
364
365 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
366 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
367
368 \membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
369
370 \func{wxSize}{GetToolBitmapSize}{\void}
371
372 Returns the size of bitmap that the toolbar expects to have. The default bitmap size is 16 by 15 pixels.
373
374 \wxheading{Remarks}
375
376 Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
377 and not the eventual size of the tool button.
378
379 \wxheading{See also}
380
381 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
382 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
383
384 \membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
385
386 \constfunc{wxSize}{GetMargins}{\void}
387
388 Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.
389
390 \wxheading{See also}
391
392 \helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
393
394 \membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
395
396 \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}
397
398 Get any client data associated with the tool.
399
400 \wxheading{Parameters}
401
402 \docparam{toolId}{Id of the tool, as passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
403
404 \wxheading{Return value}
405
406 Client data, or NULL if there is none.
407
408 \membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
409
410 \constfunc{bool}{GetToolEnabled}{\param{int }{toolId}}
411
412 Called to determine whether a tool is enabled (responds to user input).
413
414 \wxheading{Parameters}
415
416 \docparam{toolId}{Id of the tool in question.}
417
418 \wxheading{Return value}
419
420 true if the tool is enabled, false otherwise.
421
422 \wxheading{See also}
423
424 \helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}
425
426 \membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
427
428 \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}
429
430 Returns the long help for the given tool.
431
432 \wxheading{Parameters}
433
434 \docparam{toolId}{The tool in question.}
435
436 \wxheading{See also}
437
438 \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
439 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
440
441 \membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
442
443 \constfunc{int}{GetToolPacking}{\void}
444
445 Returns the value used for packing tools.
446
447 \wxheading{See also}
448
449 \helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}
450
451 \membersection{wxToolBar::GetToolPos}\label{wxtoolbargettoolpos}
452
453 \constfunc{int}{GetToolPos}{\param{int }{toolId}}
454
455 Returns the tool position in the toolbar, or wxNOT\_FOUND if the tool is not found.
456
457 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
458
459 \constfunc{int}{GetToolSeparation}{\void}
460
461 Returns the default separator size.
462
463 \wxheading{See also}
464
465 \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
466
467 \membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
468
469 \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}
470
471 Returns the short help for the given tool.
472
473 \wxheading{Parameters}
474
475 \docparam{toolId}{The tool in question.}
476
477 \wxheading{See also}
478
479 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
480 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
481
482 \membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
483
484 \constfunc{bool}{GetToolState}{\param{int }{toolId}}
485
486 Gets the on/off state of a toggle tool.
487
488 \wxheading{Parameters}
489
490 \docparam{toolId}{The tool in question.}
491
492 \wxheading{Return value}
493
494 true if the tool is toggled on, false otherwise.
495
496 \wxheading{See also}
497
498 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
499
500 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
501
502 \func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
503
504 Inserts the control into the toolbar at the given position.
505
506 You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
507
508 \wxheading{See also}
509
510 \helpref{AddControl}{wxtoolbaraddcontrol},\\
511 \helpref{InsertTool}{wxtoolbarinserttool}
512
513 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
514
515 \func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}}
516
517 Inserts the separator into the toolbar at the given position.
518
519 You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
520
521 \wxheading{See also}
522
523 \helpref{AddSeparator}{wxtoolbaraddseparator},\\
524 \helpref{InsertTool}{wxtoolbarinserttool}
525
526 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
527
528 \func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
529 \param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
530 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = false},\rtfsp
531 \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
532
533 \func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
534 \param{wxToolBarTool* }{tool}}
535
536 Inserts the tool with the specified attributes into the toolbar at the given
537 position.
538
539 You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
540
541 \wxheading{See also}
542
543 \helpref{AddTool}{wxtoolbaraddtool},\\
544 \helpref{InsertControl}{wxtoolbarinsertcontrol},\\
545 \helpref{InsertSeparator}{wxtoolbarinsertseparator}
546
547 \membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
548
549 \func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}
550
551 Called when the user clicks on a tool with the left mouse button.
552
553 This is the old way of detecting tool clicks; although it will still work,
554 you should use the EVT\_MENU or EVT\_TOOL macro instead.
555
556 \wxheading{Parameters}
557
558 \docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
559
560 \docparam{toggleDown}{true if the tool is a toggle and the toggle is down, otherwise is false.}
561
562 \wxheading{Return value}
563
564 If the tool is a toggle and this function returns false, the toggle
565 toggle state (internal and visual) will not be changed. This provides a way of
566 specifying that toggle operations are not permitted in some circumstances.
567
568 \wxheading{See also}
569
570 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
571 \helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
572
573 \membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
574
575 \func{void}{OnMouseEnter}{\param{int}{ toolId}}
576
577 This is called when the mouse cursor moves into a tool or out of
578 the toolbar.
579
580 This is the old way of detecting mouse enter events; although it will still work,
581 you should use the EVT\_TOOL\_ENTER macro instead.
582
583 \wxheading{Parameters}
584
585 \docparam{toolId}{Greater than -1 if the mouse cursor has moved into the tool,
586 or -1 if the mouse cursor has moved. The
587 programmer can override this to provide extra information about the tool,
588 such as a short description on the status line.}
589
590 \wxheading{Remarks}
591
592 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
593 detect it. Therefore this function may not always be called when expected.
594
595 \membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}
596
597 \func{void}{OnRightClick}{\param{int}{ toolId}, \param{float}{ x}, \param{float}{ y}}
598
599 Called when the user clicks on a tool with the right mouse button. The
600 programmer should override this function to detect right tool clicks.
601
602 This is the old way of detecting tool right clicks; although it will still work,
603 you should use the EVT\_TOOL\_RCLICKED macro instead.
604
605 \wxheading{Parameters}
606
607 \docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
608
609 \docparam{x}{The x position of the mouse cursor.}
610
611 \docparam{y}{The y position of the mouse cursor.}
612
613 \wxheading{Remarks}
614
615 A typical use of this member might be to pop up a menu.
616
617 \wxheading{See also}
618
619 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
620 \helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}
621
622 \membersection{wxToolBar::Realize}\label{wxtoolbarrealize}
623
624 \func{bool}{Realize}{\void}
625
626 This function should be called after you have added tools.
627
628 If you are using absolute positions for your tools when using a wxToolBarSimple object,
629 do not call this function. You must call it at all other times.
630
631 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
632
633 \func{wxToolBarTool *}{RemoveTool}{\param{int }{id}}
634
635 Removes the given tool from the toolbar but doesn't delete it. This allows to
636 insert/add this tool back to this (or another) toolbar later.
637
638 Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the
639 change to take place, it will happen immediately.
640
641 \wxheading{See also}
642
643 \helpref{DeleteTool}{wxtoolbardeletetool}
644
645 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
646
647 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
648
649 \func{void}{SetMargins}{\param{int}{ x}, \param{int}{ y}}
650
651 Set the values to be used as margins for the toolbar.
652
653 \wxheading{Parameters}
654
655 \docparam{size}{Margin size.}
656
657 \docparam{x}{Left margin, right margin and inter-tool separation value.}
658
659 \docparam{y}{Top margin, bottom margin and inter-tool separation value.}
660
661 \wxheading{Remarks}
662
663 This must be called before the tools are added if absolute positioning is to be used, and the
664 default (zero-size) margins are to be overridden.
665
666 \wxheading{See also}
667
668 \helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
669
670 \membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
671
672 \func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}
673
674 Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.
675
676 \wxheading{Parameters}
677
678 \docparam{size}{The size of the bitmaps in the toolbar.}
679
680 \wxheading{Remarks}
681
682 This should be called to tell the toolbar what the tool bitmap size is. Call
683 it before you add tools.
684
685 Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
686 and not the eventual size of the tool button.
687
688 \wxheading{See also}
689
690 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
691 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
692
693 \membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata}
694
695 \func{void}{SetToolClientData}{\param{int }{id}, \param{wxObject* }{clientData}}
696
697 Sets the client data associated with the tool.
698
699 \membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
700
701 \func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
702
703 Sets the long help for the given tool.
704
705 \wxheading{Parameters}
706
707 \docparam{toolId}{The tool in question.}
708
709 \docparam{helpString}{A string for the long help.}
710
711 \wxheading{Remarks}
712
713 You might use the long help for displaying the tool purpose on the status line.
714
715 \wxheading{See also}
716
717 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
718 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
719
720 \membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
721
722 \func{void}{SetToolPacking}{\param{int}{ packing}}
723
724 Sets the value used for spacing tools. The default value is 1.
725
726 \wxheading{Parameters}
727
728 \docparam{packing}{The value for packing.}
729
730 \wxheading{Remarks}
731
732 The packing is used for spacing in the vertical direction if the toolbar is horizontal,
733 and for spacing in the horizontal direction if the toolbar is vertical.
734
735 \wxheading{See also}
736
737 \helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
738
739 \membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
740
741 \func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
742
743 Sets the short help for the given tool.
744
745 \wxheading{Parameters}
746
747 \docparam{toolId}{The tool in question.}
748
749 \docparam{helpString}{The string for the short help.}
750
751 \wxheading{Remarks}
752
753 An application might use short help for identifying the tool purpose in a tooltip.
754
755 \wxheading{See also}
756
757 \helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
758
759 \membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
760
761 \func{void}{SetToolSeparation}{\param{int}{ separation}}
762
763 Sets the default separator size. The default value is 5.
764
765 \wxheading{Parameters}
766
767 \docparam{separation}{The separator size.}
768
769 \wxheading{See also}
770
771 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
772
773 \membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
774
775 \func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}
776
777 Toggles a tool on or off. This does not cause any event to get emitted.
778
779 \wxheading{Parameters}
780
781 \docparam{toolId}{Tool in question.}
782
783 \docparam{toggle}{If true, toggles the tool on, otherwise toggles it off.}
784
785 \wxheading{Remarks}
786
787 Only applies to a tool that has been specified as a toggle tool.
788
789 \wxheading{See also}
790
791 \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}
792