added NZST and NZDT time zones (request 617912)

[wxWidgets.git] / include / wx / window.h

diff --git a/include/wx/window.h b/include/wx/window.h
index 9f852eec40fec708ad517c03b366d231b647c880..38c73a5c10805dcafe4027b698b9fc07b30124a3 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -25,6 +25,7 @@
 #include "wx/colour.h"
 #include "wx/region.h"
 #include "wx/utils.h"
 #include "wx/colour.h"
 #include "wx/region.h"
 #include "wx/utils.h"

+#include "wx/intl.h"

 
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 


@@ -64,6 +65,7 @@ class WXDLLEXPORT wxSizer;
 class WXDLLEXPORT wxToolTip;
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;
 class WXDLLEXPORT wxToolTip;
 class WXDLLEXPORT wxWindowBase;
 class WXDLLEXPORT wxWindow;

+class WXDLLEXPORT wxScrollHelper;

 
 #if wxUSE_ACCESSIBILITY
 class WXDLLEXPORT wxAccessible;
 
 #if wxUSE_ACCESSIBILITY
 class WXDLLEXPORT wxAccessible;


@@ -180,9 +182,10 @@ public:
     virtual void SetName( const wxString &name ) { m_windowName = name; }
     virtual wxString GetName() const { return m_windowName; }
 
     virtual void SetName( const wxString &name ) { m_windowName = name; }
     virtual wxString GetName() const { return m_windowName; }
 

-    // sets the window variant, calls internally DoSetVariant if variant has changed
-    void SetWindowVariant( wxWindowVariant variant ) ;
-    wxWindowVariant GetWindowVariant() const { return m_windowVariant ; }
+        // sets the window variant, calls internally DoSetVariant if variant
+        // has changed
+    void SetWindowVariant(wxWindowVariant variant);
+    wxWindowVariant GetWindowVariant() const { return m_windowVariant; }

 
 
         // window id uniquely identifies the window among its siblings unless
 
 
         // window id uniquely identifies the window among its siblings unless


@@ -190,6 +193,19 @@ public:
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 

+        // get or change the layout direction (LTR or RTL) for this window,
+        // wxLayout_Default is returned if layout direction is not supported
+    virtual wxLayoutDirection GetLayoutDirection() const
+        { return wxLayout_Default; }
+    virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir))
+        { }
+
+        // mirror coordinates for RTL layout if this window uses it and if the
+        // mirroring is not done automatically like Win32
+    virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                             wxCoord widthTotal) const;
+

         // generate a control id for the controls which were not given one by
         // user
     static int NewControlId() { return --ms_lastControlId; }
         // generate a control id for the controls which were not given one by
         // user
     static int NewControlId() { return --ms_lastControlId; }


@@ -328,6 +344,9 @@ public:
             *h = s.y;
     }
 
             *h = s.y;
     }
 

+    void SetScrollHelper( wxScrollHelper *sh )   { m_scrollHelper = sh; }
+    wxScrollHelper *GetScrollHelper()            { return m_scrollHelper; }
+

         // reset the cached best size value so it will be recalculated the
         // next time it is needed.
     void InvalidateBestSize();
         // reset the cached best size value so it will be recalculated the
         // next time it is needed.
     void InvalidateBestSize();


@@ -464,6 +483,10 @@ public:
     virtual bool IsShown() const { return m_isShown; }
     virtual bool IsEnabled() const { return m_isEnabled; }
 
     virtual bool IsShown() const { return m_isShown; }
     virtual bool IsEnabled() const { return m_isEnabled; }
 

+    // returns true if the window is visible, i.e. IsShown() returns true
+    // if called on it and all its parents up to the first TLW
+    virtual bool IsShownOnScreen() const;
+

         // get/set window style (setting style won't update the window and so
         // is only useful for internal usage)
     virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }
         // get/set window style (setting style won't update the window and so
         // is only useful for internal usage)
     virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }


@@ -696,9 +719,15 @@ public:
         // thaw the window: redraw it after it had been frozen
     virtual void Thaw() { }
 
         // thaw the window: redraw it after it had been frozen
     virtual void Thaw() { }
 

+        // return true if window had been frozen and not unthawed yet
+    virtual bool IsFrozen() const { return false; }
+

         // adjust DC for drawing on this window
     virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
 
         // adjust DC for drawing on this window
     virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
 

+        // return true if the window contents is double buffered by the system
+    virtual bool IsDoubleBuffered() const { return false; }
+

         // the update region of the window contains the areas which must be
         // repainted by the program
     const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
         // the update region of the window contains the areas which must be
         // repainted by the program
     const wxRegion& GetUpdateRegion() const { return m_updateRegion; }


@@ -709,13 +738,17 @@ public:
 
         // these functions verify whether the given point/rectangle belongs to
         // (or at least intersects with) the update region
 
         // these functions verify whether the given point/rectangle belongs to
         // (or at least intersects with) the update region

-    bool IsExposed( int x, int y ) const;
-    bool IsExposed( int x, int y, int w, int h ) const;
+    virtual bool DoIsExposed( int x, int y ) const;
+    virtual bool DoIsExposed( int x, int y, int w, int h ) const;

 
 

+    bool IsExposed( int x, int y ) const
+        { return DoIsExposed(x, y); }
+    bool IsExposed( int x, int y, int w, int h ) const
+    { return DoIsExposed(x, y, w, h); }

     bool IsExposed( const wxPoint& pt ) const
     bool IsExposed( const wxPoint& pt ) const

-        { return IsExposed(pt.x, pt.y); }
+        { return DoIsExposed(pt.x, pt.y); }

     bool IsExposed( const wxRect& rect ) const
     bool IsExposed( const wxRect& rect ) const

-        { return IsExposed(rect.x, rect.y, rect.width, rect.height); }
+        { return DoIsExposed(rect.x, rect.y, rect.width, rect.height); }

 
     // colours, fonts and cursors
     // --------------------------
 
     // colours, fonts and cursors
     // --------------------------


@@ -865,6 +898,10 @@ public:
         { return DoPopupMenu(menu, x, y); }
 #endif // wxUSE_MENUS
 
         { return DoPopupMenu(menu, x, y); }
 #endif // wxUSE_MENUS
 

+    // override this method to return true for controls having multiple pages
+    virtual bool HasMultiplePages() const { return false; }
+
+

     // scrollbars
     // ----------
 
     // scrollbars
     // ----------
 


@@ -1023,6 +1060,12 @@ public:
     wxAccessible* GetOrCreateAccessible() ;
 #endif
 
     wxAccessible* GetOrCreateAccessible() ;
 #endif
 

+
+    // Set window transparency if the platform supports it
+    virtual bool SetTransparent(wxByte WXUNUSED(alpha)) { return false; }
+    virtual bool CanSetTransparent() { return false; }
+
+

     // implementation
     // --------------
 
     // implementation
     // --------------
 


@@ -1209,6 +1252,8 @@ protected:
     // Virtual size (scrolling)
     wxSize                m_virtualSize;
 
     // Virtual size (scrolling)
     wxSize                m_virtualSize;
 

+    wxScrollHelper       *m_scrollHelper;
+

     int                   m_minVirtualWidth;    // VirtualSizeHints
     int                   m_minVirtualHeight;
     int                   m_maxVirtualWidth;
     int                   m_minVirtualWidth;    // VirtualSizeHints
     int                   m_minVirtualHeight;
     int                   m_maxVirtualWidth;


@@ -1300,6 +1345,10 @@ protected:
     // from both DoSetSize() and DoSetClientSize() and would usually just
     // reposition this window except for composite controls which will want to
     // arrange themselves inside the given rectangle
     // from both DoSetSize() and DoSetClientSize() and would usually just
     // reposition this window except for composite controls which will want to
     // arrange themselves inside the given rectangle

+    //
+    // Important note: the coordinates passed to this method are in parent's
+    // *window* coordinates and not parent's client coordinates (as the values
+    // passed to DoSetSize and returned by DoGetPosition are)!

     virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
 
     // centre the window in the specified direction on parent, note that
     virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
 
     // centre the window in the specified direction on parent, note that


@@ -1324,12 +1373,20 @@ protected:
     // implements the window variants
     virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
 
     // implements the window variants
     virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
 

+    // Must be called when mouse capture is lost to send
+    // wxMouseCaptureLostEvent to windows on capture stack.
+    static void NotifyCaptureLost();
+

 private:
     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 
     // the stack of windows which have captured the mouse
     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
 private:
     // contains the last id generated by NewControlId
     static int ms_lastControlId;
 
     // the stack of windows which have captured the mouse
     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;

+    // the window that currently has mouse capture
+    static wxWindow *ms_winCaptureCurrent;
+    // indicates if execution is inside CaptureMouse/ReleaseMouse
+    static bool ms_winCaptureChanging;

 
     DECLARE_ABSTRACT_CLASS(wxWindowBase)
     DECLARE_NO_COPY_CLASS(wxWindowBase)
 
     DECLARE_ABSTRACT_CLASS(wxWindowBase)
     DECLARE_NO_COPY_CLASS(wxWindowBase)


@@ -1379,12 +1436,11 @@ private:
     #endif // wxUniv
     #include "wx/x11/window.h"
 #elif defined(__WXMGL__)
     #endif // wxUniv
     #include "wx/x11/window.h"
 #elif defined(__WXMGL__)

-    #ifdef __WXUNIVERSAL__
-        #define wxWindowNative wxWindowMGL
-    #else // !wxUniv
-        #define wxWindowMGL wxWindow
-    #endif // wxUniv
+    #define wxWindowNative wxWindowMGL

     #include "wx/mgl/window.h"
     #include "wx/mgl/window.h"

+#elif defined(__WXDFB__)
+    #define wxWindowNative wxWindowDFB
+    #include "wx/dfb/window.h"

 #elif defined(__WXMAC__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMac
 #elif defined(__WXMAC__)
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMac


@@ -1533,6 +1589,7 @@ public:
         // If this object has the focus, child should be 'this'.
     virtual wxAccStatus GetFocus(int* childId, wxAccessible** child);
 
         // If this object has the focus, child should be 'this'.
     virtual wxAccStatus GetFocus(int* childId, wxAccessible** child);
 

+#if wxUSE_VARIANT

         // Gets a variant representing the selected children
         // of this object.
         // Acceptable values:
         // Gets a variant representing the selected children
         // of this object.
         // Acceptable values:


@@ -1542,6 +1599,7 @@ public:
         //   or 0 if this object is selected (GetType() == wxT("long")
         // - a "void*" pointer to a wxAccessible child object
     virtual wxAccStatus GetSelections(wxVariant* selections);
         //   or 0 if this object is selected (GetType() == wxT("long")
         // - a "void*" pointer to a wxAccessible child object
     virtual wxAccStatus GetSelections(wxVariant* selections);

+#endif // wxUSE_VARIANT

 };
 
 #endif // wxUSE_ACCESSIBILITY
 };
 
 #endif // wxUSE_ACCESSIBILITY