Initial commit for Laurent Humbertclaude's Windows slave.

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

diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h
index 604785aeeffa6fe56f613c76d3b17d4be8fea61b..b0be7b0e7b569766eb08b72de7c6f3fa2684477e 100644 (file)
--- a/include/wx/tbarbase.h
+++ b/include/wx/tbarbase.h
@@ -16,10 +16,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "tbarbase.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_TOOLBAR
 #include "wx/defs.h"
 
 #if wxUSE_TOOLBAR


@@ -28,17 +24,17 @@
 #include "wx/list.h"
 #include "wx/control.h"
 
 #include "wx/list.h"
 #include "wx/control.h"
 

-class WXDLLEXPORT wxToolBarBase;
-class WXDLLEXPORT wxToolBarToolBase;
-class WXDLLEXPORT wxImage;
+class WXDLLIMPEXP_FWD_CORE wxToolBarBase;
+class WXDLLIMPEXP_FWD_CORE wxToolBarToolBase;
+class WXDLLIMPEXP_FWD_CORE wxImage;

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

-WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
-WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
-WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxToolBarNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const wxSize) wxDefaultSize;
+extern WXDLLIMPEXP_DATA_CORE(const wxPoint) wxDefaultPosition;

 
 enum wxToolBarToolStyle
 {
 
 enum wxToolBarToolStyle
 {


@@ -58,7 +54,7 @@ enum wxToolBarToolStyle
 // for the applications status bar.
 // ----------------------------------------------------------------------------
 
 // for the applications status bar.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxToolBarToolBase : public wxObject
+class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject

 {
 public:
     // ctors & dtor
 {
 public:
     // ctors & dtor


@@ -75,12 +71,13 @@ public:
                       const wxString& longHelpString = wxEmptyString)
         : m_label(label),
           m_shortHelpString(shortHelpString),
                       const wxString& longHelpString = wxEmptyString)
         : m_label(label),
           m_shortHelpString(shortHelpString),

-          m_longHelpString(longHelpString)
+          m_longHelpString(longHelpString),
+          m_dropdownMenu(NULL)

     {
         m_tbar = tbar;
         m_id = toolid;
         if (m_id == wxID_ANY)
     {
         m_tbar = tbar;
         m_id = toolid;
         if (m_id == wxID_ANY)

-            m_id = wxNewId();
+            m_id = wxWindow::NewControlId();

         m_clientData = clientData;
 
         m_bmpNormal = bmpNormal;
         m_clientData = clientData;
 
         m_bmpNormal = bmpNormal;


@@ -95,7 +92,10 @@ public:
                                            : wxTOOL_STYLE_BUTTON;
     }
 
                                            : wxTOOL_STYLE_BUTTON;
     }
 

-    wxToolBarToolBase(wxToolBarBase *tbar, wxControl *control)
+    wxToolBarToolBase(wxToolBarBase *tbar,
+                      wxControl *control,
+                      const wxString& label)
+        : m_label(label)

     {
         m_tbar = tbar;
         m_control = control;
     {
         m_tbar = tbar;
         m_control = control;


@@ -107,9 +107,11 @@ public:
         m_toggled = false;
 
         m_toolStyle = wxTOOL_STYLE_CONTROL;
         m_toggled = false;
 
         m_toolStyle = wxTOOL_STYLE_CONTROL;

+
+        m_dropdownMenu = 0;

     }
 
     }
 

-    ~wxToolBarToolBase(){}
+    virtual ~wxToolBarToolBase();

 
     // accessors
     // ---------
 
     // accessors
     // ---------


@@ -151,10 +153,10 @@ public:
     const wxBitmap& GetBitmap() const
         { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
 
     const wxBitmap& GetBitmap() const
         { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
 

-    wxString GetLabel() const { return m_label; }
+    const wxString& GetLabel() const { return m_label; }

 
 

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

 
     wxObject *GetClientData() const
     {
 
     wxObject *GetClientData() const
     {


@@ -169,16 +171,16 @@ public:
     }
 
     // modifiers: return true if the state really changed
     }
 
     // modifiers: return true if the state really changed

-    bool Enable(bool enable);
-    bool Toggle(bool toggle);
-    bool SetToggle(bool toggle);
-    bool SetShortHelp(const wxString& help);
-    bool SetLongHelp(const wxString& help);
+    virtual bool Enable(bool enable);
+    virtual bool Toggle(bool toggle);
+    virtual bool SetToggle(bool toggle);
+    virtual bool SetShortHelp(const wxString& help);
+    virtual bool SetLongHelp(const wxString& help);

 
     void Toggle() { Toggle(!IsToggled()); }
 
 
     void Toggle() { Toggle(!IsToggled()); }
 

-    void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; }
-    void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; }
+    virtual void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; }
+    virtual void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; }

 
     virtual void SetLabel(const wxString& label) { m_label = label; }
 
 
     virtual void SetLabel(const wxString& label) { m_label = label; }
 


@@ -198,21 +200,17 @@ 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
+    // these methods are only for tools of wxITEM_DROPDOWN kind (but even such
+    // tools can have a NULL associated menu)
+    virtual void SetDropdownMenu(wxMenu *menu);
+    wxMenu *GetDropdownMenu() const { return m_dropdownMenu; }

 
 protected:
     wxToolBarBase *m_tbar;  // the toolbar to which we belong (may be NULL)
 
     // tool parameters
     int m_toolStyle;    // see enum wxToolBarToolStyle
 
 protected:
     wxToolBarBase *m_tbar;  // the toolbar to which we belong (may be NULL)
 
     // tool parameters
     int m_toolStyle;    // see enum wxToolBarToolStyle

-    int m_id;           // the tool id, wxID_SEPARATOR for separator
+    wxWindowIDRef 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
     wxItemKind m_kind;  // for normal buttons may be wxITEM_NORMAL/CHECK/RADIO
 
     // as controls have their own client data, no need to waste memory


@@ -237,6 +235,8 @@ protected:
     wxString m_shortHelpString;
     wxString m_longHelpString;
 
     wxString m_shortHelpString;
     wxString m_longHelpString;
 

+    wxMenu *m_dropdownMenu;
+

     DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)
 };
 


@@ -247,7 +247,7 @@ WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase, wxToolBarToolsList);
 // the base class for all toolbars
 // ----------------------------------------------------------------------------
 
 // the base class for all toolbars
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxToolBarBase : public wxControl
+class WXDLLIMPEXP_CORE wxToolBarBase : public wxControl

 {
 public:
     wxToolBarBase();
 {
 public:
     wxToolBarBase();


@@ -329,13 +329,17 @@ public:
     virtual wxToolBarToolBase *AddTool (wxToolBarToolBase *tool);
     virtual wxToolBarToolBase *InsertTool (size_t pos, wxToolBarToolBase *tool);
 
     virtual wxToolBarToolBase *AddTool (wxToolBarToolBase *tool);
     virtual wxToolBarToolBase *InsertTool (size_t pos, wxToolBarToolBase *tool);
 

-    // add an arbitrary control to the toolbar (notice that
-    // the control will be deleted by the toolbar and that it will also adjust
-    // its position/size)
+    // add an arbitrary control to the toolbar (notice that the control will be
+    // deleted by the toolbar and that it will also adjust its position/size)

     //
     //

+    // the label is optional and, if specified, will be shown near the control

     // NB: the control should have toolbar as its parent
     // NB: the control should have toolbar as its parent

-    virtual wxToolBarToolBase *AddControl(wxControl *control);
-    virtual wxToolBarToolBase *InsertControl(size_t pos, wxControl *control);
+    virtual wxToolBarToolBase *
+    AddControl(wxControl *control, const wxString& label = wxEmptyString);
+
+    virtual wxToolBarToolBase *
+    InsertControl(size_t pos, wxControl *control,
+                  const wxString& label = wxEmptyString);

 
     // get the control with the given id or return NULL
     virtual wxControl *FindControl( int toolid );
 
     // get the control with the given id or return NULL
     virtual wxControl *FindControl( int toolid );


@@ -385,6 +389,12 @@ public:
     virtual void SetToolLongHelp(int toolid, const wxString& helpString);
     virtual wxString GetToolLongHelp(int toolid) const;
 
     virtual void SetToolLongHelp(int toolid, const wxString& helpString);
     virtual wxString GetToolLongHelp(int toolid) const;
 

+    virtual void SetToolNormalBitmap(int WXUNUSED(id),
+                                     const wxBitmap& WXUNUSED(bitmap)) {}
+    virtual void SetToolDisabledBitmap(int WXUNUSED(id),
+                                       const wxBitmap& WXUNUSED(bitmap)) {}
+
+

     // margins/packing/separation
     // --------------------------
 
     // margins/packing/separation
     // --------------------------
 


@@ -415,14 +425,14 @@ public:
     // get/set the size of the bitmaps used by the toolbar: should be called
     // before adding any tools to the toolbar
     virtual void SetToolBitmapSize(const wxSize& size)
     // get/set the size of the bitmaps used by the toolbar: should be called
     // before adding any tools to the toolbar
     virtual void SetToolBitmapSize(const wxSize& size)

-        { m_defaultWidth = size.x; m_defaultHeight = size.y; };
+        { m_defaultWidth = size.x; m_defaultHeight = size.y; }

     virtual wxSize GetToolBitmapSize() const
         { return wxSize(m_defaultWidth, m_defaultHeight); }
 
     // the button size in some implementations is bigger than the bitmap size:
     // get the total button size (by default the same as bitmap size)
     virtual wxSize GetToolSize() const
     virtual wxSize GetToolBitmapSize() const
         { return wxSize(m_defaultWidth, m_defaultHeight); }
 
     // the button size in some implementations is bigger than the bitmap size:
     // get the total button size (by default the same as bitmap size)
     virtual wxSize GetToolSize() const

-        { return GetToolBitmapSize(); } ;
+        { return GetToolBitmapSize(); }

 
     // returns a (non separator) tool containing the point (x, y) or NULL if
     // there is no tool at this point (corrdinates are client)
 
     // returns a (non separator) tool containing the point (x, y) or NULL if
     // there is no tool at this point (corrdinates are client)


@@ -433,13 +443,13 @@ public:
     wxToolBarToolBase *FindById(int toolid) const;
 
     // return true if this is a vertical toolbar, otherwise false
     wxToolBarToolBase *FindById(int toolid) const;
 
     // return true if this is a vertical toolbar, otherwise false

-    bool IsVertical() const { return HasFlag(wxTB_VERTICAL); }
-
+    bool IsVertical() const;

 
 

+#if WXWIN_COMPATIBILITY_2_8

     // the old versions of the various methods kept for compatibility
     // don't use in the new code!
     // --------------------------------------------------------------
     // the old versions of the various methods kept for compatibility
     // don't use in the new code!
     // --------------------------------------------------------------

-
+    wxDEPRECATED_INLINE(

     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,
     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,


@@ -447,23 +457,23 @@ public:
                                wxObject *clientData = NULL,
                                const wxString& shortHelpString = wxEmptyString,
                                const wxString& longHelpString = wxEmptyString)
                                wxObject *clientData = NULL,
                                const wxString& shortHelpString = wxEmptyString,
                                const wxString& longHelpString = wxEmptyString)

-    {
+    ,

         return AddTool(toolid, wxEmptyString,
                        bitmap, bmpDisabled,
                        toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                        shortHelpString, longHelpString, clientData);
         return AddTool(toolid, wxEmptyString,
                        bitmap, bmpDisabled,
                        toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                        shortHelpString, longHelpString, clientData);

-    }
-
+    )
+    wxDEPRECATED_INLINE(

     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxString& shortHelpString = wxEmptyString,
                                const wxString& longHelpString = wxEmptyString)
     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxString& shortHelpString = wxEmptyString,
                                const wxString& longHelpString = wxEmptyString)

-    {
+    ,

         return AddTool(toolid, wxEmptyString,
                        bitmap, wxNullBitmap, wxITEM_NORMAL,
                        shortHelpString, longHelpString, NULL);
         return AddTool(toolid, wxEmptyString,
                        bitmap, wxNullBitmap, wxITEM_NORMAL,
                        shortHelpString, longHelpString, NULL);

-    }
-
+    )
+    wxDEPRECATED_INLINE(

     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,
     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,


@@ -473,12 +483,12 @@ public:
                                wxObject *clientData = NULL,
                                const wxString& shortHelp = wxEmptyString,
                                const wxString& longHelp = wxEmptyString)
                                wxObject *clientData = NULL,
                                const wxString& shortHelp = wxEmptyString,
                                const wxString& longHelp = wxEmptyString)

-    {
+    ,

         return DoAddTool(toolid, wxEmptyString, bitmap, bmpDisabled,
                          toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                          shortHelp, longHelp, clientData, xPos, yPos);
         return DoAddTool(toolid, wxEmptyString, bitmap, bmpDisabled,
                          toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                          shortHelp, longHelp, clientData, xPos, yPos);

-    }
-
+    )
+    wxDEPRECATED_INLINE(

     wxToolBarToolBase *InsertTool(size_t pos,
                                   int toolid,
                                   const wxBitmap& bitmap,
     wxToolBarToolBase *InsertTool(size_t pos,
                                   int toolid,
                                   const wxBitmap& bitmap,


@@ -487,11 +497,12 @@ public:
                                   wxObject *clientData = NULL,
                                   const wxString& shortHelp = wxEmptyString,
                                   const wxString& longHelp = wxEmptyString)
                                   wxObject *clientData = NULL,
                                   const wxString& shortHelp = wxEmptyString,
                                   const wxString& longHelp = wxEmptyString)

-    {
+    ,

         return InsertTool(pos, toolid, wxEmptyString, bitmap, bmpDisabled,
                           toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                           shortHelp, longHelp, clientData);
         return InsertTool(pos, toolid, wxEmptyString, bitmap, bmpDisabled,
                           toggle ? wxITEM_CHECK : wxITEM_NORMAL,
                           shortHelp, longHelp, clientData);

-    }
+    )
+#endif // WXWIN_COMPATIBILITY_2_8

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


@@ -525,6 +536,9 @@ public:
     // don't want toolbars to accept the focus
     virtual bool AcceptsFocus() const { return false; }
 
     // don't want toolbars to accept the focus
     virtual bool AcceptsFocus() const { return false; }
 

+    // Set dropdown menu
+    bool SetDropdownMenu(int toolid, wxMenu *menu);
+

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


@@ -572,11 +586,19 @@ protected:
                                           const wxString& shortHelp,
                                           const wxString& longHelp) = 0;
 
                                           const wxString& shortHelp,
                                           const wxString& longHelp) = 0;
 

-    virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0;
+    virtual wxToolBarToolBase *CreateTool(wxControl *control,
+                                          const wxString& label) = 0;

 
     // helper functions
     // ----------------
 
 
     // helper functions
     // ----------------
 

+    // call this from derived class ctor/Create() to ensure that we have either
+    // wxTB_HORIZONTAL or wxTB_VERTICAL style, there is a lot of existing code
+    // which randomly checks either one or the other of them and gets confused
+    // if neither is set (and making one of them 0 is not an option neither as
+    // then the existing tests would break down)
+    void FixupStyle();
+

     // un-toggle all buttons in the same radio group
     void UnToggleRadioGroup(wxToolBarToolBase *tool);
 
     // un-toggle all buttons in the same radio group
     void UnToggleRadioGroup(wxToolBarToolBase *tool);
 


@@ -603,8 +625,14 @@ private:
     DECLARE_NO_COPY_CLASS(wxToolBarBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxToolBarBase)
 };
 

-// Helper function for creating the image for disabled buttons
-bool wxCreateGreyedImage(const wxImage& in, wxImage& out) ;
+// deprecated function for creating the image for disabled buttons, use
+// wxImage::ConvertToGreyscale() instead
+#if WXWIN_COMPATIBILITY_2_8
+
+wxDEPRECATED( bool wxCreateGreyedImage(const wxImage& in, wxImage& out) );
+
+#endif // WXWIN_COMPATIBILITY_2_8
+

 
 #endif // wxUSE_TOOLBAR
 
 
 #endif // wxUSE_TOOLBAR