X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e76c0b5fc59b06273ebbe9c1d9b2646befd0acd0..c2193ac9115470a4ecbc6844bbe19734a8c636ad:/include/wx/tbarbase.h?ds=sidebyside diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h index 1ba060a436..586f6c3d71 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,10 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma interface "tbarbase.h" -#endif - #include "wx/defs.h" #if wxUSE_TOOLBAR @@ -28,17 +24,17 @@ #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 // ---------------------------------------------------------------------------- -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 { @@ -50,7 +46,7 @@ enum wxToolBarToolStyle // ---------------------------------------------------------------------------- // 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 @@ -58,14 +54,14 @@ enum wxToolBarToolStyle // for the applications status bar. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxToolBarToolBase : public wxObject +class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject { public: // ctors & dtor // ------------ 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, @@ -75,10 +71,13 @@ public: const wxString& longHelpString = wxEmptyString) : m_label(label), m_shortHelpString(shortHelpString), - m_longHelpString(longHelpString) + m_longHelpString(longHelpString), + m_dropdownMenu(NULL) { m_tbar = tbar; - m_id = id; + m_id = toolid; + if (m_id == wxID_ANY) + m_id = wxWindow::NewControlId(); m_clientData = clientData; m_bmpNormal = bmpNormal; @@ -86,14 +85,17 @@ public: m_kind = kind; - m_enabled = TRUE; - m_toggled = FALSE; + 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; } - wxToolBarToolBase(wxToolBarBase *tbar, wxControl *control) + wxToolBarToolBase(wxToolBarBase *tbar, + wxControl *control, + const wxString& label) + : m_label(label) { m_tbar = tbar; m_control = control; @@ -101,13 +103,15 @@ public: m_kind = wxITEM_MAX; // invalid value - m_enabled = TRUE; - m_toggled = FALSE; + m_enabled = true; + m_toggled = false; m_toolStyle = wxTOOL_STYLE_CONTROL; + + m_dropdownMenu = 0; } - ~wxToolBarToolBase(); + virtual ~wxToolBarToolBase(); // accessors // --------- @@ -149,10 +153,10 @@ public: 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 { @@ -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); @@ -178,7 +182,7 @@ public: void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; } void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; } - void SetLabel(const wxString& label) { m_label = label; } + virtual void SetLabel(const wxString& label) { m_label = label; } void SetClientData(wxObject *clientData) { @@ -196,21 +200,17 @@ 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 + // 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) // 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 @@ -234,6 +234,10 @@ protected: // short and long help strings wxString m_shortHelpString; wxString m_longHelpString; + + wxMenu *m_dropdownMenu; + + DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase) }; // a list of toolbar tools @@ -243,7 +247,7 @@ WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase, wxToolBarToolsList); // the base class for all toolbars // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxToolBarBase : public wxControl +class WXDLLIMPEXP_CORE wxToolBarBase : public wxControl { public: wxToolBarBase(); @@ -256,7 +260,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, @@ -265,22 +269,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, @@ -288,13 +292,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, @@ -302,7 +306,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); } @@ -312,7 +316,7 @@ public: virtual wxToolBarToolBase *InsertTool ( size_t pos, - int id, + int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled = wxNullBitmap, @@ -322,13 +326,23 @@ public: wxObject *clientData = NULL ); - // 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) + 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) // + // the label is optional and, if specified, will be shown near the control // 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 ); // add a separator to the toolbar virtual wxToolBarToolBase *AddSeparator(); @@ -336,11 +350,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(); @@ -352,25 +366,34 @@ 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 toolid) const; - // return TRUE if the tool is toggled - virtual bool GetToolState(int id) const; + virtual bool GetToolEnabled(int toolid) const; - virtual bool GetToolEnabled(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; + + virtual void SetToolNormalBitmap(int WXUNUSED(id), + const wxBitmap& WXUNUSED(bitmap)) {} + virtual void SetToolDisabledBitmap(int WXUNUSED(id), + const wxBitmap& WXUNUSED(bitmap)) {} - 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; // margins/packing/separation // -------------------------- @@ -402,77 +425,80 @@ 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) - { 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 - { 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; - // 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; // the old versions of the various methods kept for compatibility // don't use in the new code! // -------------------------------------------------------------- - wxToolBarToolBase *AddTool(int id, + 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) { - 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, wxCoord xPos, - wxCoord yPos = -1, + wxCoord yPos = wxDefaultCoord, wxObject *clientData = NULL, 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, + bool toggle = false, wxObject *clientData = NULL, 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); } @@ -482,30 +508,19 @@ 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); + // 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 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); + // Argument is wxID_ANY if mouse is exiting the toolbar. + 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(); } @@ -514,13 +529,14 @@ public: size_t GetToolsCount() const { return m_tools.GetCount(); } - void OnIdle(wxIdleEvent& event); - // 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 - 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 @@ -530,7 +546,7 @@ protected: // implemented by just calling InsertTool() virtual wxToolBarToolBase *DoAddTool ( - int id, + int toolid, const wxString& label, const wxBitmap& bitmap, const wxBitmap& bmpDisabled, @@ -538,8 +554,8 @@ protected: 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 @@ -560,7 +576,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, @@ -569,13 +585,21 @@ protected: const wxString& shortHelp, const wxString& longHelp) = 0; - virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0; + virtual wxToolBarToolBase *CreateTool(wxControl *control, + const wxString& label) = 0; // helper functions // ---------------- - // find the tool by id - wxToolBarToolBase *FindById(int id) 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; @@ -597,11 +621,17 @@ protected: private: DECLARE_EVENT_TABLE() - DECLARE_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