A few tweaks and cleanups

[wxWidgets.git] / include / wx / tbarbase.h

diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h
index e75206df99d1a828dcf21fdf93df85c6386bfcd2..7899208435fb0eda43995904d5d8866645bec4c6 100644 (file)
--- a/include/wx/tbarbase.h
+++ b/include/wx/tbarbase.h
@@ -22,12 +22,15 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

+#if wxUSE_TOOLBAR
+

 #include "wx/bitmap.h"
 #include "wx/list.h"
 #include "wx/control.h"
 
 class WXDLLEXPORT wxToolBarBase;
 class WXDLLEXPORT wxToolBarToolBase;
 #include "wx/bitmap.h"
 #include "wx/list.h"
 #include "wx/control.h"
 
 class WXDLLEXPORT wxToolBarBase;
 class WXDLLEXPORT wxToolBarToolBase;

+class WXDLLEXPORT wxImage;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -63,23 +66,26 @@ public:
 
     wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL,
                       int id = wxID_SEPARATOR,
 
     wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL,
                       int id = wxID_SEPARATOR,

-                      const wxBitmap& bitmap1 = wxNullBitmap,
-                      const wxBitmap& bitmap2 = wxNullBitmap,
-                      bool toggle = FALSE,
+                      const wxString& label = wxEmptyString,
+                      const wxBitmap& bmpNormal = wxNullBitmap,
+                      const wxBitmap& bmpDisabled = wxNullBitmap,
+                      wxItemKind kind = wxITEM_NORMAL,

                       wxObject *clientData = (wxObject *) NULL,
                       const wxString& shortHelpString = wxEmptyString,
                       const wxString& longHelpString = wxEmptyString)
                       wxObject *clientData = (wxObject *) NULL,
                       const wxString& shortHelpString = wxEmptyString,
                       const wxString& longHelpString = wxEmptyString)

-        : m_shortHelpString(shortHelpString),
+        : m_label(label),
+          m_shortHelpString(shortHelpString),

           m_longHelpString(longHelpString)
     {
         m_tbar = tbar;
         m_id = id;
         m_clientData = clientData;
 
           m_longHelpString(longHelpString)
     {
         m_tbar = tbar;
         m_id = id;
         m_clientData = clientData;
 

-        m_bitmap1 = bitmap1;
-        m_bitmap2 = bitmap2;
+        m_bmpNormal = bmpNormal;
+        m_bmpDisabled = bmpDisabled;
+
+        m_kind = kind;

 
 

-        m_isToggle = toggle;

         m_enabled = TRUE;
         m_toggled = FALSE;
 
         m_enabled = TRUE;
         m_toggled = FALSE;
 


@@ -93,7 +99,8 @@ public:
         m_control = control;
         m_id = control->GetId();
 
         m_control = control;
         m_id = control->GetId();
 

-        m_isToggle = FALSE;
+        m_kind = wxITEM_MAX;    // invalid value
+

         m_enabled = TRUE;
         m_toggled = FALSE;
 
         m_enabled = TRUE;
         m_toggled = FALSE;
 


@@ -118,22 +125,31 @@ public:
     wxToolBarBase *GetToolBar() const { return m_tbar; }
 
     // style
     wxToolBarBase *GetToolBar() const { return m_tbar; }
 
     // style

-    int IsButton() const { return m_toolStyle == wxTOOL_STYLE_BUTTON; }
-    int IsControl() const { return m_toolStyle == wxTOOL_STYLE_CONTROL; }
-    int IsSeparator() const { return m_toolStyle == wxTOOL_STYLE_SEPARATOR; }
+    bool IsButton() const { return m_toolStyle == wxTOOL_STYLE_BUTTON; }
+    bool IsControl() const { return m_toolStyle == wxTOOL_STYLE_CONTROL; }
+    bool IsSeparator() const { return m_toolStyle == wxTOOL_STYLE_SEPARATOR; }

     int GetStyle() const { return m_toolStyle; }
     int GetStyle() const { return m_toolStyle; }

+    wxItemKind GetKind() const
+    {
+        wxASSERT_MSG( IsButton(), _T("only makes sense for buttons") );
+
+        return m_kind;
+    }

 
     // state
     bool IsEnabled() const { return m_enabled; }
     bool IsToggled() const { return m_toggled; }
 
     // state
     bool IsEnabled() const { return m_enabled; }
     bool IsToggled() const { return m_toggled; }

-    bool CanBeToggled() const { return m_isToggle; }
+    bool CanBeToggled() const
+        { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; }

 
     // attributes
 
     // attributes

-    const wxBitmap& GetBitmap1() const { return m_bitmap1; }
-    const wxBitmap& GetBitmap2() const { return m_bitmap2; }
+    const wxBitmap& GetNormalBitmap() const { return m_bmpNormal; }
+    const wxBitmap& GetDisabledBitmap() const { return m_bmpDisabled; }

 
     const wxBitmap& GetBitmap() const
 
     const wxBitmap& GetBitmap() const

-        { return IsToggled() ? m_bitmap2 : m_bitmap1; }
+        { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
+
+    wxString GetLabel() const { return m_label; }

 
     wxString GetShortHelp() const { return m_shortHelpString; }
     wxString GetLongHelp() const { return m_longHelpString; }
 
     wxString GetShortHelp() const { return m_shortHelpString; }
     wxString GetLongHelp() const { return m_longHelpString; }


@@ -159,8 +175,10 @@ public:
 
     void Toggle() { Toggle(!IsToggled()); }
 
 
     void Toggle() { Toggle(!IsToggled()); }
 

-    void SetBitmap1(const wxBitmap& bmp) { m_bitmap1 = bmp; }
-    void SetBitmap2(const wxBitmap& bmp) { m_bitmap2 = bmp; }
+    void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; }
+    void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; }
+
+    virtual void SetLabel(const wxString& label) { m_label = label; }

 
     void SetClientData(wxObject *clientData)
     {
 
     void SetClientData(wxObject *clientData)
     {


@@ -178,11 +196,22 @@ public:
     virtual void Detach() { m_tbar = (wxToolBarBase *)NULL; }
     virtual void Attach(wxToolBarBase *tbar) { m_tbar = tbar; }
 
     virtual void Detach() { m_tbar = (wxToolBarBase *)NULL; }
     virtual void Attach(wxToolBarBase *tbar) { m_tbar = tbar; }
 

+    // compatibility only, don't use
+#if WXWIN_COMPATIBILITY_2_2
+    const wxBitmap& GetBitmap1() const { return GetNormalBitmap(); }
+    const wxBitmap& GetBitmap2() const { return GetDisabledBitmap(); }
+
+    void SetBitmap1(const wxBitmap& bmp) { SetNormalBitmap(bmp); }
+    void SetBitmap2(const wxBitmap& bmp) { SetDisabledBitmap(bmp); }
+#endif // WXWIN_COMPATIBILITY_2_2
+

 protected:
     wxToolBarBase *m_tbar;  // the toolbar to which we belong (may be NULL)
 
 protected:
     wxToolBarBase *m_tbar;  // the toolbar to which we belong (may be NULL)
 

-    int m_toolStyle; // see enum wxToolBarToolStyle
-    int m_id;        // the tool id, wxID_SEPARATOR for separator
+    // tool parameters
+    int m_toolStyle;    // see enum wxToolBarToolStyle
+    int m_id;           // the tool id, wxID_SEPARATOR for separator
+    wxItemKind m_kind;  // for normal buttons may be wxITEM_NORMAL/CHECK/RADIO

 
     // as controls have their own client data, no need to waste memory
     union
 
     // as controls have their own client data, no need to waste memory
     union


@@ -193,12 +222,14 @@ protected:
 
     // tool state
     bool m_toggled;
 
     // tool state
     bool m_toggled;

-    bool m_isToggle;

     bool m_enabled;
 
     bool m_enabled;
 

-    // normal and toggles bitmaps
-    wxBitmap m_bitmap1;
-    wxBitmap m_bitmap2;
+    // normal and disabled bitmaps for the tool, both can be invalid
+    wxBitmap m_bmpNormal;
+    wxBitmap m_bmpDisabled;
+
+    // the button label
+    wxString m_label;

 
     // short and long help strings
     wxString m_shortHelpString;
 
     // short and long help strings
     wxString m_shortHelpString;


@@ -206,7 +237,7 @@ protected:
 };
 
 // a list of toolbar tools
 };
 
 // a list of toolbar tools

-WX_DECLARE_LIST(wxToolBarToolBase, wxToolBarToolsList);
+WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase, wxToolBarToolsList);

 
 // ----------------------------------------------------------------------------
 // the base class for all toolbars
 
 // ----------------------------------------------------------------------------
 // the base class for all toolbars


@@ -221,34 +252,60 @@ public:
     // toolbar construction
     // --------------------
 
     // toolbar construction
     // --------------------
 

-    // If pushedBitmap is NULL, a reversed version of bitmap is created and
-    // used as the pushed/toggled image. If toggle is TRUE, the button toggles
-    // between the two states.
+    // the full AddTool() function
+    //
+    // If bmpDisabled is wxNullBitmap, a shadowed version of the normal bitmap
+    // is created and used as the disabled image.

     wxToolBarToolBase *AddTool(int id,
     wxToolBarToolBase *AddTool(int id,

+                               const wxString& label,

                                const wxBitmap& bitmap,
                                const wxBitmap& bitmap,

-                               const wxBitmap& pushedBitmap = wxNullBitmap,
-                               bool toggle = FALSE,
-                               wxObject *clientData = NULL,
-                               const wxString& shortHelpString = wxEmptyString,
-                               const wxString& longHelpString = wxEmptyString)
+                               const wxBitmap& bmpDisabled,
+                               wxItemKind kind = wxITEM_NORMAL,
+                               const wxString& shortHelp = wxEmptyString,
+                               const wxString& longHelp = wxEmptyString,
+                               wxObject *data = NULL)

     {
     {

-        return AddTool(id, bitmap, pushedBitmap, toggle,
-                       -1, -1, clientData, shortHelpString, longHelpString);
+        return DoAddTool(id, label, bitmap, bmpDisabled, kind,
+                         shortHelp, longHelp, data);
+    }
+
+    // the most common AddTool() version
+    wxToolBarToolBase *AddTool(int id,
+                               const wxString& label,
+                               const wxBitmap& bitmap,
+                               const wxString& shortHelp = wxEmptyString,
+                               wxItemKind kind = wxITEM_NORMAL)
+    {
+        return AddTool(id, label, bitmap, wxNullBitmap, kind, shortHelp);
+    }
+
+    // add a check tool, i.e. a tool which can be toggled
+    wxToolBarToolBase *AddCheckTool(int id,
+                                    const wxString& label,
+                                    const wxBitmap& bitmap,
+                                    const wxBitmap& bmpDisabled = wxNullBitmap,
+                                    const wxString& shortHelp = wxEmptyString,
+                                    const wxString& longHelp = wxEmptyString,
+                                    wxObject *data = NULL)
+    {
+        return AddTool(id, label, bitmap, bmpDisabled, wxITEM_CHECK,
+                       shortHelp, longHelp, data);
+    }
+
+    // add a radio tool, i.e. a tool which can be toggled and releases any
+    // other toggled radio tools in the same group when it happens
+    wxToolBarToolBase *AddRadioTool(int id,
+                                    const wxString& label,
+                                    const wxBitmap& bitmap,
+                                    const wxBitmap& bmpDisabled = wxNullBitmap,
+                                    const wxString& shortHelp = wxEmptyString,
+                                    const wxString& longHelp = wxEmptyString,
+                                    wxObject *data = NULL)
+    {
+        return AddTool(id, label, bitmap, bmpDisabled, wxITEM_RADIO,
+                       shortHelp, longHelp, data);

     }
 
     }
 

-    // the old version of AddTool() kept for compatibility
-    virtual wxToolBarToolBase *AddTool
-                               (
-                                   int id,
-                                   const wxBitmap& bitmap,
-                                   const wxBitmap& pushedBitmap,
-                                   bool toggle,
-                                   wxCoord xPos,
-                                   wxCoord yPos = -1,
-                                   wxObject *clientData = NULL,
-                                   const wxString& helpString1 = wxEmptyString,
-                                   const wxString& helpString2 = wxEmptyString
-                               );

 
     // insert the new tool at the given position, if pos == GetToolsCount(), it
     // is equivalent to AddTool()
 
     // insert the new tool at the given position, if pos == GetToolsCount(), it
     // is equivalent to AddTool()


@@ -256,12 +313,13 @@ public:
                                (
                                     size_t pos,
                                     int id,
                                (
                                     size_t pos,
                                     int id,

+                                    const wxString& label,

                                     const wxBitmap& bitmap,
                                     const wxBitmap& bitmap,

-                                    const wxBitmap& pushedBitmap = wxNullBitmap,
-                                    bool toggle = FALSE,
-                                    wxObject *clientData = NULL,
-                                    const wxString& help1 = wxEmptyString,
-                                    const wxString& help2 = wxEmptyString
+                                    const wxBitmap& bmpDisabled = wxNullBitmap,
+                                    wxItemKind kind = wxITEM_NORMAL,
+                                    const wxString& shortHelp = wxEmptyString,
+                                    const wxString& longHelp = wxEmptyString,
+                                    wxObject *clientData = NULL

                                );
 
     // add an arbitrary control to the toolbar, return TRUE if ok (notice that
                                );
 
     // add an arbitrary control to the toolbar, return TRUE if ok (notice that


@@ -325,9 +383,9 @@ public:
     virtual void SetToolSeparation(int separation)
         { m_toolSeparation = separation; }
 
     virtual void SetToolSeparation(int separation)
         { m_toolSeparation = separation; }
 

-    virtual wxSize GetToolMargins() { return wxSize(m_xMargin, m_yMargin); }
-    virtual int GetToolPacking() { return m_toolPacking; }
-    virtual int GetToolSeparation() { return m_toolSeparation; }
+    virtual wxSize GetToolMargins() const { return wxSize(m_xMargin, m_yMargin); }
+    virtual int GetToolPacking() const { return m_toolPacking; }
+    virtual int GetToolSeparation() const { return m_toolSeparation; }

 
     // toolbar geometry
     // ----------------
 
     // toolbar geometry
     // ----------------


@@ -358,6 +416,67 @@ public:
     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x,
                                                    wxCoord y) const = 0;
 
     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x,
                                                    wxCoord y) const = 0;
 

+    // return TRUE if this is a vertical toolbar, otherwise FALSE
+    bool IsVertical() const { return HasFlag(wxTB_VERTICAL); }
+
+
+    // the old versions of the various methods kept for compatibility
+    // don't use in the new code!
+    // --------------------------------------------------------------
+
+    wxToolBarToolBase *AddTool(int id,
+                               const wxBitmap& bitmap,
+                               const wxBitmap& bmpDisabled,
+                               bool toggle = FALSE,
+                               wxObject *clientData = NULL,
+                               const wxString& shortHelpString = wxEmptyString,
+                               const wxString& longHelpString = wxEmptyString)
+    {
+        return AddTool(id, wxEmptyString,
+                       bitmap, bmpDisabled,
+                       toggle ? wxITEM_CHECK : wxITEM_NORMAL,
+                       shortHelpString, longHelpString, clientData);
+    }
+
+    wxToolBarToolBase *AddTool(int id,
+                               const wxBitmap& bitmap,
+                               const wxString& shortHelpString = wxEmptyString,
+                               const wxString& longHelpString = wxEmptyString)
+    {
+        return AddTool(id, wxEmptyString,
+                       bitmap, wxNullBitmap, wxITEM_NORMAL,
+                       shortHelpString, longHelpString, NULL);
+    }
+
+    wxToolBarToolBase *AddTool(int id,
+                               const wxBitmap& bitmap,
+                               const wxBitmap& bmpDisabled,
+                               bool toggle,
+                               wxCoord xPos,
+                               wxCoord yPos = -1,
+                               wxObject *clientData = NULL,
+                               const wxString& shortHelp = wxEmptyString,
+                               const wxString& longHelp = wxEmptyString)
+    {
+        return DoAddTool(id, wxEmptyString, bitmap, bmpDisabled,
+                         toggle ? wxITEM_CHECK : wxITEM_NORMAL,
+                         shortHelp, longHelp, clientData, xPos, yPos);
+    }
+
+    wxToolBarToolBase *InsertTool(size_t pos,
+                                  int id,
+                                  const wxBitmap& bitmap,
+                                  const wxBitmap& bmpDisabled = wxNullBitmap,
+                                  bool toggle = FALSE,
+                                  wxObject *clientData = NULL,
+                                  const wxString& shortHelp = wxEmptyString,
+                                  const wxString& longHelp = wxEmptyString)
+    {
+        return InsertTool(pos, id, wxEmptyString, bitmap, bmpDisabled,
+                          toggle ? wxITEM_CHECK : wxITEM_NORMAL,
+                          shortHelp, longHelp, clientData);
+    }
+

     // event handlers
     // --------------
 
     // event handlers
     // --------------
 


@@ -387,6 +506,9 @@ public:
     virtual wxSize GetDefaultButtonSize() const { return GetToolSize(); }
 #endif // WXWIN_COMPATIBILITY
 
     virtual wxSize GetDefaultButtonSize() const { return GetToolSize(); }
 #endif // WXWIN_COMPATIBILITY
 

+    // use GetToolMargins() instead
+    wxSize GetMargins() const { return GetToolMargins(); }
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -397,10 +519,29 @@ public:
     // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
     virtual void DoToolbarUpdates();
 
     // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
     virtual void DoToolbarUpdates();
 

+    // don't want toolbars to accept the focus
+    virtual bool AcceptsFocus() const { return FALSE; }
+

 protected:
     // to implement in derived classes
     // -------------------------------
 
 protected:
     // to implement in derived classes
     // -------------------------------
 

+    // create a new toolbar tool and add it to the toolbar, this is typically
+    // implemented by just calling InsertTool()
+    virtual wxToolBarToolBase *DoAddTool
+                               (
+                                   int id,
+                                   const wxString& label,
+                                   const wxBitmap& bitmap,
+                                   const wxBitmap& bmpDisabled,
+                                   wxItemKind kind,
+                                   const wxString& shortHelp = wxEmptyString,
+                                   const wxString& longHelp = wxEmptyString,
+                                   wxObject *clientData = NULL,
+                                   wxCoord xPos = -1,
+                                   wxCoord yPos = -1
+                               );
+

     // the tool is not yet inserted into m_tools list when this function is
     // called and will only be added to it if this function succeeds
     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool) = 0;
     // the tool is not yet inserted into m_tools list when this function is
     // called and will only be added to it if this function succeeds
     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool) = 0;


@@ -420,12 +561,14 @@ protected:
 
     // the functions to create toolbar tools
     virtual wxToolBarToolBase *CreateTool(int id,
 
     // the functions to create toolbar tools
     virtual wxToolBarToolBase *CreateTool(int id,

-                                          const wxBitmap& bitmap1,
-                                          const wxBitmap& bitmap2,
-                                          bool toggle,
+                                          const wxString& label,
+                                          const wxBitmap& bmpNormal,
+                                          const wxBitmap& bmpDisabled,
+                                          wxItemKind kind,

                                           wxObject *clientData,
                                           wxObject *clientData,

-                                          const wxString& shortHelpString,
-                                          const wxString& longHelpString) = 0;
+                                          const wxString& shortHelp,
+                                          const wxString& longHelp) = 0;
+

     virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0;
 
     // helper functions
     virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0;
 
     // helper functions


@@ -454,8 +597,14 @@ protected:
 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()

+    DECLARE_CLASS(wxToolBarBase)

 };
 
 };
 

+// Helper function for creating the image for disabled buttons
+bool wxCreateGreyedImage(const wxImage& in, wxImage& out) ;
+
+#endif // wxUSE_TOOLBAR
+

 #endif
     // _WX_TBARBASE_H_
 
 #endif
     // _WX_TBARBASE_H_