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