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