X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dd91da4ed1e9d2ba5d3bc2fae64a8e4ea86b5d41..ef094fa075bc56bcbc33b12159c395ea28afda3b:/include/wx/tbarbase.h?ds=sidebyside diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h index 9e885dfab7..794859e215 100644 --- a/include/wx/tbarbase.h +++ b/include/wx/tbarbase.h @@ -5,7 +5,7 @@ // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -65,7 +65,7 @@ public: // ------------ wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL, - int id = wxID_SEPARATOR, + int toolid = wxID_SEPARATOR, const wxString& label = wxEmptyString, const wxBitmap& bmpNormal = wxNullBitmap, const wxBitmap& bmpDisabled = wxNullBitmap, @@ -78,7 +78,7 @@ public: m_longHelpString(longHelpString) { m_tbar = tbar; - m_id = id; + m_id = toolid; m_clientData = clientData; m_bmpNormal = bmpNormal; @@ -89,7 +89,7 @@ public: m_enabled = TRUE; m_toggled = FALSE; - m_toolStyle = id == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR + m_toolStyle = toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR : wxTOOL_STYLE_BUTTON; } @@ -258,7 +258,7 @@ public: // // 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 toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled, @@ -267,22 +267,22 @@ public: const wxString& longHelp = wxEmptyString, wxObject *data = NULL) { - return DoAddTool(id, label, bitmap, bmpDisabled, kind, + return DoAddTool(toolid, label, bitmap, bmpDisabled, kind, shortHelp, longHelp, data); } // the most common AddTool() version - wxToolBarToolBase *AddTool(int id, + wxToolBarToolBase *AddTool(int toolid, const wxString& label, const wxBitmap& bitmap, const wxString& shortHelp = wxEmptyString, wxItemKind kind = wxITEM_NORMAL) { - return AddTool(id, label, bitmap, wxNullBitmap, kind, shortHelp); + return AddTool(toolid, label, bitmap, wxNullBitmap, kind, shortHelp); } // add a check tool, i.e. a tool which can be toggled - wxToolBarToolBase *AddCheckTool(int id, + wxToolBarToolBase *AddCheckTool(int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled = wxNullBitmap, @@ -290,13 +290,13 @@ public: const wxString& longHelp = wxEmptyString, wxObject *data = NULL) { - return AddTool(id, label, bitmap, bmpDisabled, wxITEM_CHECK, + return AddTool(toolid, 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, + wxToolBarToolBase *AddRadioTool(int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled = wxNullBitmap, @@ -304,7 +304,7 @@ public: const wxString& longHelp = wxEmptyString, wxObject *data = NULL) { - return AddTool(id, label, bitmap, bmpDisabled, wxITEM_RADIO, + return AddTool(toolid, label, bitmap, bmpDisabled, wxITEM_RADIO, shortHelp, longHelp, data); } @@ -314,7 +314,7 @@ public: virtual wxToolBarToolBase *InsertTool ( size_t pos, - int id, + int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled = wxNullBitmap, @@ -336,7 +336,7 @@ public: virtual wxToolBarToolBase *InsertControl(size_t pos, wxControl *control); // get the control with the given id or return NULL - virtual wxControl *FindControl( int id ); + virtual wxControl *FindControl( int toolid ); // add a separator to the toolbar virtual wxToolBarToolBase *AddSeparator(); @@ -344,11 +344,11 @@ public: // remove the tool from the toolbar: the caller is responsible for actually // deleting the pointer - virtual wxToolBarToolBase *RemoveTool(int id); + virtual wxToolBarToolBase *RemoveTool(int toolid); // delete tool either by index or by position virtual bool DeleteToolByPos(size_t pos); - virtual bool DeleteTool(int id); + virtual bool DeleteTool(int toolid); // delete all tools virtual void ClearTools(); @@ -360,25 +360,28 @@ public: // tools state // ----------- - virtual void EnableTool(int id, bool enable); - virtual void ToggleTool(int id, bool toggle); + virtual void EnableTool(int toolid, bool enable); + virtual void ToggleTool(int toolid, bool toggle); // Set this to be togglable (or not) - virtual void SetToggle(int id, bool toggle); + virtual void SetToggle(int toolid, bool toggle); // set/get tools client data (not for controls) - virtual wxObject *GetToolClientData(int id) const; - virtual void SetToolClientData(int id, wxObject *clientData); + virtual wxObject *GetToolClientData(int toolid) const; + virtual void SetToolClientData(int toolid, wxObject *clientData); + + // 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 id) const; + virtual bool GetToolState(int toolid) const; - virtual bool GetToolEnabled(int id) const; + virtual bool GetToolEnabled(int toolid) const; - virtual void SetToolShortHelp(int id, const wxString& helpString); - virtual wxString GetToolShortHelp(int id) const; - virtual void SetToolLongHelp(int id, const wxString& helpString); - virtual wxString GetToolLongHelp(int id) const; + virtual void SetToolShortHelp(int toolid, const wxString& helpString); + virtual wxString GetToolShortHelp(int toolid) const; + virtual void SetToolLongHelp(int toolid, const wxString& helpString); + virtual wxString GetToolLongHelp(int toolid) const; // margins/packing/separation // -------------------------- @@ -432,7 +435,7 @@ public: // don't use in the new code! // -------------------------------------------------------------- - wxToolBarToolBase *AddTool(int id, + wxToolBarToolBase *AddTool(int toolid, const wxBitmap& bitmap, const wxBitmap& bmpDisabled, bool toggle = FALSE, @@ -440,23 +443,23 @@ public: const wxString& shortHelpString = wxEmptyString, const wxString& longHelpString = wxEmptyString) { - return AddTool(id, wxEmptyString, + return AddTool(toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelpString, longHelpString, clientData); } - wxToolBarToolBase *AddTool(int id, + wxToolBarToolBase *AddTool(int toolid, const wxBitmap& bitmap, const wxString& shortHelpString = wxEmptyString, const wxString& longHelpString = wxEmptyString) { - return AddTool(id, wxEmptyString, + return AddTool(toolid, wxEmptyString, bitmap, wxNullBitmap, wxITEM_NORMAL, shortHelpString, longHelpString, NULL); } - wxToolBarToolBase *AddTool(int id, + wxToolBarToolBase *AddTool(int toolid, const wxBitmap& bitmap, const wxBitmap& bmpDisabled, bool toggle, @@ -466,13 +469,13 @@ public: const wxString& shortHelp = wxEmptyString, const wxString& longHelp = wxEmptyString) { - return DoAddTool(id, wxEmptyString, bitmap, bmpDisabled, + return DoAddTool(toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelp, longHelp, clientData, xPos, yPos); } wxToolBarToolBase *InsertTool(size_t pos, - int id, + int toolid, const wxBitmap& bitmap, const wxBitmap& bmpDisabled = wxNullBitmap, bool toggle = FALSE, @@ -480,7 +483,7 @@ public: const wxString& shortHelp = wxEmptyString, const wxString& longHelp = wxEmptyString) { - return InsertTool(pos, id, wxEmptyString, bitmap, bmpDisabled, + return InsertTool(pos, toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelp, longHelp, clientData); } @@ -491,14 +494,14 @@ public: // NB: these functions are deprecated, use EVT_TOOL_XXX() instead! // Only allow toggle if returns TRUE. Call when left button up. - virtual bool OnLeftClick(int id, bool toggleDown); + virtual bool OnLeftClick(int toolid, bool toggleDown); // Call when right button down. - virtual void OnRightClick(int id, long x, long y); + 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. - virtual void OnMouseEnter(int id); + virtual void OnMouseEnter(int toolid); // more deprecated functions // ------------------------- @@ -538,7 +541,7 @@ protected: // implemented by just calling InsertTool() virtual wxToolBarToolBase *DoAddTool ( - int id, + int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled, @@ -568,7 +571,7 @@ protected: virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle) = 0; // the functions to create toolbar tools - virtual wxToolBarToolBase *CreateTool(int id, + virtual wxToolBarToolBase *CreateTool(int toolid, const wxString& label, const wxBitmap& bmpNormal, const wxBitmap& bmpDisabled, @@ -583,7 +586,7 @@ protected: // ---------------- // find the tool by id - wxToolBarToolBase *FindById(int id) const; + wxToolBarToolBase *FindById(int toolid) const; // the list of all our tools wxToolBarToolsList m_tools;