interface/toolbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        toolbar.h
   3 // Purpose:     interface of wxToolBar
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxToolBar
  11     @wxheader{toolbar.h}
  12
  13     The name wxToolBar is defined to be a synonym for one of the following
  14     classes:
  15
  16     - @b wxToolBar95 - The native Windows 95 toolbar. Used on Windows 95, NT 4
  17       and above.
  18     - @b wxToolBarMSW - A Windows implementation. Used on 16-bit Windows.
  19     - @b wxToolBarGTK - The GTK toolbar.
  20
  21     You may also create a toolbar that is managed by the frame, by calling
  22     wxFrame::CreateToolBar(). Under Pocket PC, you should always use this
  23     function for creating the toolbar to be managed by the frame, so that
  24     wxWidgets can use a combined menubar and toolbar. Where you manage your
  25     own toolbars, create a wxToolBar as usual.
  26
  27     The meaning of a "separator" is a vertical line under Windows and simple
  28     space under GTK+.
  29
  30     @b wxToolBar95: Note that this toolbar paints tools to reflect
  31     system-wide colours. If you use more than 16 colours in your tool
  32     bitmaps, you may wish to suppress this behaviour, otherwise system
  33     colours in your bitmaps will inadvertently be mapped to system colours.
  34     To do this, set the msw.remap system option before creating the toolbar:
  35
  36     @code
  37     wxSystemOptions::SetOption(wxT("msw.remap"), 0);
  38     @endcode
  39
  40     If you wish to use 32-bit images (which include an alpha channel for
  41     transparency) use:
  42
  43     @code
  44     wxSystemOptions::SetOption(wxT("msw.remap"), 2);
  45     @endcode
  46
  47     Then colour remapping is switched off, and a transparent background
  48     used. But only use this option under Windows XP with true colour:
  49
  50     @code
  51     if (wxTheApp->GetComCtl32Version() >= 600 && ::wxDisplayDepth() >= 32)
  52     @endcode
  53
  54     There are several different types of tools you can add to a toolbar. These
  55     types are controlled by the ::wxItemKind enumeration.
  56
  57     @beginStyleTable
  58     @style{wxTB_FLAT}
  59         Gives the toolbar a flat look (Windows and GTK only).
  60     @style{wxTB_DOCKABLE}
  61         Makes the toolbar floatable and dockable (GTK only).
  62     @style{wxTB_HORIZONTAL}
  63         Specifies horizontal layout (default).
  64     @style{wxTB_VERTICAL}
  65         Specifies vertical layout.
  66     @style{wxTB_TEXT}
  67         Shows the text in the toolbar buttons; by default only icons are shown.
  68     @style{wxTB_NOICONS}
  69         Specifies no icons in the toolbar buttons; by default they are shown.
  70     @style{wxTB_NODIVIDER}
  71         Specifies no divider (border) above the toolbar (Windows only)
  72     @style{wxTB_NOALIGN}
  73         Specifies no alignment with the parent window (Windows only, not very
  74         useful).
  75     @style{wxTB_HORZ_LAYOUT}
  76         Shows the text and the icons alongside, not vertically stacked (Windows
  77         and GTK 2 only). This style must be used with @c wxTB_TEXT.
  78     @style{wxTB_HORZ_TEXT}
  79         Combination of @c wxTB_HORZ_LAYOUT and @c wxTB_TEXT.
  80     @style{wxTB_NO_TOOLTIPS}
  81         Don't show the short help tooltips for the tools when the mouse hovers
  82         over them.
  83     @style{wxTB_BOTTOM}
  84         Align the toolbar at the bottom of parent window.
  85     @style{wxTB_RIGHT}
  86         Align the toolbar at the right side of parent window.
  87     @endStyleTable
  88
  89     See also @ref overview_windowstyles. Note that the Win32 native toolbar
  90     ignores @c wxTB_NOICONS style. Also, toggling the @c wxTB_TEXT works only
  91     if the style was initially on.
  92
  93     @beginEventTable{wxCommandEvent}
  94     @event{EVT_TOOL(id, func)}
  95         Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c
  96         wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool.
  97     @event{EVT_MENU(id, func)}
  98         The same as EVT_TOOL().
  99     @event{EVT_TOOL_RANGE(id1, id2, func)}
 100         Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of
 101         identifiers. Pass the ids of the tools.
 102     @event{EVT_MENU_RANGE(id1, id2, func)}
 103         The same as EVT_TOOL_RANGE().
 104     @event{EVT_TOOL_RCLICKED(id, func)}
 105         Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the
 106         tool.
 107     @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
 108         Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass
 109         the ids of the tools.
 110     @event{EVT_TOOL_ENTER(id, func)}
 111         Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar
 112         itself. The value of wxCommandEvent::GetSelection() is the tool id, or
 113         -1 if the mouse cursor has moved off a tool.
 114     @event{EVT_TOOL_DROPDOWN(id, func)}
 115         Process a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event. If unhandled,
 116         displays the default dropdown menu set using
 117         wxToolBar::SetDropdownMenu().
 118     @endEventTable
 119
 120     The toolbar class emits menu commands in the same way that a frame menubar
 121     does, so you can use one EVT_MENU() macro for both a menu item and a toolbar
 122     button. The event handler functions take a wxCommandEvent argument. For most
 123     event macros, the identifier of the tool is passed, but for EVT_TOOL_ENTER()
 124     the toolbar window identifier is passed and the tool identifier is retrieved
 125     from the wxCommandEvent. This is because the identifier may be -1 when the
 126     mouse moves off a tool, and -1 is not allowed as an identifier in the event
 127     system.
 128
 129     @library{wxcore}
 130     @category{miscwnd}
 131
 132     @see @ref overview_toolbar
 133 */
 134 class wxToolBar : public wxControl
 135 {
 136 public:
 137     /**
 138         Default constructor.
 139     */
 140     wxToolBar();
 141
 142     /**
 143         Constructs a toolbar.
 144
 145         @param parent
 146             Pointer to a parent window.
 147         @param id
 148             Window identifier. If -1, will automatically create an identifier.
 149         @param pos
 150             Window position. ::wxDefaultPosition is (-1, -1) which indicates that
 151             wxWidgets should generate a default position for the window. If
 152             using the wxWindow class directly, supply an actual position.
 153         @param size
 154             Window size. ::wxDefaultSize is (-1, -1) which indicates that
 155             wxWidgets should generate a default size for the window.
 156         @param style
 157             Window style. See wxToolBar for details.
 158         @param name
 159             Window name.
 160
 161         @remarks After a toolbar is created, you use AddTool() and perhaps
 162             AddSeparator(), and then you must call Realize() to construct and
 163             display the toolbar tools.
 164     */
 165     wxToolBar(wxWindow* parent, wxWindowID id,
 166               const wxPoint& pos = wxDefaultPosition,
 167               const wxSize& size = wxDefaultSize,
 168               long style = wxTB_HORIZONTAL | wxBORDER_NONE,
 169               const wxString& name = wxPanelNameStr);
 170
 171     /**
 172         Toolbar destructor.
 173     */
 174     ~wxToolBar();
 175
 176     /**
 177         Adds a new check (or toggle) tool to the toolbar. The parameters are the
 178         same as in AddTool().
 179
 180         @see AddTool()
 181     */
 182     wxToolBarToolBase* AddCheckTool(int toolId,
 183                                     const wxString& label,
 184                                     const wxBitmap& bitmap1,
 185                                     const wxBitmap& bitmap2,
 186                                     const wxString& shortHelpString = "",
 187                                     const wxString& longHelpString = "",
 188                                     wxObject* clientData = NULL);
 189
 190     /**
 191         Adds any control to the toolbar, typically e.g. a wxComboBox.
 192
 193         @param control
 194             The control to be added.
 195         @param label
 196             Text to be displayed near the control.
 197
 198         @remarks
 199             wxMSW: the label is only displayed if there is enough space
 200             available below the embedded control.
 201
 202         @remarks
 203             wxMac: labels are only displayed if wxWidgets is built with @c
 204             wxMAC_USE_NATIVE_TOOLBAR set to 1
 205     */
 206     bool AddControl(wxControl* control, const wxString label = "");
 207
 208     /**
 209         Adds a new radio tool to the toolbar. Consecutive radio tools form a
 210         radio group such that exactly one button in the group is pressed at any
 211         moment, in other words whenever a button in the group is pressed the
 212         previously pressed button is automatically released. You should avoid
 213         having the radio groups of only one element as it would be impossible
 214         for the user to use such button.
 215
 216         By default, the first button in the radio group is initially pressed,
 217         the others are not.
 218
 219
 220         @see AddTool()
 221     */
 222     wxToolBarToolBase* AddRadioTool(int toolId,
 223                                     const wxString& label,
 224                                     const wxBitmap& bitmap1,
 225                                     const wxBitmap& bitmap2,
 226                                     const wxString& shortHelpString = "",
 227                                     const wxString& longHelpString = "",
 228                                     wxObject* clientData = NULL);
 229
 230     /**
 231         Adds a separator for spacing groups of tools.
 232
 233         @see AddTool(), SetToolSeparation()
 234     */
 235     void AddSeparator();
 236
 237     //@{
 238     /**
 239         Adds a tool to the toolbar. The first (short and most commonly used)
 240         version has fewer parameters than the full version at the price of not
 241         being able to specify some of the more rarely used button features. The
 242         last version allows you to add an existing tool.
 243
 244         @param toolId
 245             An integer by which the tool may be identified in subsequent
 246             operations.
 247         @param kind
 248             May be ::wxITEM_NORMAL for a normal button (default), ::wxITEM_CHECK
 249             for a checkable tool (such tool stays pressed after it had been
 250             toggled) or ::wxITEM_RADIO for a checkable tool which makes part of
 251             a radio group of tools each of which is automatically unchecked
 252             whenever another button in the group is checked.
 253         @param bitmap1
 254             The primary tool bitmap.
 255         @param bitmap2
 256             The bitmap used when the tool is disabled. If it is equal to
 257             ::wxNullBitmap, the disabled bitmap is automatically generated by
 258             greying the normal one.
 259         @param shortHelpString
 260             This string is used for the tools tooltip.
 261         @param longHelpString
 262             This string is shown in the statusbar (if any) of the parent frame
 263             when the mouse pointer is inside the tool.
 264         @param clientData
 265             An optional pointer to client data which can be retrieved later
 266             using GetToolClientData().
 267         @param tool
 268             The tool to be added.
 269
 270         @remarks After you have added tools to a toolbar, you must call
 271             Realize() in order to have the tools appear.
 272
 273         @see AddSeparator(), AddCheckTool(), AddRadioTool(),
 274              InsertTool(), DeleteTool(), Realize()
 275     */
 276     wxToolBarToolBase* AddTool(int toolId, const wxString& label,
 277                                const wxBitmap& bitmap1,
 278                                const wxString& shortHelpString = "",
 279                                wxItemKind kind = wxITEM_NORMAL);
 280     wxToolBarToolBase* AddTool(int toolId, const wxString& label,
 281                                const wxBitmap& bitmap1,
 282                                const wxBitmap& bitmap2 = wxNullBitmap,
 283                                wxItemKind kind = wxITEM_NORMAL,
 284                                const wxString& shortHelpString = "",
 285                                const wxString& longHelpString = "",
 286                                wxObject* clientData = NULL);
 287     wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
 288     //@}
 289
 290     /**
 291         Deletes all the tools in the toolbar.
 292     */
 293     void ClearTools();
 294
 295     /**
 296         Removes the specified tool from the toolbar and deletes it. If you don't
 297         want to delete the tool, but just to remove it from the toolbar (to
 298         possibly add it back later), you may use RemoveTool() instead.
 299
 300         @note It is unnecessary to call Realize() for the change to take
 301             place, it will happen immediately.
 302
 303         @returns @true if the tool was deleted, @false otherwise.
 304
 305         @see DeleteToolByPos()
 306     */
 307     bool DeleteTool(int toolId);
 308
 309     /**
 310         This function behaves like DeleteTool() but it deletes the tool at the
 311         specified position and not the one with the given id.
 312     */
 313     bool DeleteToolByPos(size_t pos);
 314
 315     /**
 316         Enables or disables the tool.
 317
 318         @param toolId
 319             Tool to enable or disable.
 320         @param enable
 321             If @true, enables the tool, otherwise disables it.
 322
 323         @remarks Some implementations will change the visible state of the tool
 324             to indicate that it is disabled.
 325
 326
 327         @see GetToolEnabled(), ToggleTool()
 328     */
 329     void EnableTool(int toolId, bool enable);
 330
 331     /**
 332         Returns a pointer to the tool identified by @a id or @NULL if no
 333         corresponding tool is found.
 334     */
 335     wxToolBarToolBase* FindById(int id);
 336
 337     /**
 338         Returns a pointer to the control identified by @a id or @NULL if no
 339         corresponding control is found.
 340     */
 341     wxControl* FindControl(int id);
 342
 343     /**
 344         Finds a tool for the given mouse position.
 345
 346         @param x
 347             X position.
 348         @param y
 349             Y position.
 350
 351         @return A pointer to a tool if a tool is found, or @NULL otherwise.
 352
 353         @remarks Currently not implemented in wxGTK (always returns @NULL
 354         there).
 355     */
 356     wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
 357
 358     /**
 359         Returns the left/right and top/bottom margins, which are also used for
 360         inter-toolspacing.
 361
 362         @see SetMargins()
 363     */
 364     wxSize GetMargins() const;
 365
 366     /**
 367         Returns the size of bitmap that the toolbar expects to have. The default
 368         bitmap size is 16 by 15 pixels.
 369
 370         @remarks Note that this is the size of the bitmap you pass to AddTool(),
 371             and not the eventual size of the tool button.
 372
 373         @see SetToolBitmapSize(), GetToolSize()
 374     */
 375     wxSize GetToolBitmapSize();
 376
 377     /**
 378         Get any client data associated with the tool.
 379
 380         @param toolId
 381             Id of the tool, as passed to AddTool().
 382
 383         @return Client data, or @NULL if there is none.
 384     */
 385     wxObject* GetToolClientData(int toolId) const;
 386
 387     /**
 388         Called to determine whether a tool is enabled (responds to user input).
 389
 390         @param toolId
 391             Id of the tool in question.
 392
 393         @return @true if the tool is enabled, @false otherwise.
 394
 395         @see EnableTool()
 396     */
 397     bool GetToolEnabled(int toolId) const;
 398
 399     /**
 400         Returns the long help for the given tool.
 401
 402         @param toolId
 403             The tool in question.
 404
 405         @see SetToolLongHelp(), SetToolShortHelp()
 406     */
 407     wxString GetToolLongHelp(int toolId) const;
 408
 409     /**
 410         Returns the value used for packing tools.
 411
 412         @see SetToolPacking()
 413     */
 414     int GetToolPacking() const;
 415
 416     /**
 417         Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
 418         is not found.
 419     */
 420     int GetToolPos(int toolId) const;
 421
 422     /**
 423         Returns the default separator size.
 424
 425         @see SetToolSeparation()
 426     */
 427     int GetToolSeparation() const;
 428
 429     /**
 430         Returns the short help for the given tool.
 431
 432         @param toolId
 433             The tool in question.
 434
 435         @see GetToolLongHelp(), SetToolShortHelp()
 436     */
 437     wxString GetToolShortHelp(int toolId) const;
 438
 439     /**
 440         Returns the size of a whole button, which is usually larger than a tool
 441         bitmap because of added 3D effects.
 442
 443         @see SetToolBitmapSize(), GetToolBitmapSize()
 444     */
 445     wxSize GetToolSize();
 446
 447     /**
 448         Gets the on/off state of a toggle tool.
 449
 450         @param toolId
 451             The tool in question.
 452
 453         @return @true if the tool is toggled on, @false otherwise.
 454
 455         @see ToggleTool()
 456     */
 457     bool GetToolState(int toolId) const;
 458
 459     /**
 460         Returns the number of tools in the toolbar.
 461     */
 462     int GetToolsCount() const;
 463
 464     /**
 465         Inserts the control into the toolbar at the given position. You must
 466         call Realize() for the change to take place.
 467
 468         @see AddControl(), InsertTool()
 469     */
 470     wxToolBarToolBase* InsertControl(size_t pos, wxControl* control);
 471
 472     /**
 473         Inserts the separator into the toolbar at the given position. You must
 474         call Realize() for the change to take place.
 475
 476         @see AddSeparator(), InsertTool()
 477     */
 478     wxToolBarToolBase* InsertSeparator(size_t pos);
 479
 480     //@{
 481     /**
 482         Inserts the tool with the specified attributes into the toolbar at the
 483         given position.
 484
 485         You must call Realize() for the change to take place.
 486
 487         @see AddTool(), InsertControl(), InsertSeparator()
 488     */
 489     wxToolBarToolBase* InsertTool(size_t pos, int toolId,
 490                                   const wxBitmap& bitmap1,
 491                                   const wxBitmap& bitmap2 = wxNullBitmap,
 492                                   bool isToggle = false,
 493                                   wxObject* clientData = NULL,
 494                                   const wxString& shortHelpString = "",
 495                                   const wxString& longHelpString = "");
 496     wxToolBarToolBase* InsertTool(size_t pos,
 497                                   wxToolBarToolBase* tool);
 498     //@}
 499
 500     /**
 501         Called when the user clicks on a tool with the left mouse button. This
 502         is the old way of detecting tool clicks; although it will still work,
 503         you should use the EVT_MENU() or EVT_TOOL() macro instead.
 504
 505         @param toolId
 506             The identifier passed to AddTool().
 507         @param toggleDown
 508             @true if the tool is a toggle and the toggle is down, otherwise is
 509             @false.
 510
 511         @return If the tool is a toggle and this function returns @false, the
 512                 toggle state (internal and visual) will not be changed. This
 513                 provides a way of specifying that toggle operations are not
 514                 permitted in some circumstances.
 515
 516         @see OnMouseEnter(), OnRightClick()
 517     */
 518     bool OnLeftClick(int toolId, bool toggleDown);
 519
 520     /**
 521         This is called when the mouse cursor moves into a tool or out of the
 522         toolbar. This is the old way of detecting mouse enter events;
 523         although it will still work, you should use the EVT_TOOL_ENTER()
 524         macro instead.
 525
 526         @param toolId
 527             Greater than -1 if the mouse cursor has moved into the tool, or -1
 528             if the mouse cursor has moved. The programmer can override this to
 529             provide extra information about the tool, such as a short
 530             description on the status line.
 531
 532         @remarks With some derived toolbar classes, if the mouse moves quickly
 533                  out of the toolbar, wxWidgets may not be able to detect it.
 534                  Therefore this function may not always be called when expected.
 535     */
 536     void OnMouseEnter(int toolId);
 537
 538     /**
 539         @deprecated This is the old way of detecting tool right clicks;
 540                     although it will still work, you should use the
 541                     EVT_TOOL_RCLICKED() macro instead.
 542
 543         Called when the user clicks on a tool with the right mouse button. The
 544         programmer should override this function to detect right tool clicks.
 545
 546         @param toolId
 547             The identifier passed to AddTool().
 548         @param x
 549             The x position of the mouse cursor.
 550         @param y
 551             The y position of the mouse cursor.
 552
 553         @remarks A typical use of this member might be to pop up a menu.
 554
 555         @see OnMouseEnter(), OnLeftClick()
 556     */
 557     void OnRightClick(int toolId, float x, float y);
 558
 559     /**
 560         This function should be called after you have added tools.
 561     */
 562     bool Realize();
 563
 564     /**
 565         Removes the given tool from the toolbar but doesn't delete it. This
 566         allows to insert/add this tool back to this (or another) toolbar later.
 567
 568         @note It is unnecessary to call Realize() for the change to take place,
 569             it will happen immediately.
 570
 571
 572         @see DeleteTool()
 573     */
 574     wxToolBarToolBase* RemoveTool(int id);
 575
 576     /**
 577         Sets the bitmap resource identifier for specifying tool bitmaps as
 578         indices into a custom bitmap. Windows CE only.
 579     */
 580     void SetBitmapResource(int resourceId);
 581
 582     /**
 583         Sets the dropdown menu for the tool given by its @e id. The tool itself
 584         will delete the menu when it's no longer needed.
 585
 586         If you define a EVT_TOOL_DROPDOWN() handler in your program, you must
 587         call wxEvent::Skip() from it or the menu won't be displayed.
 588     */
 589     bool SetDropdownMenu(int id, wxMenu* menu);
 590
 591     //@{
 592     /**
 593         Set the values to be used as margins for the toolbar.
 594
 595         @param size
 596             Margin size.
 597         @param x
 598             Left margin, right margin and inter-tool separation value.
 599         @param y
 600             Top margin, bottom margin and inter-tool separation value.
 601
 602         @remarks This must be called before the tools are added if absolute
 603             positioning is to be used, and the default (zero-size) margins are
 604             to be overridden.
 605
 606         @see GetMargins(), wxSize
 607     */
 608     void SetMargins(const wxSize& size);
 609     void SetMargins(int x, int y);
 610     //@}
 611
 612     /**
 613         Sets the default size of each tool bitmap. The default bitmap size is 16
 614         by 15 pixels.
 615
 616         @param size
 617             The size of the bitmaps in the toolbar.
 618
 619         @remarks This should be called to tell the toolbar what the tool bitmap
 620             size is. Call it before you add tools.
 621
 622         @see GetToolBitmapSize(), GetToolSize()
 623     */
 624     void SetToolBitmapSize(const wxSize& size);
 625
 626     /**
 627         Sets the client data associated with the tool.
 628     */
 629     void SetToolClientData(int id, wxObject* clientData);
 630
 631     /**
 632         Sets the bitmap to be used by the tool with the given ID when the tool
 633         is in a disabled state. This can only be used on Button tools, not
 634         controls.
 635
 636         @note The native toolbar classes on the main platforms all synthesize
 637             the disabled bitmap from the normal bitmap, so this function will
 638             have no effect on those platforms.
 639
 640     */
 641     void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
 642
 643     /**
 644         Sets the long help for the given tool.
 645
 646         @param toolId
 647             The tool in question.
 648         @param helpString
 649             A string for the long help.
 650
 651         @remarks You might use the long help for displaying the tool purpose on
 652             the status line.
 653
 654         @see GetToolLongHelp(), SetToolShortHelp(),
 655     */
 656     void SetToolLongHelp(int toolId, const wxString& helpString);
 657
 658     /**
 659         Sets the bitmap to be used by the tool with the given ID. This can only
 660         be used on Button tools, not controls.
 661     */
 662     void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
 663
 664     /**
 665         Sets the value used for spacing tools. The default value is 1.
 666
 667         @param packing
 668             The value for packing.
 669
 670         @remarks The packing is used for spacing in the vertical direction if
 671             the toolbar is horizontal, and for spacing in the horizontal
 672             direction if the toolbar is vertical.
 673
 674         @see GetToolPacking()
 675     */
 676     void SetToolPacking(int packing);
 677
 678     /**
 679         Sets the default separator size. The default value is 5.
 680
 681         @param separation
 682             The separator size.
 683
 684         @see AddSeparator()
 685     */
 686     void SetToolSeparation(int separation);
 687
 688     /**
 689         Sets the short help for the given tool.
 690
 691         @param toolId
 692             The tool in question.
 693         @param helpString
 694             The string for the short help.
 695
 696         @remarks An application might use short help for identifying the tool
 697             purpose in a tooltip.
 698
 699
 700         @see GetToolShortHelp(), SetToolLongHelp()
 701     */
 702     void SetToolShortHelp(int toolId, const wxString& helpString);
 703
 704     /**
 705         Toggles a tool on or off. This does not cause any event to get emitted.
 706
 707         @param toolId
 708             Tool in question.
 709         @param toggle
 710             If @true, toggles the tool on, otherwise toggles it off.
 711
 712         @remarks Only applies to a tool that has been specified as a toggle
 713             tool.
 714     */
 715     void ToggleTool(int toolId, bool toggle);
 716 };
 717