X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fadc2df6823d988f7a264b94e69a7e1bbcac1337..c29c95fe24973b94fd724db767193171ca7c513d:/interface/wx/renderer.h diff --git a/interface/wx/renderer.h b/interface/wx/renderer.h index 12f4d16f10..f6b55e934f 100644 --- a/interface/wx/renderer.h +++ b/interface/wx/renderer.h @@ -3,7 +3,7 @@ // Purpose: interface of wxRendererNative // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -56,6 +56,18 @@ enum wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE }; +/** + Title bar buttons supported by wxRendererNative::DrawTitleBarBitmap(). + */ +enum wxTitleBarButton +{ + wxTITLEBAR_BUTTON_CLOSE = 0x01000000, + wxTITLEBAR_BUTTON_MAXIMIZE = 0x02000000, + wxTITLEBAR_BUTTON_ICONIZE = 0x04000000, + wxTITLEBAR_BUTTON_RESTORE = 0x08000000, + wxTITLEBAR_BUTTON_HELP = 0x10000000 +}; + /** @struct wxSplitterRenderParams @@ -192,6 +204,8 @@ public: virtual int GetHeaderButtonHeight(wxWindow *win); + virtual int GetHeaderButtonMargin(wxWindow *win); + virtual void DrawTreeItemButton(wxWindow *win, wxDC& dc, const wxRect& rect, int flags = 0); @@ -293,8 +307,8 @@ public: @a flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or @c wxCONTROL_UNDETERMINED bit set, see @ref wxCONTROL_FLAGS. */ - virtual void DrawCheckBox(wxWindow* win, wxDC& dc, - const wxRect& rect, int flags); + virtual void DrawCheckBox(wxWindow* win, wxDC& dc, const wxRect& rect, + int flags = 0) = 0; /** Draw a button like the one used by wxComboBox to show a @@ -304,8 +318,7 @@ public: see @ref wxCONTROL_FLAGS. */ virtual void DrawComboBoxDropButton(wxWindow* win, wxDC& dc, - const wxRect& rect, - int flags); + const wxRect& rect, int flags = 0) = 0; /** Draw a drop down arrow that is suitable for use outside a combo box. Arrow will @@ -318,7 +331,7 @@ public: see @ref wxCONTROL_FLAGS. */ virtual void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect, - int flags); + int flags = 0) = 0; /** Draw a focus rectangle using the specified rectangle. @@ -337,7 +350,7 @@ public: @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS. @return - The optimal width to contain the the unabreviated label text or + The optimal width to contain the unabbreviated label text or bitmap, the sort arrow if present, and internal margins. */ virtual int DrawHeaderButton(wxWindow* win, wxDC& dc, const wxRect& rect, @@ -352,7 +365,7 @@ public: @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS. @return - The optimal width to contain the the unabreviated label text or + The optimal width to contain the unabbreviated label text or bitmap, the sort arrow if present, and internal margins. */ virtual int DrawHeaderButtonContents(wxWindow* win, wxDC& dc, @@ -367,7 +380,7 @@ public: which are selected (e.g. often a blue rectangle) and @c wxCONTROL_CURRENT for the item that has the focus (often a dotted line around the item's text). @c wxCONTROL_FOCUSED may be used to indicate if the control has the focus - (othewise the the selection rectangle is e.g. often grey and not blue). + (otherwise the selection rectangle is e.g. often grey and not blue). This may be ignored by the renderer or deduced by the code directly from the @a win. */ @@ -380,8 +393,8 @@ public: @a flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or @c wxCONTROL_ISDEFAULT bit set, see @ref wxCONTROL_FLAGS. */ - virtual void DrawPushButton(wxWindow* win, wxDC& dc, - const wxRect& rect, int flags); + virtual void DrawPushButton(wxWindow* win, wxDC& dc, const wxRect& rect, + int flags = 0) = 0; /** Draw the border for sash window: this border must be such that the sash @@ -407,10 +420,54 @@ public: virtual void DrawTreeItemButton(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0; + /** + Draw a native wxChoice + */ + virtual void DrawChoice(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0; + + /** + Draw a native wxComboBox + */ + virtual void DrawComboBox(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0; + + /** + Draw a native wxTextCtrl frame + */ + virtual void DrawTextCtrl(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0; + + /** + Draw a native wxRadioButton bitmap. + */ + virtual void DrawRadioBitmap(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0; + + /** + Draw a title bar button in the given state. + + This function is currently only available under MSW and OS X (and only + for wxTITLEBAR_BUTTON_CLOSE under the latter), its best replacement for + the other platforms is to use wxArtProvider to retrieve the bitmaps for + @c wxART_HELP and @c wxART_CLOSE (but not any other title bar buttons + and not for any state but normal, i.e. not pressed and not current one). + + The presence of this function is indicated by @c + wxHAS_DRAW_TITLE_BAR_BITMAP symbol being defined. + + Also notice that PNG handler must be enabled using wxImage::AddHandler() + to use this function under OS X currently as the bitmaps are embedded + in the library itself in PNG format. + + @since 2.9.1 + */ + virtual void DrawTitleBarBitmap(wxWindow *win, + wxDC& dc, + const wxRect& rect, + wxTitleBarButton button, + int flags = 0) = 0; + /** Return the currently used renderer. */ - static wxRendererNative Get(); + static wxRendererNative& Get(); /** Return the default (native) implementation for this platform -- this is also @@ -418,30 +475,38 @@ public: Set() in which case the return value of this method may be different from the return value of Get(). */ - static wxRendererNative GetDefault(); + static wxRendererNative& GetDefault(); /** Return the generic implementation of the renderer. Under some platforms, this is the default renderer implementation, others have platform-specific default renderer which can be retrieved by calling GetDefault(). */ - static wxRendererNative GetGeneric(); + static wxRendererNative& GetGeneric(); /** Returns the size of a check box. + The @a win parameter is not used currently and can be @NULL. */ virtual wxSize GetCheckBoxSize(wxWindow* win) = 0; /** Returns the height of a header button, either a fixed platform height if - available, or a - generic height based on the window's font. + available, or a generic height based on the @a win window's font. */ virtual int GetHeaderButtonHeight(wxWindow* win) = 0; /** - Get the splitter parameters, see - wxSplitterRenderParams. + Returns the horizontal margin on the left and right sides of header + button's label. + + @since 2.9.2 + */ + virtual int GetHeaderButtonMargin(wxWindow *win) = 0; + + /** + Get the splitter parameters, see wxSplitterRenderParams. + The @a win parameter should be a wxSplitterWindow. */ virtual wxSplitterRenderParams GetSplitterParams(const wxWindow* win) = 0;