use wxNullFont instead of *wxNORMAL_FONT as default parameter for wxFontPickerCtrl...

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

diff --git a/include/wx/display.h b/include/wx/display.h
index e62be18768e697dd2b011e85c26ed22477e70e6e..e31ee3286a64c131b790ad5033b6100bc954c75a 100644 (file)
--- a/include/wx/display.h
+++ b/include/wx/display.h
@@ -1,81 +1,128 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        display.h
+// Name:        wx/display.h

 // Purpose:     wxDisplay class
 // Purpose:     wxDisplay class

-// Author:      Royce Mitchell III
-// Modified by: 
+// Author:      Royce Mitchell III, Vadim Zeitlin

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

-// Copyright:   (c) 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_
 

+// 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
+

 #if wxUSE_DISPLAY
 #if wxUSE_DISPLAY

+    #include "wx/dynarray.h"
+    #include "wx/vidmode.h"
+
+    WX_DECLARE_EXPORTED_OBJARRAY(wxVideoMode, wxArrayVideoModes);
+
+    // default, uninitialized, video mode object
+    extern WXDLLEXPORT_DATA(const wxVideoMode) wxDefaultVideoMode;
+#endif // wxUSE_DISPLAY

 
 

-#ifdef __GNUG__
-    #pragma interface "display.h"
-#endif
+class WXDLLEXPORT wxWindow;
+class WXDLLEXPORT wxPoint;
+class WXDLLEXPORT wxRect;
+class WXDLLIMPEXP_BASE wxString;

 
 

-class wxPoint;
-class wxRect;
-class wxString;
+class WXDLLEXPORT wxDisplayFactory;
+class WXDLLEXPORT wxDisplayImpl;

 
 

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

 {
 public:
     // initialize the object containing all information about the given
     // display
 {
 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"));
-    }
+    //
+    // the displays are numbered from 0 to GetCount() - 1, 0 is always the
+    // primary display and the only one which is always supported
+    wxDisplay(unsigned n = 0);
+
+    // dtor is not virtual as this is a concrete class not meant to be derived
+    // from
+    ~wxDisplay();

 
 

-    // accessors

 
     // 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 -1 if
+    // find the display where the given point lies, return wxNOT_FOUND if

     // it doesn't belong to any display
     // 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; }
+    // return true if the object was initialized successfully
+    bool IsOk() const { return m_impl != NULL; }

 
 

-    // some people never learn to spell ;-)
-    bool IsColor() const { return IsColour(); }
+    // get the full display size
+    wxRect GetGeometry() const;
+
+    // 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;

 
 

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

 
 
 
 

-    virtual ~wxDisplayBase() {}
+#if wxUSE_DISPLAY
+    // 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
+    wxArrayVideoModes
+        GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;
+
+    // get current video mode
+    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
+    bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode);
+
+    // restore the default video mode (just a more readable synonym)
+    void ResetMode() { (void)ChangeMode(); }
+#endif // wxUSE_DISPLAY

 
 

-protected:
-    size_t m_index; // which display did we select when creating this file?
+private:
+    // returns the factory used to implement our static methods and create new
+    // displays
+    static wxDisplayFactory& Factory();

 
 

-    DECLARE_NO_COPY_CLASS(wxDisplayBase);
-};
+    // 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();

 
 

-#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
+    // the real implementation
+    wxDisplayImpl *m_impl;
+
+
+    DECLARE_NO_COPY_CLASS(wxDisplay)
+};

 
 #endif // _WX_DISPLAY_H_BASE_
 
 #endif // _WX_DISPLAY_H_BASE_