clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h
index 20883df2cd43789a374b6e35c95d95fc08474513..604785aeeffa6fe56f613c76d3b17d4be8fea61b 100644 (file)
--- a/include/wx/tbarbase.h
+++ b/include/wx/tbarbase.h
@@ -16,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "tbarbase.h"
 #endif
 
     #pragma interface "tbarbase.h"
 #endif
 


@@ -50,7 +50,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


@@ -79,6 +79,8 @@ public:
     {
         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,8 +88,8 @@ 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;


@@ -101,13 +103,13 @@ 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;
     }
 

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

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


@@ -166,7 +168,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);


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

-    DECLARE_NO_COPY_CLASS(wxToolBarToolBase)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)

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


@@ -327,14 +329,14 @@ 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
+    // 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)
     //
     // NB: the control should have toolbar as its parent
     virtual wxToolBarToolBase *AddControl(wxControl *control);
     virtual wxToolBarToolBase *InsertControl(size_t pos, wxControl *control);
     // the control will be deleted by the toolbar and that it will also adjust
     // its position/size)
     //
     // NB: the control should have toolbar as its parent
     virtual wxToolBarToolBase *AddControl(wxControl *control);
     virtual wxToolBarToolBase *InsertControl(size_t pos, wxControl *control);

-    
+

     // 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 );
 


@@ -370,7 +372,10 @@ public:
     virtual wxObject *GetToolClientData(int toolid) const;
     virtual void SetToolClientData(int toolid, wxObject *clientData);
 
     virtual wxObject *GetToolClientData(int toolid) const;
     virtual void SetToolClientData(int toolid, wxObject *clientData);
 

-    // return TRUE if the tool is toggled
+    // returns tool pos, or wxNOT_FOUND if tool isn't found
+    virtual int GetToolPos(int id) const;
+
+    // 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;


@@ -424,7 +429,10 @@ 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
+    // 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_VERTICAL); }
 
 
     bool IsVertical() const { return HasFlag(wxTB_VERTICAL); }
 
 


@@ -435,7 +443,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)


@@ -461,7 +469,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)


@@ -475,7 +483,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)


@@ -490,30 +498,19 @@ 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
     // -------------------------
 

-#if WXWIN_COMPATIBILITY
-    void SetDefaultSize(int w, int h) { SetDefaultSize(wxSize(w, h)); }
-    long GetDefaultWidth() const { return m_defaultWidth; }
-    long GetDefaultHeight() const { return m_defaultHeight; }
-    int GetDefaultButtonWidth() const { return (int) GetDefaultButtonSize().x; };
-    int GetDefaultButtonHeight() const { return (int) GetDefaultButtonSize().y; };
-    virtual void SetDefaultSize(const wxSize& size) { SetToolBitmapSize(size); }
-    virtual wxSize GetDefaultSize() const { return GetToolBitmapSize(); }
-    virtual wxSize GetDefaultButtonSize() const { return GetToolSize(); }
-#endif // WXWIN_COMPATIBILITY
-

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


@@ -522,13 +519,11 @@ public:
 
     size_t GetToolsCount() const { return m_tools.GetCount(); }
 
 
     size_t GetToolsCount() const { return m_tools.GetCount(); }
 

-    void OnIdle(wxIdleEvent& event);
-

     // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
     // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)

-    virtual void DoToolbarUpdates();
+    virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE) ;

 
     // don't want toolbars to accept the focus
 
     // don't want toolbars to accept the focus

-    virtual bool AcceptsFocus() const { return FALSE; }
+    virtual bool AcceptsFocus() const { return false; }

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


@@ -546,8 +541,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


@@ -582,8 +577,8 @@ protected:
     // helper functions
     // ----------------
 
     // helper functions
     // ----------------
 

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


@@ -605,7 +600,7 @@ protected:
 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()

-    DECLARE_CLASS(wxToolBarBase)
+    DECLARE_NO_COPY_CLASS(wxToolBarBase)

 };
 
 // Helper function for creating the image for disabled buttons
 };
 
 // Helper function for creating the image for disabled buttons