explained how the signature works

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

diff --git a/include/wx/display.h b/include/wx/display.h
index fc020fee475084b95591c32fe46b25f88e337bd0..e46e596b70677fc5e6f02b45e8ecf71312ca8465 100644 (file)
--- a/include/wx/display.h
+++ b/include/wx/display.h
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        display.h
+// Name:        wx/display.h
 // Purpose:     wxDisplay class
 // Author:      Royce Mitchell III
-// Modified by: 
+// Modified by: Vadim Zeitlin (resolution changes, display modes, ...)
 // Created:     06/21/02
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) 2002-2003 wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -14,62 +14,103 @@
 
 #if wxUSE_DISPLAY
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "display.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "displaybase.h"
 #endif
 
-class wxPoint;
-class wxRect;
-class wxString;
+#include "wx/dynarray.h"
+#include "wx/vidmode.h"
+
+class WXDLLEXPORT wxWindow;
+class WXDLLEXPORT wxPoint;
+class WXDLLEXPORT wxRect;
+class WXDLLEXPORT wxString; 
+
+WX_DECLARE_EXPORTED_OBJARRAY(wxVideoMode, wxArrayVideoModes);
+
+// default, uninitialized, video mode object
+WXDLLEXPORT_DATA(extern const wxVideoMode) wxDefaultVideoMode;
+
+// ----------------------------------------------------------------------------
+// wxDisplayBase: represents a display/monitor attached to the system
+// ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxDisplayBase
 {
 public:
     // initialize the object containing all information about the given
     // display
-    wxDisplayBase ( size_t index = 0 ) : m_index ( index )
-    {
-        wxASSERT_MSG(m_index < wxDisplayBase::GetCount(), wxT("An invalid index was passed to wxDisplay"));
-    }
-
-    // accessors
+    //
+    // 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);
 
     // return the number of available displays, valid parameters to
     // wxDisplay ctor are from 0 up to this number
     static size_t GetCount();
 
-    // find the display where the given point lies, return -1 if
+    // find the display where the given point lies, return wxNOT_FOUND if
     // it doesn't belong to any display
-    static int GetFromPoint ( const wxPoint& pt );
+    static int GetFromPoint(const wxPoint& pt);
+
+    // find the display where the given window lies, return wxNOT_FOUND if it
+    // is not shown at all
+    static int GetFromWindow(wxWindow *window);
 
-    virtual wxRect GetGeometry() const = 0;
-    virtual int GetDepth() const = 0;
-    bool IsColour() const { return GetDepth() != 1; }
 
-    // some people never learn to spell ;-)
-    bool IsColor() const { return IsColour(); }
+    // return true if the object was initialized successfully
+    virtual bool IsOk() const { return true; }
+
+    // get the display size
+    virtual wxRect GetGeometry() const = 0;
 
     // name may be empty
     virtual wxString GetName() const = 0;
 
-    // let display 0 always be the primary display
-    bool IsPrimary() { return m_index == 0; }
+    // display 0 is always the primary display
+    bool IsPrimary() const { return m_index == 0; }
+
+
+    // enumerate all video modes supported by this display matching the given
+    // one (in the sense of wxVideoMode::Match())
+    //
+    // as any mode matches the default value of the argument and there is
+    // 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;
 
+    // get current video mode
+    virtual wxVideoMode GetCurrentMode() const = 0;
 
-    virtual ~wxDisplayBase() {}
+    // 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;
+
+    // restore the default video mode (just a more readable synonym)
+    void ResetMode() { (void)ChangeMode(); }
+
+    // virtual dtor as for any base class
+    virtual ~wxDisplayBase() { }
 
 protected:
-    size_t m_index; // which display did we select when creating this file?
+    // the index of this display (0 is always the primary one)
+    size_t m_index;
 
-    DECLARE_NO_COPY_CLASS(wxDisplayBase);
+    DECLARE_NO_COPY_CLASS(wxDisplayBase)
 };
 
+
 #if defined(__WXMSW__)
     #include "wx/msw/display.h"
 #elif defined(__WXMOTIF__)
-    #include "wx/motif/display.h"
+    #include "wx/unix/displayx11.h"
 #elif defined(__WXGTK__)
-    #include "wx/gtk/display.h"
+    #include "wx/unix/displayx11.h"
+#elif defined(__WXX11__)
+    #include "wx/unix/displayx11.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/display.h"
 #elif defined(__WXPM__)