X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6bb7cee4e942e5816a02e03dcd4d13d5cfa91f19..99c4be680622f58a48a04dfe0835b59d2c41afea:/include/wx/tbarbase.h diff --git a/include/wx/tbarbase.h b/include/wx/tbarbase.h index 30396a4b07..fc09d46586 100644 --- a/include/wx/tbarbase.h +++ b/include/wx/tbarbase.h @@ -16,10 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #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,27 +54,30 @@ 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, + wxToolBarToolBase(wxToolBarBase *tbar = NULL, int toolid = wxID_SEPARATOR, const wxString& label = wxEmptyString, const wxBitmap& bmpNormal = wxNullBitmap, const wxBitmap& bmpDisabled = wxNullBitmap, wxItemKind kind = wxITEM_NORMAL, - wxObject *clientData = (wxObject *) NULL, + wxObject *clientData = NULL, const wxString& shortHelpString = wxEmptyString, 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; + 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 = 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,17 +170,17 @@ public: } } - // modifiers: return TRUE if the state really changed - bool Enable(bool enable); - bool Toggle(bool toggle); - bool SetToggle(bool toggle); - bool SetShortHelp(const wxString& help); - bool SetLongHelp(const wxString& help); + // modifiers: return true if the state really changed + virtual bool Enable(bool enable); + virtual bool Toggle(bool toggle); + virtual bool SetToggle(bool toggle); + virtual bool SetShortHelp(const wxString& help); + virtual bool SetLongHelp(const wxString& help); void Toggle() { Toggle(!IsToggled()); } - void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; } - void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; } + virtual void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; } + virtual void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; } virtual void SetLabel(const wxString& label) { m_label = label; } @@ -193,24 +197,20 @@ public: } // add tool to/remove it from a toolbar - virtual void Detach() { m_tbar = (wxToolBarBase *)NULL; } + virtual void Detach() { m_tbar = 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) + virtual 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 @@ -235,7 +235,9 @@ protected: 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 @@ -245,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(); @@ -327,14 +329,18 @@ public: 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 - 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 ); @@ -373,7 +379,7 @@ public: // 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; @@ -383,6 +389,12 @@ public: 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 // -------------------------- @@ -413,94 +425,98 @@ 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; +#if WXWIN_COMPATIBILITY_2_8 // the old versions of the various methods kept for compatibility // don't use in the new code! // -------------------------------------------------------------- - + wxDEPRECATED_INLINE( 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(toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelpString, longHelpString, clientData); - } - + ) + wxDEPRECATED_INLINE( 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); - } - + ) + wxDEPRECATED_INLINE( 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(toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelp, longHelp, clientData, xPos, yPos); - } - + ) + wxDEPRECATED_INLINE( wxToolBarToolBase *InsertTool(size_t pos, 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, toolid, wxEmptyString, bitmap, bmpDisabled, toggle ? wxITEM_CHECK : wxITEM_NORMAL, shortHelp, longHelp, clientData); - } + ) +#endif // WXWIN_COMPATIBILITY_2_8 // event handlers // -------------- // 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. - // 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 @@ -518,7 +534,10 @@ public: 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 @@ -536,8 +555,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 @@ -567,13 +586,18 @@ 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 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); @@ -601,8 +625,14 @@ private: 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