include/wx/tbarbase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/tbarbase.h
   3 // Purpose:     Base class for toolbar classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TBARBASE_H_
  13 #define _WX_TBARBASE_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_TOOLBAR
  22
  23 #include "wx/bitmap.h"
  24 #include "wx/list.h"
  25 #include "wx/control.h"
  26
  27 class WXDLLIMPEXP_FWD_CORE wxToolBarBase;
  28 class WXDLLIMPEXP_FWD_CORE wxToolBarToolBase;
  29 class WXDLLIMPEXP_FWD_CORE wxImage;
  30
  31 // ----------------------------------------------------------------------------
  32 // constants
  33 // ----------------------------------------------------------------------------
  34
  35 extern WXDLLIMPEXP_DATA_CORE(const char) wxToolBarNameStr[];
  36 extern WXDLLIMPEXP_DATA_CORE(const wxSize) wxDefaultSize;
  37 extern WXDLLIMPEXP_DATA_CORE(const wxPoint) wxDefaultPosition;
  38
  39 enum wxToolBarToolStyle
  40 {
  41     wxTOOL_STYLE_BUTTON    = 1,
  42     wxTOOL_STYLE_SEPARATOR = 2,
  43     wxTOOL_STYLE_CONTROL
  44 };
  45
  46 // ----------------------------------------------------------------------------
  47 // wxToolBarTool is a toolbar element.
  48 //
  49 // It has a unique id (except for the separators which always have id wxID_ANY), the
  50 // style (telling whether it is a normal button, separator or a control), the
  51 // state (toggled or not, enabled or not) and short and long help strings. The
  52 // default implementations use the short help string for the tooltip text which
  53 // is popped up when the mouse pointer enters the tool and the long help string
  54 // for the applications status bar.
  55 // ----------------------------------------------------------------------------
  56
  57 class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject
  58 {
  59 public:
  60     // ctors & dtor
  61     // ------------
  62
  63     // generic ctor for any kind of tool
  64     wxToolBarToolBase(wxToolBarBase *tbar = NULL,
  65                       int toolid = wxID_SEPARATOR,
  66                       const wxString& label = wxEmptyString,
  67                       const wxBitmap& bmpNormal = wxNullBitmap,
  68                       const wxBitmap& bmpDisabled = wxNullBitmap,
  69                       wxItemKind kind = wxITEM_NORMAL,
  70                       wxObject *clientData = NULL,
  71                       const wxString& shortHelpString = wxEmptyString,
  72                       const wxString& longHelpString = wxEmptyString)
  73         : m_label(label),
  74           m_shortHelpString(shortHelpString),
  75           m_longHelpString(longHelpString)
  76     {
  77         Init
  78         (
  79             tbar,
  80             toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR
  81                                      : wxTOOL_STYLE_BUTTON,
  82             toolid == wxID_ANY ? wxWindow::NewControlId()
  83                                : toolid,
  84             kind
  85         );
  86
  87         m_clientData = clientData;
  88
  89         m_bmpNormal = bmpNormal;
  90         m_bmpDisabled = bmpDisabled;
  91     }
  92
  93     // ctor for controls only
  94     wxToolBarToolBase(wxToolBarBase *tbar,
  95                       wxControl *control,
  96                       const wxString& label)
  97         : m_label(label)
  98     {
  99         Init(tbar, wxTOOL_STYLE_CONTROL, control->GetId(), wxITEM_MAX);
 100
 101         m_control = control;
 102     }
 103
 104     virtual ~wxToolBarToolBase();
 105
 106     // accessors
 107     // ---------
 108
 109     // general
 110     int GetId() const { return m_id; }
 111
 112     wxControl *GetControl() const
 113     {
 114         wxASSERT_MSG( IsControl(), wxT("this toolbar tool is not a control") );
 115
 116         return m_control;
 117     }
 118
 119     wxToolBarBase *GetToolBar() const { return m_tbar; }
 120
 121     // style/kind
 122     bool IsStretchable() const { return m_stretchable; }
 123     bool IsButton() const { return m_toolStyle == wxTOOL_STYLE_BUTTON; }
 124     bool IsControl() const { return m_toolStyle == wxTOOL_STYLE_CONTROL; }
 125     bool IsSeparator() const { return m_toolStyle == wxTOOL_STYLE_SEPARATOR; }
 126     bool IsStretchableSpace() const { return IsSeparator() && IsStretchable(); }
 127     int GetStyle() const { return m_toolStyle; }
 128     wxItemKind GetKind() const
 129     {
 130         wxASSERT_MSG( IsButton(), wxT("only makes sense for buttons") );
 131
 132         return m_kind;
 133     }
 134
 135     void MakeStretchable()
 136     {
 137         wxASSERT_MSG( IsSeparator(), "only separators can be stretchable" );
 138
 139         m_stretchable = true;
 140     }
 141
 142     // state
 143     bool IsEnabled() const { return m_enabled; }
 144     bool IsToggled() const { return m_toggled; }
 145     bool CanBeToggled() const
 146         { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; }
 147
 148     // attributes
 149     const wxBitmap& GetNormalBitmap() const { return m_bmpNormal; }
 150     const wxBitmap& GetDisabledBitmap() const { return m_bmpDisabled; }
 151
 152     const wxBitmap& GetBitmap() const
 153         { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
 154
 155     const wxString& GetLabel() const { return m_label; }
 156
 157     const wxString& GetShortHelp() const { return m_shortHelpString; }
 158     const wxString& GetLongHelp() const { return m_longHelpString; }
 159
 160     wxObject *GetClientData() const
 161     {
 162         if ( m_toolStyle == wxTOOL_STYLE_CONTROL )
 163         {
 164             return (wxObject*)m_control->GetClientData();
 165         }
 166         else
 167         {
 168             return m_clientData;
 169         }
 170     }
 171
 172     // modifiers: return true if the state really changed
 173     virtual bool Enable(bool enable);
 174     virtual bool Toggle(bool toggle);
 175     virtual bool SetToggle(bool toggle);
 176     virtual bool SetShortHelp(const wxString& help);
 177     virtual bool SetLongHelp(const wxString& help);
 178
 179     void Toggle() { Toggle(!IsToggled()); }
 180
 181     virtual void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; }
 182     virtual void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; }
 183
 184     virtual void SetLabel(const wxString& label) { m_label = label; }
 185
 186     void SetClientData(wxObject *clientData)
 187     {
 188         if ( m_toolStyle == wxTOOL_STYLE_CONTROL )
 189         {
 190             m_control->SetClientData(clientData);
 191         }
 192         else
 193         {
 194             m_clientData = clientData;
 195         }
 196     }
 197
 198     // add tool to/remove it from a toolbar
 199     virtual void Detach() { m_tbar = NULL; }
 200     virtual void Attach(wxToolBarBase *tbar) { m_tbar = tbar; }
 201
 202 #if wxUSE_MENUS
 203     // these methods are only for tools of wxITEM_DROPDOWN kind (but even such
 204     // tools can have a NULL associated menu)
 205     virtual void SetDropdownMenu(wxMenu *menu);
 206     wxMenu *GetDropdownMenu() const { return m_dropdownMenu; }
 207 #endif
 208
 209 protected:
 210     // common part of all ctors
 211     void Init(wxToolBarBase *tbar,
 212               wxToolBarToolStyle style,
 213               int toolid,
 214               wxItemKind kind)
 215     {
 216         m_tbar = tbar;
 217         m_toolStyle = style;
 218         m_id = toolid;
 219         m_kind = kind;
 220
 221         m_clientData = NULL;
 222
 223         m_stretchable = false;
 224         m_toggled = false;
 225         m_enabled = true;
 226
 227 #if wxUSE_MENUS
 228         m_dropdownMenu = NULL;
 229 #endif
 230
 231     }
 232
 233     wxToolBarBase *m_tbar;  // the toolbar to which we belong (may be NULL)
 234
 235     // tool parameters
 236     wxToolBarToolStyle m_toolStyle;
 237     wxWindowIDRef m_id; // the tool id, wxID_SEPARATOR for separator
 238     wxItemKind m_kind;  // for normal buttons may be wxITEM_NORMAL/CHECK/RADIO
 239
 240     // as controls have their own client data, no need to waste memory
 241     union
 242     {
 243         wxObject         *m_clientData;
 244         wxControl        *m_control;
 245     };
 246
 247     // true if this tool is stretchable: currently is only value for separators
 248     bool m_stretchable;
 249
 250     // tool state
 251     bool m_toggled;
 252     bool m_enabled;
 253
 254     // normal and disabled bitmaps for the tool, both can be invalid
 255     wxBitmap m_bmpNormal;
 256     wxBitmap m_bmpDisabled;
 257
 258     // the button label
 259     wxString m_label;
 260
 261     // short and long help strings
 262     wxString m_shortHelpString;
 263     wxString m_longHelpString;
 264
 265 #if wxUSE_MENUS
 266     wxMenu *m_dropdownMenu;
 267 #endif
 268
 269     DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)
 270 };
 271
 272 // a list of toolbar tools
 273 WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase, wxToolBarToolsList);
 274
 275 // ----------------------------------------------------------------------------
 276 // the base class for all toolbars
 277 // ----------------------------------------------------------------------------
 278
 279 class WXDLLIMPEXP_CORE wxToolBarBase : public wxControl
 280 {
 281 public:
 282     wxToolBarBase();
 283     virtual ~wxToolBarBase();
 284
 285     // toolbar construction
 286     // --------------------
 287
 288     // the full AddTool() function
 289     //
 290     // If bmpDisabled is wxNullBitmap, a shadowed version of the normal bitmap
 291     // is created and used as the disabled image.
 292     wxToolBarToolBase *AddTool(int toolid,
 293                                const wxString& label,
 294                                const wxBitmap& bitmap,
 295                                const wxBitmap& bmpDisabled,
 296                                wxItemKind kind = wxITEM_NORMAL,
 297                                const wxString& shortHelp = wxEmptyString,
 298                                const wxString& longHelp = wxEmptyString,
 299                                wxObject *data = NULL)
 300     {
 301         return DoAddTool(toolid, label, bitmap, bmpDisabled, kind,
 302                          shortHelp, longHelp, data);
 303     }
 304
 305     // the most common AddTool() version
 306     wxToolBarToolBase *AddTool(int toolid,
 307                                const wxString& label,
 308                                const wxBitmap& bitmap,
 309                                const wxString& shortHelp = wxEmptyString,
 310                                wxItemKind kind = wxITEM_NORMAL)
 311     {
 312         return AddTool(toolid, label, bitmap, wxNullBitmap, kind, shortHelp);
 313     }
 314
 315     // add a check tool, i.e. a tool which can be toggled
 316     wxToolBarToolBase *AddCheckTool(int toolid,
 317                                     const wxString& label,
 318                                     const wxBitmap& bitmap,
 319                                     const wxBitmap& bmpDisabled = wxNullBitmap,
 320                                     const wxString& shortHelp = wxEmptyString,
 321                                     const wxString& longHelp = wxEmptyString,
 322                                     wxObject *data = NULL)
 323     {
 324         return AddTool(toolid, label, bitmap, bmpDisabled, wxITEM_CHECK,
 325                        shortHelp, longHelp, data);
 326     }
 327
 328     // add a radio tool, i.e. a tool which can be toggled and releases any
 329     // other toggled radio tools in the same group when it happens
 330     wxToolBarToolBase *AddRadioTool(int toolid,
 331                                     const wxString& label,
 332                                     const wxBitmap& bitmap,
 333                                     const wxBitmap& bmpDisabled = wxNullBitmap,
 334                                     const wxString& shortHelp = wxEmptyString,
 335                                     const wxString& longHelp = wxEmptyString,
 336                                     wxObject *data = NULL)
 337     {
 338         return AddTool(toolid, label, bitmap, bmpDisabled, wxITEM_RADIO,
 339                        shortHelp, longHelp, data);
 340     }
 341
 342
 343     // insert the new tool at the given position, if pos == GetToolsCount(), it
 344     // is equivalent to AddTool()
 345     virtual wxToolBarToolBase *InsertTool
 346                                (
 347                                     size_t pos,
 348                                     int toolid,
 349                                     const wxString& label,
 350                                     const wxBitmap& bitmap,
 351                                     const wxBitmap& bmpDisabled = wxNullBitmap,
 352                                     wxItemKind kind = wxITEM_NORMAL,
 353                                     const wxString& shortHelp = wxEmptyString,
 354                                     const wxString& longHelp = wxEmptyString,
 355                                     wxObject *clientData = NULL
 356                                );
 357
 358     virtual wxToolBarToolBase *AddTool (wxToolBarToolBase *tool);
 359     virtual wxToolBarToolBase *InsertTool (size_t pos, wxToolBarToolBase *tool);
 360
 361     // add an arbitrary control to the toolbar (notice that the control will be
 362     // deleted by the toolbar and that it will also adjust its position/size)
 363     //
 364     // the label is optional and, if specified, will be shown near the control
 365     // NB: the control should have toolbar as its parent
 366     virtual wxToolBarToolBase *
 367     AddControl(wxControl *control, const wxString& label = wxEmptyString);
 368
 369     virtual wxToolBarToolBase *
 370     InsertControl(size_t pos, wxControl *control,
 371                   const wxString& label = wxEmptyString);
 372
 373     // get the control with the given id or return NULL
 374     virtual wxControl *FindControl( int toolid );
 375
 376     // add a separator to the toolbar
 377     virtual wxToolBarToolBase *AddSeparator();
 378     virtual wxToolBarToolBase *InsertSeparator(size_t pos);
 379
 380     // add a stretchable space to the toolbar: this is similar to a separator
 381     // except that it's always blank and that all the extra space the toolbar
 382     // has is [equally] distributed among the stretchable spaces in it
 383     virtual wxToolBarToolBase *AddStretchableSpace();
 384     virtual wxToolBarToolBase *InsertStretchableSpace(size_t pos);
 385
 386     // remove the tool from the toolbar: the caller is responsible for actually
 387     // deleting the pointer
 388     virtual wxToolBarToolBase *RemoveTool(int toolid);
 389
 390     // delete tool either by index or by position
 391     virtual bool DeleteToolByPos(size_t pos);
 392     virtual bool DeleteTool(int toolid);
 393
 394     // delete all tools
 395     virtual void ClearTools();
 396
 397     // must be called after all buttons have been created to finish toolbar
 398     // initialisation
 399     //
 400     // derived class versions should call the base one first, before doing
 401     // platform-specific stuff
 402     virtual bool Realize();
 403
 404     // tools state
 405     // -----------
 406
 407     virtual void EnableTool(int toolid, bool enable);
 408     virtual void ToggleTool(int toolid, bool toggle);
 409
 410     // Set this to be togglable (or not)
 411     virtual void SetToggle(int toolid, bool toggle);
 412
 413     // set/get tools client data (not for controls)
 414     virtual wxObject *GetToolClientData(int toolid) const;
 415     virtual void SetToolClientData(int toolid, wxObject *clientData);
 416
 417     // returns tool pos, or wxNOT_FOUND if tool isn't found
 418     virtual int GetToolPos(int id) const;
 419
 420     // return true if the tool is toggled
 421     virtual bool GetToolState(int toolid) const;
 422
 423     virtual bool GetToolEnabled(int toolid) const;
 424
 425     virtual void SetToolShortHelp(int toolid, const wxString& helpString);
 426     virtual wxString GetToolShortHelp(int toolid) const;
 427     virtual void SetToolLongHelp(int toolid, const wxString& helpString);
 428     virtual wxString GetToolLongHelp(int toolid) const;
 429
 430     virtual void SetToolNormalBitmap(int WXUNUSED(id),
 431                                      const wxBitmap& WXUNUSED(bitmap)) {}
 432     virtual void SetToolDisabledBitmap(int WXUNUSED(id),
 433                                        const wxBitmap& WXUNUSED(bitmap)) {}
 434
 435
 436     // margins/packing/separation
 437     // --------------------------
 438
 439     virtual void SetMargins(int x, int y);
 440     void SetMargins(const wxSize& size)
 441         { SetMargins((int) size.x, (int) size.y); }
 442     virtual void SetToolPacking(int packing)
 443         { m_toolPacking = packing; }
 444     virtual void SetToolSeparation(int separation)
 445         { m_toolSeparation = separation; }
 446
 447     virtual wxSize GetToolMargins() const { return wxSize(m_xMargin, m_yMargin); }
 448     virtual int GetToolPacking() const { return m_toolPacking; }
 449     virtual int GetToolSeparation() const { return m_toolSeparation; }
 450
 451     // toolbar geometry
 452     // ----------------
 453
 454     // set the number of toolbar rows
 455     virtual void SetRows(int nRows);
 456
 457     // the toolbar can wrap - limit the number of columns or rows it may take
 458     void SetMaxRowsCols(int rows, int cols)
 459         { m_maxRows = rows; m_maxCols = cols; }
 460     int GetMaxRows() const { return m_maxRows; }
 461     int GetMaxCols() const { return m_maxCols; }
 462
 463     // get/set the size of the bitmaps used by the toolbar: should be called
 464     // before adding any tools to the toolbar
 465     virtual void SetToolBitmapSize(const wxSize& size)
 466         { m_defaultWidth = size.x; m_defaultHeight = size.y; }
 467     virtual wxSize GetToolBitmapSize() const
 468         { return wxSize(m_defaultWidth, m_defaultHeight); }
 469
 470     // the button size in some implementations is bigger than the bitmap size:
 471     // get the total button size (by default the same as bitmap size)
 472     virtual wxSize GetToolSize() const
 473         { return GetToolBitmapSize(); }
 474
 475     // returns a (non separator) tool containing the point (x, y) or NULL if
 476     // there is no tool at this point (coordinates are client)
 477     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x,
 478                                                    wxCoord y) const = 0;
 479
 480     // find the tool by id
 481     wxToolBarToolBase *FindById(int toolid) const;
 482
 483     // return true if this is a vertical toolbar, otherwise false
 484     bool IsVertical() const;
 485
 486     // these methods allow to access tools by their index in the toolbar
 487     size_t GetToolsCount() const { return m_tools.GetCount(); }
 488     const wxToolBarToolBase *GetToolByPos(int pos) const { return m_tools[pos]; }
 489
 490 #if WXWIN_COMPATIBILITY_2_8
 491     // the old versions of the various methods kept for compatibility
 492     // don't use in the new code!
 493     // --------------------------------------------------------------
 494     wxDEPRECATED_INLINE(
 495     wxToolBarToolBase *AddTool(int toolid,
 496                                const wxBitmap& bitmap,
 497                                const wxBitmap& bmpDisabled,
 498                                bool toggle = false,
 499                                wxObject *clientData = NULL,
 500                                const wxString& shortHelpString = wxEmptyString,
 501                                const wxString& longHelpString = wxEmptyString)
 502     ,
 503         return AddTool(toolid, wxEmptyString,
 504                        bitmap, bmpDisabled,
 505                        toggle ? wxITEM_CHECK : wxITEM_NORMAL,
 506                        shortHelpString, longHelpString, clientData);
 507     )
 508     wxDEPRECATED_INLINE(
 509     wxToolBarToolBase *AddTool(int toolid,
 510                                const wxBitmap& bitmap,
 511                                const wxString& shortHelpString = wxEmptyString,
 512                                const wxString& longHelpString = wxEmptyString)
 513     ,
 514         return AddTool(toolid, wxEmptyString,
 515                        bitmap, wxNullBitmap, wxITEM_NORMAL,
 516                        shortHelpString, longHelpString, NULL);
 517     )
 518     wxDEPRECATED_INLINE(
 519     wxToolBarToolBase *AddTool(int toolid,
 520                                const wxBitmap& bitmap,
 521                                const wxBitmap& bmpDisabled,
 522                                bool toggle,
 523                                wxCoord xPos,
 524                                wxCoord yPos = wxDefaultCoord,
 525                                wxObject *clientData = NULL,
 526                                const wxString& shortHelp = wxEmptyString,
 527                                const wxString& longHelp = wxEmptyString)
 528     ,
 529         return DoAddTool(toolid, wxEmptyString, bitmap, bmpDisabled,
 530                          toggle ? wxITEM_CHECK : wxITEM_NORMAL,
 531                          shortHelp, longHelp, clientData, xPos, yPos);
 532     )
 533     wxDEPRECATED_INLINE(
 534     wxToolBarToolBase *InsertTool(size_t pos,
 535                                   int toolid,
 536                                   const wxBitmap& bitmap,
 537                                   const wxBitmap& bmpDisabled = wxNullBitmap,
 538                                   bool toggle = false,
 539                                   wxObject *clientData = NULL,
 540                                   const wxString& shortHelp = wxEmptyString,
 541                                   const wxString& longHelp = wxEmptyString)
 542     ,
 543         return InsertTool(pos, toolid, wxEmptyString, bitmap, bmpDisabled,
 544                           toggle ? wxITEM_CHECK : wxITEM_NORMAL,
 545                           shortHelp, longHelp, clientData);
 546     )
 547 #endif // WXWIN_COMPATIBILITY_2_8
 548
 549     // event handlers
 550     // --------------
 551
 552     // NB: these functions are deprecated, use EVT_TOOL_XXX() instead!
 553
 554     // Only allow toggle if returns true. Call when left button up.
 555     virtual bool OnLeftClick(int toolid, bool toggleDown);
 556
 557     // Call when right button down.
 558     virtual void OnRightClick(int toolid, long x, long y);
 559
 560     // Called when the mouse cursor enters a tool bitmap.
 561     // Argument is wxID_ANY if mouse is exiting the toolbar.
 562     virtual void OnMouseEnter(int toolid);
 563
 564     // more deprecated functions
 565     // -------------------------
 566
 567     // use GetToolMargins() instead
 568     wxSize GetMargins() const { return GetToolMargins(); }
 569
 570     // Tool factories,
 571     // helper functions to create toolbar tools
 572     // -------------------------
 573     virtual wxToolBarToolBase *CreateTool(int toolid,
 574                                           const wxString& label,
 575                                           const wxBitmap& bmpNormal,
 576                                           const wxBitmap& bmpDisabled = wxNullBitmap,
 577                                           wxItemKind kind = wxITEM_NORMAL,
 578                                           wxObject *clientData = NULL,
 579                                           const wxString& shortHelp = wxEmptyString,
 580                                           const wxString& longHelp = wxEmptyString) = 0;
 581
 582     virtual wxToolBarToolBase *CreateTool(wxControl *control,
 583                                           const wxString& label) = 0;
 584
 585     // this one is not virtual but just a simple helper/wrapper around
 586     // CreateTool() for separators
 587     wxToolBarToolBase *CreateSeparator()
 588     {
 589         return CreateTool(wxID_SEPARATOR,
 590                           wxEmptyString,
 591                           wxNullBitmap, wxNullBitmap,
 592                           wxITEM_SEPARATOR, NULL,
 593                           wxEmptyString, wxEmptyString);
 594     }
 595
 596
 597     // implementation only from now on
 598     // -------------------------------
 599
 600     // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
 601     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE) ;
 602
 603     // don't want toolbars to accept the focus
 604     virtual bool AcceptsFocus() const { return false; }
 605
 606 #if wxUSE_MENUS
 607     // Set dropdown menu
 608     bool SetDropdownMenu(int toolid, wxMenu *menu);
 609 #endif
 610
 611 protected:
 612     // to implement in derived classes
 613     // -------------------------------
 614
 615     // create a new toolbar tool and add it to the toolbar, this is typically
 616     // implemented by just calling InsertTool()
 617     virtual wxToolBarToolBase *DoAddTool
 618                                (
 619                                    int toolid,
 620                                    const wxString& label,
 621                                    const wxBitmap& bitmap,
 622                                    const wxBitmap& bmpDisabled,
 623                                    wxItemKind kind,
 624                                    const wxString& shortHelp = wxEmptyString,
 625                                    const wxString& longHelp = wxEmptyString,
 626                                    wxObject *clientData = NULL,
 627                                    wxCoord xPos = wxDefaultCoord,
 628                                    wxCoord yPos = wxDefaultCoord
 629                                );
 630
 631     // the tool is not yet inserted into m_tools list when this function is
 632     // called and will only be added to it if this function succeeds
 633     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool) = 0;
 634
 635     // the tool is still in m_tools list when this function is called, it will
 636     // only be deleted from it if it succeeds
 637     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool) = 0;
 638
 639     // called when the tools enabled flag changes
 640     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable) = 0;
 641
 642     // called when the tool is toggled
 643     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle) = 0;
 644
 645     // called when the tools "can be toggled" flag changes
 646     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle) = 0;
 647
 648
 649     // helper functions
 650     // ----------------
 651
 652     // call this from derived class ctor/Create() to ensure that we have either
 653     // wxTB_HORIZONTAL or wxTB_VERTICAL style, there is a lot of existing code
 654     // which randomly checks either one or the other of them and gets confused
 655     // if neither is set (and making one of them 0 is not an option neither as
 656     // then the existing tests would break down)
 657     void FixupStyle();
 658
 659     // un-toggle all buttons in the same radio group
 660     void UnToggleRadioGroup(wxToolBarToolBase *tool);
 661
 662     // make the size of the buttons big enough to fit the largest bitmap size
 663     void AdjustToolBitmapSize();
 664
 665     // calls InsertTool() and deletes the tool if inserting it failed
 666     wxToolBarToolBase *DoInsertNewTool(size_t pos, wxToolBarToolBase *tool)
 667     {
 668         if ( !InsertTool(pos, tool) )
 669         {
 670             delete tool;
 671             return NULL;
 672         }
 673
 674         return tool;
 675     }
 676
 677     // the list of all our tools
 678     wxToolBarToolsList m_tools;
 679
 680     // the offset of the first tool
 681     int m_xMargin;
 682     int m_yMargin;
 683
 684     // the maximum number of toolbar rows/columns
 685     int m_maxRows;
 686     int m_maxCols;
 687
 688     // the tool packing and separation
 689     int m_toolPacking,
 690         m_toolSeparation;
 691
 692     // the size of the toolbar bitmaps
 693     wxCoord m_defaultWidth, m_defaultHeight;
 694
 695 private:
 696     DECLARE_EVENT_TABLE()
 697     wxDECLARE_NO_COPY_CLASS(wxToolBarBase);
 698 };
 699
 700 // deprecated function for creating the image for disabled buttons, use
 701 // wxImage::ConvertToGreyscale() instead
 702 #if WXWIN_COMPATIBILITY_2_8
 703
 704 wxDEPRECATED( bool wxCreateGreyedImage(const wxImage& in, wxImage& out) );
 705
 706 #endif // WXWIN_COMPATIBILITY_2_8
 707
 708
 709 #endif // wxUSE_TOOLBAR
 710
 711 #endif
 712     // _WX_TBARBASE_H_
 713