Really fix the problem with caret in wxGrid text editor under MSW.

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

diff --git a/include/wx/display.h b/include/wx/display.h
index 05db85ab8dfb98961d12417551447344f6b366a5..7923e9c68782a75f343bf645329f6f3ace6a1efe 100644 (file)
--- a/include/wx/display.h
+++ b/include/wx/display.h
@@ -1,83 +1,43 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/display.h
 // Purpose:     wxDisplay class
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/display.h
 // Purpose:     wxDisplay class

-// Author:      Royce Mitchell III
-// Modified by: Vadim Zeitlin (resolution changes, display modes, ...)
+// Author:      Royce Mitchell III, Vadim Zeitlin

 // Created:     06/21/02
 // RCS-ID:      $Id$
 // Created:     06/21/02
 // RCS-ID:      $Id$

-// Copyright:   (c) 2002-2003 wxWindows team
+// Copyright:   (c) 2002-2006 wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DISPLAY_H_BASE_
 #define _WX_DISPLAY_H_BASE_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DISPLAY_H_BASE_
 #define _WX_DISPLAY_H_BASE_
 

-#if wxUSE_DISPLAY
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "displaybase.h"
-#endif
+// NB: no #if wxUSE_DISPLAY here, the display geometry part of this class (but
+//     not the video mode stuff) is always available but if wxUSE_DISPLAY == 0
+//     it becomes just a trivial wrapper around the old wxDisplayXXX() functions

 
 

-#include "wx/dynarray.h"
+#if wxUSE_DISPLAY
+    #include "wx/dynarray.h"
+    #include "wx/vidmode.h"

 
 

-// ----------------------------------------------------------------------------
-// wxVideoMode: contains video mode parameters for a display
-// ----------------------------------------------------------------------------
+    WX_DECLARE_EXPORTED_OBJARRAY(wxVideoMode, wxArrayVideoModes);

 
 

-struct WXDLLEXPORT wxVideoMode
-{
-    wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0)
-    {
-        w = width;
-        h = height;
-
-        bpp = depth;
-
-        refresh = freq;
-    }
-
-    // default copy ctor and assignment operator are ok
-
-    bool operator==(const wxVideoMode& m) const
-    {
-        return w == m.w && h == m.h && bpp == m.bpp && refresh == m.refresh;
-    }
-    bool operator!=(const wxVideoMode& mode) const
-    {
-        return !operator==(mode);
-    }
-
-    // returns true if this mode matches the other one in the sense that all
-    // non zero fields of the other mode have the same value in this one
-    // (except for refresh which is allowed to have a greater value)
-    bool Matches(const wxVideoMode& other) const
-    {
-        return (!other.w || w == other.w) &&
-                    (!other.h || h == other.h) &&
-                        (!other.bpp || bpp == other.bpp) &&
-                            (!other.refresh || refresh >= other.refresh);
-    }
-
-    // the screen size in pixels (e.g. 640*480), 0 means unspecified
-    int w, h;
-
-    // bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known
-    int bpp;
-
-    // refresh frequency in Hz, 0 means unspecified/unknown
-    int refresh;
-};
+    // default, uninitialized, video mode object
+    extern WXDLLIMPEXP_DATA_CORE(const wxVideoMode) wxDefaultVideoMode;
+#endif // wxUSE_DISPLAY

 
 

-WX_DECLARE_EXPORTED_OBJARRAY(wxVideoMode, wxArrayVideoModes);
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxPoint;
+class WXDLLIMPEXP_FWD_CORE wxRect;
+class WXDLLIMPEXP_FWD_BASE wxString;

 
 

-// default, uninitialized, video mode object
-WXDLLEXPORT_DATA(extern const wxVideoMode) wxDefaultVideoMode;
+class WXDLLIMPEXP_FWD_CORE wxDisplayFactory;
+class WXDLLIMPEXP_FWD_CORE wxDisplayImpl;

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxDisplayBase: represents a display/monitor attached to the system
+// wxDisplay: represents a display/monitor attached to the system

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDisplayBase
+class WXDLLIMPEXP_CORE wxDisplay

 {
 public:
     // initialize the object containing all information about the given
 {
 public:
     // initialize the object containing all information about the given


@@ -85,11 +45,16 @@ public:
     //
     // the displays are numbered from 0 to GetCount() - 1, 0 is always the
     // primary display and the only one which is always supported
     //
     // the displays are numbered from 0 to GetCount() - 1, 0 is always the
     // primary display and the only one which is always supported

-    wxDisplayBase(size_t index = 0);
+    wxDisplay(unsigned n = 0);
+
+    // dtor is not virtual as this is a concrete class not meant to be derived
+    // from
+    ~wxDisplay();
+

 
     // return the number of available displays, valid parameters to
     // wxDisplay ctor are from 0 up to this number
 
     // return the number of available displays, valid parameters to
     // wxDisplay ctor are from 0 up to this number

-    static size_t GetCount();
+    static unsigned GetCount();

 
     // find the display where the given point lies, return wxNOT_FOUND if
     // it doesn't belong to any display
 
     // find the display where the given point lies, return wxNOT_FOUND if
     // it doesn't belong to any display


@@ -97,19 +62,26 @@ public:
 
     // find the display where the given window lies, return wxNOT_FOUND if it
     // is not shown at all
 
     // find the display where the given window lies, return wxNOT_FOUND if it
     // is not shown at all

-    static int GetFromWindow(wxWindow *window);
+    static int GetFromWindow(const wxWindow *window);
+
+
+    // return true if the object was initialized successfully
+    bool IsOk() const { return m_impl != NULL; }

 
 

+    // get the full display size
+    wxRect GetGeometry() const;

 
 

-    // get the display size
-    virtual wxRect GetGeometry() const = 0;
+    // get the client area of the display, i.e. without taskbars and such
+    wxRect GetClientArea() const;

 
     // name may be empty
 
     // name may be empty

-    virtual wxString GetName() const = 0;
+    wxString GetName() const;

 
 

-    // display 0 is always the primary display
-    bool IsPrimary() const { return m_index == 0; }
+    // display 0 is usually the primary display
+    bool IsPrimary() const;

 
 
 
 

+#if wxUSE_DISPLAY

     // enumerate all video modes supported by this display matching the given
     // one (in the sense of wxVideoMode::Match())
     //
     // enumerate all video modes supported by this display matching the given
     // one (in the sense of wxVideoMode::Match())
     //


@@ -117,43 +89,40 @@ public:
     // always at least one video mode supported by display, the returned array
     // is only empty for the default value of the argument if this function is
     // not supported at all on this platform
     // always at least one video mode supported by display, the returned array
     // is only empty for the default value of the argument if this function is
     // not supported at all on this platform

-    virtual wxArrayVideoModes
-        GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const = 0;
+    wxArrayVideoModes
+        GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;

 
     // get current video mode
 
     // get current video mode

-    virtual wxVideoMode GetCurrentMode() const = 0;
+    wxVideoMode GetCurrentMode() const;

 
     // change current mode, return true if succeeded, false otherwise
     //
     // for the default value of the argument restores the video mode to default
 
     // change current mode, return true if succeeded, false otherwise
     //
     // for the default value of the argument restores the video mode to default

-    virtual bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode) = 0;
+    bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode);

 
     // restore the default video mode (just a more readable synonym)
     void ResetMode() { (void)ChangeMode(); }
 
     // restore the default video mode (just a more readable synonym)
     void ResetMode() { (void)ChangeMode(); }

+#endif // wxUSE_DISPLAY

 
 

-    // virtual dtor as for any base class
-    virtual ~wxDisplayBase() { }
+private:
+    // returns the factory used to implement our static methods and create new
+    // displays
+    static wxDisplayFactory& Factory();

 
 

-protected:
-    // the index of this display (0 is always the primary one)
-    size_t m_index;
+    // creates the factory object, called by Factory() when it is called for
+    // the first time and should return a pointer allocated with new (the
+    // caller will delete it)
+    //
+    // this method must be implemented in platform-specific code if
+    // wxUSE_DISPLAY == 1 (if it is 0 we provide the stub in common code)
+    static wxDisplayFactory *CreateFactory();

 
 

-    DECLARE_NO_COPY_CLASS(wxDisplayBase);
-};

 
 

+    // the real implementation
+    wxDisplayImpl *m_impl;

 
 

-#if defined(__WXMSW__)
-    #include "wx/msw/display.h"
-#elif defined(__WXMOTIF__)
-    #include "wx/motif/display.h"
-#elif defined(__WXGTK__)
-    #include "wx/gtk/display.h"
-#elif defined(__WXMAC__)
-    #include "wx/mac/display.h"
-#elif defined(__WXPM__)
-    #include "wx/os2/display.h"
-#endif

 
 

-#endif // wxUSE_DISPLAY
+    wxDECLARE_NO_COPY_CLASS(wxDisplay);
+};

 
 #endif // _WX_DISPLAY_H_BASE_
 
 #endif // _WX_DISPLAY_H_BASE_