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