]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/toolbar.tex
2 typos corrected
[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 identical
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 {\bf wxToolBar95:} Note that this toolbar paints tools to reflect user-selected colours.
40 The toolbar orientation must always be {\bf wxHORIZONTAL}.
41
42 {\bf wxToolBarGtk:} The toolbar orientation is ignored and is always {\bf wxHORIZONTAL}.
43
44 \wxheading{Window styles}
45
46 \twocolwidtha{5cm}
47 \begin{twocollist}\itemsep=0pt
48 \twocolitem{\windowstyle{wxTB\_FLAT}}{Gives the toolbar a flat look ('coolbar' or 'flatbar' style). Windows 95 and GTK 1.2 only.}
49 \twocolitem{\windowstyle{wxTB\_DOCKABLE}}{Makes the toolbar floatable and dockable. GTK only.}
50 \twocolitem{\windowstyle{wxTB\_HORIZONTAL}}{Specifies horizontal layout.}
51 \twocolitem{\windowstyle{wxTB\_VERTICAL}}{Specifies vertical layout (not available for the GTK and Windows 95
52 toolbar).}
53 \twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Gives wxToolBarSimple a mild 3D look to its buttons.}
54 \end{twocollist}
55
56 See also \helpref{window styles overview}{windowstyles}.
57
58 \wxheading{Event handling}
59
60 The toolbar class emits menu commands in the same was that a frame menubar does,
61 so you can use one EVT\_MENU macro for both a menu item and a toolbar button.
62 The event handler functions take a wxCommandEvent argument. For most event macros,
63 the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar
64 window is passed and the tool id is retrieved from the wxCommandEvent.
65 This is because the id may be -1 when the mouse moves off a tool, and -1 is not
66 allowed as an identifier in the event system.
67
68 Note that tool commands (and UI update events for tools) are first sent to
69 the focus window within the frame that contains the toolbar. If no window within the frame has the focus,
70 then the events are sent directly to the toolbar (and up the hierarchy to the
71 frame, depending on where the application has put its event handlers). This allows command and UI update
72 handling to be processed by specific windows and controls, and not necessarily
73 by the application frame.
74
75 \twocolwidtha{7cm}
76 \begin{twocollist}\itemsep=0pt
77 \twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
78 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
79 \twocolitem{{\bf EVT\_MENU(id, func)}}{The same as EVT\_TOOL.}
80 \twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
81 for a range id identifiers. Pass the ids of the tools.}
82 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{The same as EVT\_TOOL\_RANGE.}
83
84 \twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
85 Pass the id of the tool.}
86 \twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
87 for a range of ids. Pass the ids of the tools.}
88 \twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
89 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.}
90 \end{twocollist}
91
92 \wxheading{See also}
93
94 \overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
95 \helpref{wxScrolledWindow}{wxscrolledwindow}
96
97 \latexignore{\rtfignore{\wxheading{Members}}}
98
99 \membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
100
101 \func{}{wxToolBar}{\void}
102
103 Default constructor.
104
105 \func{}{wxToolBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
106 \param{const wxPoint\& }{pos = wxDefaultPosition},
107 \param{const wxSize\& }{size = wxDefaultSize},
108 \param{long }{style = wxTB\_HORIZONTAL \pipe wxNO\_BORDER},
109 \param{const wxString\& }{name = wxPanelNameStr}}
110
111 Constructs a toolbar.
112
113 \wxheading{Parameters}
114
115 \docparam{parent}{Pointer to a parent window.}
116
117 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
118
119 \docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows
120 should generate a default position for the window. If using the wxWindow class directly, supply
121 an actual position.}
122
123 \docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows
124 should generate a default size for the window.}
125
126 \docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}
127
128 \docparam{name}{Window name.}
129
130 \wxheading{Remarks}
131
132 After a toolbar is created, you use \helpref{wxToolBar::AddTool}{wxtoolbaraddtool} and
133 perhaps \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}, and then you
134 must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} to construct and display the toolbar
135 tools.
136
137 You may also create a toolbar that is managed by the frame, by
138 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
139
140 \membersection{wxToolBar::\destruct{wxToolBar}}
141
142 \func{void}{\destruct{wxToolBar}}{\void}
143
144 Toolbar destructor.
145
146 \membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
147
148 \func{void}{AddSeparator}{\void}
149
150 Adds a separator for spacing groups of tools.
151
152 \wxheading{See also}
153
154 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
155
156 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
157
158 \func{wxToolBarTool*}{AddTool}{\param{int}{ toolIndex}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
159 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp
160 \param{long}{ xPos = -1}, \param{long}{ yPos = -1},\rtfsp
161 \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
162
163 Adds a tool to the toolbar.
164
165 \wxheading{Parameters}
166
167 \docparam{toolIndex}{An integer by which
168 the tool may be identified in subsequent operations.}
169
170 \docparam{isToggle}{Specifies whether the tool is a toggle or not: a toggle tool may be in
171 two states, whereas a non-toggle tool is just a button.}
172
173 \docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
174
175 \docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
176 tool. If this is wxNullBitmap, either an inverted version of the primary bitmap is
177 used for the on-state of a toggle tool (monochrome displays) or a black
178 border is drawn around the tool (colour displays) or the pixmap is shown
179 as a pressed button (GTK). }
180
181 \docparam{xPos}{Specifies the x position of the tool if automatic layout is not suitable.}
182
183 \docparam{yPos}{Specifies the y position of the tool if automatic layout is not suitable.}
184
185 \docparam{clientData}{An optional pointer to client data which can be
186 retrieved later using \helpref{wxToolBar::GetToolClientData}{wxtoolbargettoolclientdata}.}
187
188 \docparam{shortHelpString}{Used for displaying a tooltip for the tool in the
189 Windows 95 implementation of wxButtonBar. Pass the empty string if this is not required.}
190
191 \docparam{longHelpString}{Used to displayer longer help, such as status line help.
192 Pass the empty string if this is not required.}
193
194 \wxheading{Remarks}
195
196 After you have added tools to a toolbar, you must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} in
197 order to have the tools appear.
198
199 \wxheading{See also}
200
201 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator},
202 \helpref{wxToolBar::Realize}{wxtoolbarrealize},
203
204 \membersection{wxToolBar::CreateTools}\label{wxtoolbarcreatetools}
205
206 \func{bool}{CreateTools}{\void}
207
208 This function is implemented for some toolbar classes to create the tools and display them.
209 The portable way of calling it is to call \helpref{wxToolBar::Realize}{wxtoolbarrealize} after
210 you have added tools and separators.
211
212 \wxheading{See also}
213
214 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::Realize}{wxtoolbarrealize}
215
216 \membersection{wxToolBar::DrawTool}\label{wxtoolbardrawtool}
217
218 \func{void}{DrawTool}{\param{wxMemoryDC\& }{memDC}, \param{wxToolBarTool* }{tool}}
219
220 Draws the specified tool onto the window using the given memory device context.
221
222 \wxheading{Parameters}
223
224 \docparam{memDC}{A memory DC to be used for drawing the tool.}
225
226 \docparam{tool}{Tool to be drawn.}
227
228 \wxheading{Remarks}
229
230 For internal use only.
231
232 \membersection{wxToolBar::EnableTool}\label{wxtoolbarenabletool}
233
234 \func{void}{EnableTool}{\param{int }{toolIndex}, \param{const bool}{ enable}}
235
236 Enables or disables the tool.
237
238 \wxheading{Parameters}
239
240 \docparam{toolIndex}{Tool to enable or disable.}
241
242 \docparam{enable}{If TRUE, enables the tool, otherwise disables it.}
243
244 \wxheading{Remarks}
245
246 For wxToolBarSimple, does nothing. Some other implementations
247 will change the visible state of the tool to indicate that it is disabled.
248
249 \wxheading{See also}
250
251 \helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
252 %\helpref{wxToolBar::SetToolState}{wxtoolbarsettoolstate},\rtfsp
253 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
254
255 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
256
257 \constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
258
259 Finds a tool for the given mouse position.
260
261 \wxheading{Parameters}
262
263 \docparam{x}{X position.}
264
265 \docparam{y}{Y position.}
266
267 \wxheading{Return value}
268
269 A pointer to a tool if a tool is found, or NULL otherwise.
270
271 \wxheading{Remarks}
272
273 Used internally, and should not need to be used by the programmer.
274
275 \membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}
276
277 \func{wxSize}{GetToolSize}{\void}
278
279 Returns the size of a whole button, which is usually larger than a tool bitmap because
280 of added 3D effects.
281
282 \wxheading{See also}
283
284 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
285 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
286
287 \membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
288
289 \func{wxSize}{GetToolBitmapSize}{\void}
290
291 Returns the size of bitmap that the toolbar expects to have. The default bitmap size is 16 by 15 pixels.
292
293 \wxheading{Remarks}
294
295 Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
296 and not the eventual size of the tool button.
297
298 \wxheading{See also}
299
300 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
301 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
302
303 \membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
304
305 \constfunc{wxSize}{GetMargins}{\void}
306
307 Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.
308
309 \wxheading{See also}
310
311 \helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
312
313 \membersection{wxToolBar::GetMaxSize}\label{wxtoolbargetmaxsize}
314
315 \constfunc{wxSize}{GetMaxSize}{\void}
316
317 Gets the maximum size taken up by the tools after layout, including margins.
318 This can be used to size a frame around the toolbar window.
319
320 \membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
321
322 \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolIndex}}
323
324 Get any client data associated with the tool.
325
326 \wxheading{Parameters}
327
328 \docparam{toolIndex}{Index of the tool, as passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
329
330 \wxheading{Return value}
331
332 Client data, or NULL if there is none.
333
334 \membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
335
336 \constfunc{bool}{GetToolEnabled}{\param{int }{toolIndex}}
337
338 Called to determine whether a tool is enabled (responds to user input).
339
340 \wxheading{Parameters}
341
342 \docparam{toolIndex}{Index of the tool in question.}
343
344 \wxheading{Return value}
345
346 TRUE if the tool is enabled, FALSE otherwise.
347
348 %\wxheading{See also}
349 %
350 %\helpref{wxToolBar::SetToolEnabled}{wxtoolbarsettoolenabled}
351 %
352 \membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
353
354 \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolIndex}}
355
356 Returns the long help for the given tool.
357
358 \wxheading{Parameters}
359
360 \docparam{toolIndex}{The tool in question.}
361
362 \wxheading{See also}
363
364 \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
365 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
366
367 \membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
368
369 \constfunc{int}{GetToolPacking}{\void}
370
371 Returns the value used for packing tools.
372
373 \wxheading{See also}
374
375 \helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}
376
377 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
378
379 \constfunc{int}{GetToolSeparation}{\void}
380
381 Returns the default separator size.
382
383 \wxheading{See also}
384
385 \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
386
387 \membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
388
389 \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolIndex}}
390
391 Returns the short help for the given tool.
392
393 Returns the long help for the given tool.
394
395 \wxheading{Parameters}
396
397 \docparam{toolIndex}{The tool in question.}
398
399 \wxheading{See also}
400
401 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
402 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
403
404 \membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
405
406 \constfunc{bool}{GetToolState}{\param{int }{toolIndex}}
407
408 Gets the on/off state of a toggle tool.
409
410 \wxheading{Parameters}
411
412 \docparam{toolIndex}{The tool in question.}
413
414 \wxheading{Return value}
415
416 TRUE if the tool is toggled on, FALSE otherwise.
417
418 %\wxheading{See also}
419 %
420 %\helpref{wxToolBar::SetToolState}{wxtoolbarsettoolstate}
421 %
422 \membersection{wxToolBar::Layout}\label{wxtoolbarlayout}
423
424 \func{void}{Layout}{\void}
425
426 Called by the application after the tools have been added to
427 automatically lay the tools out on the window. If you have given
428 absolute positions when adding the tools, do not call this.
429
430 This function is only implemented for some toolbar classes.
431 The portable way of calling it is to call \helpref{wxToolBar::Realize}{wxtoolbarrealize} after
432 you have added tools and separators.
433
434 \wxheading{See also}
435
436 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::Realize}{wxtoolbarrealize}
437
438 \membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
439
440 \func{bool}{OnLeftClick}{\param{int}{ toolIndex}, \param{bool}{ toggleDown}}
441
442 Called when the user clicks on a tool with the left mouse button.
443
444 This is the old way of detecting tool clicks; although it will still work,
445 you should use the EVT\_MENU or EVT\_TOOL macro instead.
446
447 \wxheading{Parameters}
448
449 \docparam{toolIndex}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
450
451 \docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.}
452
453 \wxheading{Return value}
454
455 If the tool is a toggle and this function returns FALSE, the toggle
456 toggle state (internal and visual) will not be changed. This provides a way of
457 specifying that toggle operations are not permitted in some circumstances.
458
459 \wxheading{See also}
460
461 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
462 \helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
463
464 \membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
465
466 \func{void}{OnMouseEnter}{\param{int}{ toolIndex}}
467
468 This is called when the mouse cursor moves into a tool or out of
469 the toolbar.
470
471 This is the old way of detecting mouse enter events; although it will still work,
472 you should use the EVT\_TOOL\_ENTER macro instead.
473
474 \wxheading{Parameters}
475
476 \docparam{toolIndex}{Greater than -1 if the mouse cursor has moved into the tool,
477 or -1 if the mouse cursor has moved. The
478 programmer can override this to provide extra information about the tool,
479 such as a short description on the status line.}
480
481 \wxheading{Remarks}
482
483 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
484 detect it. Therefore this function may not always be called when expected.
485
486 \membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}
487
488 \func{void}{OnRightClick}{\param{int}{ toolIndex}, \param{float}{ x}, \param{float}{ y}}
489
490 Called when the user clicks on a tool with the right mouse button. The
491 programmer should override this function to detect right tool clicks.
492
493 This is the old way of detecting tool right clicks; although it will still work,
494 you should use the EVT\_TOOL\_RCLICKED macro instead.
495
496 \wxheading{Parameters}
497
498 \docparam{toolIndex}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
499
500 \docparam{x}{The x position of the mouse cursor.}
501
502 \docparam{y}{The y position of the mouse cursor.}
503
504 \wxheading{Remarks}
505
506 A typical use of this member might be to pop up a menu.
507
508 \wxheading{See also}
509
510 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
511 \helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}
512
513 \membersection{wxToolBar::Realize}\label{wxtoolbarrealize}
514
515 \func{bool}{Realize}{\void}
516
517 This function should be called after you have added tools. It
518 calls, according to the implementation,
519 either \helpref{wxToolBar::CreateTools}{wxtoolbarcreatetools} or
520 \helpref{wxToolBar::Layout}{wxtoolbarlayout}.
521
522 If you are using absolute positions for your tools when using a wxToolBarSimple object,
523 do not call this function. You must call it at all other times.
524
525 \membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
526
527 \func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}
528
529 Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.
530
531 \wxheading{Parameters}
532
533 \docparam{size}{The size of the bitmaps in the toolbar.}
534
535 \wxheading{Remarks}
536
537 This should be called to tell the toolbar what the tool bitmap size is. Call
538 it before you add tools.
539
540 Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
541 and not the eventual size of the tool button.
542
543 \wxheading{See also}
544
545 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
546 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
547
548 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
549
550 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
551
552 \func{void}{SetMargins}{\param{int}{ x}, \param{int}{ y}}
553
554 Set the values to be used as margins for the toolbar.
555
556 \wxheading{Parameters}
557
558 \docparam{size}{Margin size.}
559
560 \docparam{x}{Left margin, right margin and inter-tool separation value.}
561
562 \docparam{y}{Top margin, bottom margin and inter-tool separation value.}
563
564 \wxheading{Remarks}
565
566 This must be called before the tools are added if absolute positioning is to be used, and the
567 default (zero-size) margins are to be overridden.
568
569 \wxheading{See also}
570
571 \helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
572
573 \membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
574
575 \func{void}{SetToolLongHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}
576
577 Sets the long help for the given tool.
578
579 \wxheading{Parameters}
580
581 \docparam{toolIndex}{The tool in question.}
582
583 \docparam{helpString}{A string for the long help.}
584
585 \wxheading{Remarks}
586
587 You might use the long help for displaying the tool purpose on the status line.
588
589 \wxheading{See also}
590
591 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
592 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
593
594 \membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
595
596 \func{void}{SetToolPacking}{\param{int}{ packing}}
597
598 Sets the value used for spacing tools. The default value is 1.
599
600 \wxheading{Parameters}
601
602 \docparam{packing}{The value for packing.}
603
604 \wxheading{Remarks}
605
606 The packing is used for spacing in the vertical direction if the toolbar is horizontal,
607 and for spacing in the horizontal direction if the toolbar is vertical.
608
609 \wxheading{See also}
610
611 \helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
612
613 \membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
614
615 \func{void}{SetToolShortHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}
616
617 Sets the short help for the given tool.
618
619 \wxheading{Parameters}
620
621 \docparam{toolIndex}{The tool in question.}
622
623 \docparam{helpString}{The string for the short help.}
624
625 \wxheading{Remarks}
626
627 An application might use short help for identifying the tool purpose in a tooltip.
628
629 \wxheading{See also}
630
631 \helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
632
633 \membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
634
635 \func{void}{SetToolSeparation}{\param{int}{ separation}}
636
637 Sets the default separator size. The default value is 5.
638
639 \wxheading{Parameters}
640
641 \docparam{separation}{The separator size.}
642
643 \wxheading{See also}
644
645 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
646
647 \membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
648
649 \func{void}{ToggleTool}{\param{int }{toolIndex}, \param{const bool}{ toggle}}
650
651 Toggles a tool on or off.
652
653 \wxheading{Parameters}
654
655 \docparam{toolIndex}{Tool in question.}
656
657 \docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.}
658
659 \wxheading{Remarks}
660
661 Only applies to a tool that has been specified as a toggle tool.
662
663 \wxheading{See also}
664
665 \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}
666
667