add wxUSE_EDITABLELISTBOX

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

diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h
index 076620e4471c768eb6e3380d9d8507ad61e0c117..96920150b99c5cd2cf8687b4ab28eb9326bd75ce 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


@@ -36,9 +32,9 @@ class WXDLLEXPORT wxImage;
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

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

 
 enum wxToolBarToolStyle
 {
 
 enum wxToolBarToolStyle
 {


@@ -50,7 +46,7 @@ enum wxToolBarToolStyle
 // ----------------------------------------------------------------------------
 // wxToolBarTool is a toolbar element.
 //
 // ----------------------------------------------------------------------------
 // wxToolBarTool is a toolbar element.
 //

-// It has a unique id (except for the separators which always have id -1), the
+// It has a unique id (except for the separators which always have id wxID_ANY), the

 // style (telling whether it is a normal button, separator or a control), the
 // state (toggled or not, enabled or not) and short and long help strings. The
 // default implementations use the short help string for the tooltip text which
 // style (telling whether it is a normal button, separator or a control), the
 // state (toggled or not, enabled or not) and short and long help strings. The
 // default implementations use the short help string for the tooltip text which


@@ -75,10 +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;
     {
         m_tbar = tbar;
         m_id = toolid;

+        if (m_id == wxID_ANY)
+            m_id = wxNewId();

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


@@ -86,14 +85,17 @@ public:
 
         m_kind = kind;
 
 
         m_kind = kind;
 

-        m_enabled = TRUE;
-        m_toggled = FALSE;
+        m_enabled = true;
+        m_toggled = false;

 
         m_toolStyle = toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR
                                            : wxTOOL_STYLE_BUTTON;
     }
 
 
         m_toolStyle = toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR
                                            : 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;


@@ -101,13 +103,15 @@ public:
 
         m_kind = wxITEM_MAX;    // invalid value
 
 
         m_kind = wxITEM_MAX;    // invalid value
 

-        m_enabled = TRUE;
-        m_toggled = FALSE;
+        m_enabled = true;
+        m_toggled = false;

 
         m_toolStyle = wxTOOL_STYLE_CONTROL;
 
         m_toolStyle = wxTOOL_STYLE_CONTROL;

+
+        m_dropdownMenu = 0;

     }
 
     }
 

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

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


@@ -149,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
     {


@@ -166,7 +170,7 @@ 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 Enable(bool enable);
     bool Toggle(bool toggle);
     bool SetToggle(bool toggle);


@@ -196,14 +200,10 @@ 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)
+    void SetDropdownMenu(wxMenu *menu);
+    wxMenu *GetDropdownMenu() const { return m_dropdownMenu; }

 
 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)


@@ -235,7 +235,9 @@ protected:
     wxString m_shortHelpString;
     wxString m_longHelpString;
 
     wxString m_shortHelpString;
     wxString m_longHelpString;
 

-    DECLARE_NO_COPY_CLASS(wxToolBarToolBase)
+    wxMenu *m_dropdownMenu;
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)

 };
 
 // a list of toolbar tools
 };
 
 // a list of toolbar tools


@@ -327,14 +329,18 @@ 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, return TRUE if ok (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 );
 


@@ -373,7 +379,7 @@ public:
     // returns tool pos, or wxNOT_FOUND if tool isn't found
     virtual int GetToolPos(int id) const;
 
     // returns tool pos, or wxNOT_FOUND if tool isn't found
     virtual int GetToolPos(int id) const;
 

-    // return TRUE if the tool is toggled
+    // return true if the tool is toggled

     virtual bool GetToolState(int toolid) const;
 
     virtual bool GetToolEnabled(int toolid) const;
     virtual bool GetToolState(int toolid) const;
 
     virtual bool GetToolEnabled(int toolid) const;


@@ -383,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
     // --------------------------
 


@@ -413,22 +425,25 @@ 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)
     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x,
                                                    wxCoord y) const = 0;
 
 
     // returns a (non separator) tool containing the point (x, y) or NULL if
     // there is no tool at this point (corrdinates are client)
     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); }
+    // find the tool by id
+    wxToolBarToolBase *FindById(int toolid) const;
+
+    // return true if this is a vertical toolbar, otherwise false
+    bool IsVertical() const { return HasFlag(wxTB_LEFT | wxTB_RIGHT); }

 
 
     // the old versions of the various methods kept for compatibility
 
 
     // the old versions of the various methods kept for compatibility


@@ -438,7 +453,7 @@ public:
     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,
     wxToolBarToolBase *AddTool(int toolid,
                                const wxBitmap& bitmap,
                                const wxBitmap& bmpDisabled,

-                               bool toggle = FALSE,
+                               bool toggle = false,

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


@@ -464,7 +479,7 @@ public:
                                const wxBitmap& bmpDisabled,
                                bool toggle,
                                wxCoord xPos,
                                const wxBitmap& bmpDisabled,
                                bool toggle,
                                wxCoord xPos,

-                               wxCoord yPos = -1,
+                               wxCoord yPos = wxDefaultCoord,

                                wxObject *clientData = NULL,
                                const wxString& shortHelp = wxEmptyString,
                                const wxString& longHelp = wxEmptyString)
                                wxObject *clientData = NULL,
                                const wxString& shortHelp = wxEmptyString,
                                const wxString& longHelp = wxEmptyString)


@@ -478,7 +493,7 @@ public:
                                   int toolid,
                                   const wxBitmap& bitmap,
                                   const wxBitmap& bmpDisabled = wxNullBitmap,
                                   int toolid,
                                   const wxBitmap& bitmap,
                                   const wxBitmap& bmpDisabled = wxNullBitmap,

-                                  bool toggle = FALSE,
+                                  bool toggle = false,

                                   wxObject *clientData = NULL,
                                   const wxString& shortHelp = wxEmptyString,
                                   const wxString& longHelp = wxEmptyString)
                                   wxObject *clientData = NULL,
                                   const wxString& shortHelp = wxEmptyString,
                                   const wxString& longHelp = wxEmptyString)


@@ -493,14 +508,14 @@ public:
 
     // NB: these functions are deprecated, use EVT_TOOL_XXX() instead!
 
 
     // NB: these functions are deprecated, use EVT_TOOL_XXX() instead!
 

-    // Only allow toggle if returns TRUE. Call when left button up.
+    // Only allow toggle if returns true. Call when left button up.

     virtual bool OnLeftClick(int toolid, bool toggleDown);
 
     // Call when right button down.
     virtual void OnRightClick(int toolid, long x, long y);
 
     // Called when the mouse cursor enters a tool bitmap.
     virtual bool OnLeftClick(int toolid, bool toggleDown);
 
     // Call when right button down.
     virtual void OnRightClick(int toolid, long x, long y);
 
     // Called when the mouse cursor enters a tool bitmap.

-    // Argument is -1 if mouse is exiting the toolbar.
+    // Argument is wxID_ANY if mouse is exiting the toolbar.

     virtual void OnMouseEnter(int toolid);
 
     // more deprecated functions
     virtual void OnMouseEnter(int toolid);
 
     // more deprecated functions


@@ -518,7 +533,10 @@ public:
     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE) ;
 
     // don't want toolbars to accept the focus
     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE) ;
 
     // don't want toolbars to accept the focus

-    virtual bool AcceptsFocus() const { return FALSE; }
+    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


@@ -536,8 +554,8 @@ protected:
                                    const wxString& shortHelp = wxEmptyString,
                                    const wxString& longHelp = wxEmptyString,
                                    wxObject *clientData = NULL,
                                    const wxString& shortHelp = wxEmptyString,
                                    const wxString& longHelp = wxEmptyString,
                                    wxObject *clientData = NULL,

-                                   wxCoord xPos = -1,
-                                   wxCoord yPos = -1
+                                   wxCoord xPos = wxDefaultCoord,
+                                   wxCoord yPos = wxDefaultCoord

                                );
 
     // the tool is not yet inserted into m_tools list when this function is
                                );
 
     // the tool is not yet inserted into m_tools list when this function is


@@ -567,13 +585,21 @@ 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
     // ----------------
 

-    // find the tool by id
-    wxToolBarToolBase *FindById(int toolid) const;
+    // 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);

 
     // the list of all our tools
     wxToolBarToolsList m_tools;
 
     // the list of all our tools
     wxToolBarToolsList m_tools;


@@ -598,8 +624,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