X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0ea48a1f23b2c9763778f60405f051cac8bf781b..ef094fa075bc56bcbc33b12159c395ea28afda3b:/include/wx/tbarbase.h?ds=sidebyside diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h index cf7eeac27c..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 ///////////////////////////////////////////////////////////////////////////// @@ -16,18 +16,21 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #pragma interface "tbarbase.h" #endif #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; +class WXDLLEXPORT wxImage; // ---------------------------------------------------------------------------- // constants @@ -62,28 +65,31 @@ public: // ------------ wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL, - int id = wxID_SEPARATOR, - const wxBitmap& bitmap1 = wxNullBitmap, - const wxBitmap& bitmap2 = wxNullBitmap, - bool toggle = FALSE, + int toolid = wxID_SEPARATOR, + 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) - : m_shortHelpString(shortHelpString), + : m_label(label), + m_shortHelpString(shortHelpString), m_longHelpString(longHelpString) { m_tbar = tbar; - m_id = id; + m_id = toolid; 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_toolStyle = id == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR + m_toolStyle = toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR : wxTOOL_STYLE_BUTTON; } @@ -93,7 +99,8 @@ public: m_control = control; m_id = control->GetId(); - m_isToggle = FALSE; + m_kind = wxITEM_MAX; // invalid value + m_enabled = TRUE; m_toggled = FALSE; @@ -118,22 +125,31 @@ public: 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; } + 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; } - bool CanBeToggled() const { return m_isToggle; } + bool CanBeToggled() const + { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; } // 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 - { 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; } @@ -159,8 +175,10 @@ public: 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) { @@ -178,11 +196,22 @@ public: 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) - 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 @@ -193,16 +222,20 @@ protected: // tool state bool m_toggled; - bool m_isToggle; 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; wxString m_longHelpString; + + DECLARE_NO_COPY_CLASS(wxToolBarToolBase) }; // a list of toolbar tools @@ -221,59 +254,79 @@ public: // toolbar construction // -------------------- - // the most commonly used version of AddTool() - wxToolBarToolBase *AddTool(int id, + // 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 toolid, + const wxString& label, const wxBitmap& bitmap, - 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, wxNullBitmap, FALSE, NULL, - shortHelpString, longHelpString); + return DoAddTool(toolid, label, bitmap, bmpDisabled, kind, + shortHelp, longHelp, data); } - // 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. - wxToolBarToolBase *AddTool(int id, + // the most common AddTool() version + wxToolBarToolBase *AddTool(int toolid, + const wxString& label, const wxBitmap& bitmap, - const wxBitmap& pushedBitmap = wxNullBitmap, - bool toggle = FALSE, - wxObject *clientData = NULL, - const wxString& shortHelpString = wxEmptyString, - const wxString& longHelpString = wxEmptyString) + const wxString& shortHelp = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) { - return AddTool(id, bitmap, pushedBitmap, toggle, - -1, -1, clientData, shortHelpString, longHelpString); + return AddTool(toolid, label, bitmap, wxNullBitmap, kind, shortHelp); + } + + // add a check tool, i.e. a tool which can be toggled + wxToolBarToolBase *AddCheckTool(int toolid, + const wxString& label, + const wxBitmap& bitmap, + const wxBitmap& bmpDisabled = wxNullBitmap, + const wxString& shortHelp = wxEmptyString, + const wxString& longHelp = wxEmptyString, + wxObject *data = NULL) + { + 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 toolid, + const wxString& label, + const wxBitmap& bitmap, + const wxBitmap& bmpDisabled = wxNullBitmap, + const wxString& shortHelp = wxEmptyString, + const wxString& longHelp = wxEmptyString, + wxObject *data = NULL) + { + return AddTool(toolid, 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() virtual wxToolBarToolBase *InsertTool ( size_t pos, - int id, + int toolid, + const wxString& label, 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 ); + 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) @@ -281,6 +334,9 @@ public: // 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 ); // add a separator to the toolbar virtual wxToolBarToolBase *AddSeparator(); @@ -288,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(); @@ -304,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 // -------------------------- @@ -335,12 +394,9 @@ public: virtual void SetToolSeparation(int separation) { m_toolSeparation = separation; } - virtual wxSize GetToolMargins() { return GetToolMargins(); } - virtual int GetToolPacking() { return m_toolPacking; } - virtual int GetToolSeparation() { return m_toolSeparation; } - - // for compatibility - wxSize GetMargins() const { return wxSize(m_xMargin, m_yMargin); } + 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 // ---------------- @@ -371,20 +427,81 @@ public: 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 toolid, + const wxBitmap& bitmap, + const wxBitmap& bmpDisabled, + bool toggle = FALSE, + 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); + } + + 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); + } + + wxToolBarToolBase *AddTool(int toolid, + 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(toolid, wxEmptyString, bitmap, bmpDisabled, + toggle ? wxITEM_CHECK : wxITEM_NORMAL, + shortHelp, longHelp, clientData, xPos, yPos); + } + + wxToolBarToolBase *InsertTool(size_t pos, + int toolid, + const wxBitmap& bitmap, + const wxBitmap& bmpDisabled = wxNullBitmap, + bool toggle = FALSE, + 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); + } + // event handlers // -------------- // 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 // ------------------------- @@ -400,6 +517,9 @@ public: virtual wxSize GetDefaultButtonSize() const { return GetToolSize(); } #endif // WXWIN_COMPATIBILITY + // use GetToolMargins() instead + wxSize GetMargins() const { return GetToolMargins(); } + // implementation only from now on // ------------------------------- @@ -410,13 +530,29 @@ public: // Do the toolbar button updates (check for EVT_UPDATE_UI handlers) virtual void DoToolbarUpdates(); - // Don't want toolbars to accept the focus - bool AcceptsFocus() const { return FALSE; } + // don't want toolbars to accept the focus + virtual bool AcceptsFocus() const { return FALSE; } 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 toolid, + 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; @@ -435,20 +571,22 @@ protected: virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle) = 0; // the functions to create toolbar tools - virtual wxToolBarToolBase *CreateTool(int id, - const wxBitmap& bitmap1, - const wxBitmap& bitmap2, - bool toggle, + virtual wxToolBarToolBase *CreateTool(int toolid, + const wxString& label, + const wxBitmap& bmpNormal, + const wxBitmap& bmpDisabled, + wxItemKind kind, wxObject *clientData, - const wxString& shortHelpString, - const wxString& longHelpString) = 0; + const wxString& shortHelp, + const wxString& longHelp) = 0; + virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0; // helper functions // ---------------- // find the tool by id - wxToolBarToolBase *FindById(int id) const; + wxToolBarToolBase *FindById(int toolid) const; // the list of all our tools wxToolBarToolsList m_tools; @@ -473,6 +611,11 @@ private: 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_