Add wxTimer::StartOnce().

[wxWidgets.git] / interface / wx / renderer.h

diff --git a/interface/wx/renderer.h b/interface/wx/renderer.h
index 76a585c2654002886155e38b54ea903ccb951b7d..6b7e5ac5fa8865f180edca61567aad30fea3400d 100644 (file)
--- a/interface/wx/renderer.h
+++ b/interface/wx/renderer.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRendererNative
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxRendererNative
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -43,7 +43,7 @@ enum
     /** Mouse is currently over the control. */
     wxCONTROL_CURRENT    = 0x00000010,
 
     /** Mouse is currently over the control. */
     wxCONTROL_CURRENT    = 0x00000010,
 

-    /** Selected item in e.g. listbox. */
+    /** Selected item in e.g.\ listbox. */

     wxCONTROL_SELECTED   = 0x00000020,
 
     /** (Check/radio button) is checked. */
     wxCONTROL_SELECTED   = 0x00000020,
 
     /** (Check/radio button) is checked. */


@@ -56,6 +56,18 @@ enum
     wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE
 };
 
     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
 
 /**
     @struct wxSplitterRenderParams
 


@@ -65,7 +77,7 @@ enum
     It doesn't have any methods and all of its fields are constant, so they can
     only be examined but not modified.
 
     It doesn't have any methods and all of its fields are constant, so they can
     only be examined but not modified.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{gdi}
 */
 struct wxSplitterRenderParams
     @category{gdi}
 */
 struct wxSplitterRenderParams


@@ -99,7 +111,7 @@ struct wxSplitterRenderParams
     wxRendererNative::DrawHeaderButton() to specify custom values used to draw
     the text or bitmap label.
 
     wxRendererNative::DrawHeaderButton() to specify custom values used to draw
     the text or bitmap label.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{gdi}
 */
 struct wxHeaderButtonParams
     @category{gdi}
 */
 struct wxHeaderButtonParams


@@ -192,6 +204,8 @@ public:
 
     virtual int GetHeaderButtonHeight(wxWindow *win);
 
 
     virtual int GetHeaderButtonHeight(wxWindow *win);
 

+    virtual int GetHeaderButtonMargin(wxWindow *win);
+

     virtual void DrawTreeItemButton(wxWindow *win, wxDC& dc,
                                     const wxRect& rect, int flags = 0);
 
     virtual void DrawTreeItemButton(wxWindow *win, wxDC& dc,
                                     const wxRect& rect, int flags = 0);
 


@@ -336,7 +350,7 @@ public:
         @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS.
 
         @return
         @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,
         bitmap, the sort arrow if present, and internal margins.
     */
     virtual int DrawHeaderButton(wxWindow* win, wxDC& dc, const wxRect& rect,


@@ -351,7 +365,7 @@ public:
         @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS.
 
         @return
         @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,
         bitmap, the sort arrow if present, and internal margins.
     */
     virtual int DrawHeaderButtonContents(wxWindow* win, wxDC& dc,


@@ -366,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
         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.
     */
         This may be ignored by the renderer or deduced by the code directly from
         the @a win.
     */


@@ -406,25 +420,49 @@ public:
     virtual void DrawTreeItemButton(wxWindow* win, wxDC& dc, const wxRect& rect,
                                     int flags = 0) = 0;
 
     virtual void DrawTreeItemButton(wxWindow* win, wxDC& dc, const wxRect& rect,
                                     int flags = 0) = 0;
 

-    /** 
+    /**

         Draw a native wxChoice
     */
         Draw a native wxChoice
     */

-    virtual void DrawChoice(wxWindow* win, wxDC& dc, const wxRect& rect, int flags=0) = 0;
+    virtual void DrawChoice(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0;

 
 

-    /** 
+    /**

         Draw a native wxComboBox
     */
         Draw a native wxComboBox
     */

-    virtual void DrawComboBox(wxWindow* win, wxDC& dc, const wxRect& rect, int flags=0) = 0;
+    virtual void DrawComboBox(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0;

 
 

-    /** 
+    /**

         Draw a native wxTextCtrl frame
     */
         Draw a native wxTextCtrl frame
     */

-    virtual void DrawTextCtrl(wxWindow* win, wxDC& dc, const wxRect& rect, int flags=0) = 0;
+    virtual void DrawTextCtrl(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0) = 0;

 
     /**
 
     /**

-        Draw a native wxRadioButton (just the button image, not the text)
+        Draw a native wxRadioButton bitmap.

     */
     */

-    virtual void DrawRadioButton(wxWindow* win, wxDC& dc, const wxRect& rect, int flags=0) = 0;
+    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.
 
     /**
         Return the currently used renderer.


@@ -448,19 +486,27 @@ public:
 
     /**
         Returns the size of a check box.
 
     /**
         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
     */
     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;
 
     /**
     */
     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;
 
     */
     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow* win) = 0;
 


@@ -515,11 +561,13 @@ public:
     renderer which has the age greater or equal to its age. This verification is
     done by IsCompatible() method.
 
     renderer which has the age greater or equal to its age. This verification is
     done by IsCompatible() method.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{gdi}
 */
 struct wxRendererVersion
 {
     @category{gdi}
 */
 struct wxRendererVersion
 {

+    wxRendererVersion(int version_, int age_);
+    

     /**
         Checks if the main program is compatible with the renderer having the version
         @e ver, returns @true if it is and @false otherwise.
     /**
         Checks if the main program is compatible with the renderer having the version
         @e ver, returns @true if it is and @false otherwise.