2002-07-19 16:42:34 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2003-03-02 09:16:29 -05:00
|
|
|
// Name: wx/display.h
|
2002-07-19 16:42:34 -04:00
|
|
|
// Purpose: wxDisplay class
|
|
|
|
// Author: Royce Mitchell III
|
2003-03-02 09:16:29 -05:00
|
|
|
// Modified by: Vadim Zeitlin (resolution changes, display modes, ...)
|
2002-07-19 16:42:34 -04:00
|
|
|
// Created: 06/21/02
|
|
|
|
// RCS-ID: $Id$
|
2003-03-02 09:16:29 -05:00
|
|
|
// Copyright: (c) 2002-2003 wxWindows team
|
2002-07-19 16:42:34 -04:00
|
|
|
// Licence: wxWindows licence
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_DISPLAY_H_BASE_
|
|
|
|
#define _WX_DISPLAY_H_BASE_
|
|
|
|
|
|
|
|
#if wxUSE_DISPLAY
|
|
|
|
|
2003-08-09 08:38:21 -04:00
|
|
|
#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
|
2003-03-02 09:16:29 -05:00
|
|
|
#pragma interface "displaybase.h"
|
2002-07-19 16:42:34 -04:00
|
|
|
#endif
|
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
#include "wx/dynarray.h"
|
|
|
|
|
2003-04-29 18:39:02 -04:00
|
|
|
class WXDLLEXPORT wxWindow;
|
2003-09-27 08:36:30 -04:00
|
|
|
class WXDLLEXPORT wxPoint;
|
|
|
|
class WXDLLEXPORT wxRect;
|
|
|
|
class WXDLLEXPORT wxString;
|
2003-04-29 18:39:02 -04:00
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxVideoMode: contains video mode parameters for a display
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
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;
|
|
|
|
};
|
|
|
|
|
|
|
|
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
|
|
|
|
// ----------------------------------------------------------------------------
|
2002-07-19 16:42:34 -04:00
|
|
|
|
|
|
|
class WXDLLEXPORT wxDisplayBase
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// initialize the object containing all information about the given
|
|
|
|
// display
|
2003-03-02 09:16:29 -05:00
|
|
|
//
|
|
|
|
// 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);
|
2002-07-19 16:42:34 -04:00
|
|
|
|
|
|
|
// return the number of available displays, valid parameters to
|
|
|
|
// wxDisplay ctor are from 0 up to this number
|
|
|
|
static size_t GetCount();
|
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// find the display where the given point lies, return wxNOT_FOUND if
|
2002-07-19 16:42:34 -04:00
|
|
|
// it doesn't belong to any display
|
2003-03-02 09:16:29 -05:00
|
|
|
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);
|
2002-07-19 16:42:34 -04:00
|
|
|
|
|
|
|
|
2003-04-06 20:30:18 -04:00
|
|
|
// return true if the object was initialized successfully
|
|
|
|
virtual bool IsOk() const { return true; }
|
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// get the display size
|
|
|
|
virtual wxRect GetGeometry() const = 0;
|
2002-07-19 16:42:34 -04:00
|
|
|
|
|
|
|
// name may be empty
|
|
|
|
virtual wxString GetName() const = 0;
|
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// display 0 is always the primary display
|
|
|
|
bool IsPrimary() const { return m_index == 0; }
|
|
|
|
|
2002-07-19 16:42:34 -04:00
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// 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;
|
2002-07-19 16:42:34 -04:00
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
// get current video mode
|
|
|
|
virtual wxVideoMode GetCurrentMode() const = 0;
|
|
|
|
|
|
|
|
// 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() { }
|
2002-07-19 16:42:34 -04:00
|
|
|
|
|
|
|
protected:
|
2003-03-02 09:16:29 -05:00
|
|
|
// the index of this display (0 is always the primary one)
|
|
|
|
size_t m_index;
|
2002-07-19 16:42:34 -04:00
|
|
|
|
2003-07-06 17:33:35 -04:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDisplayBase)
|
2002-07-19 16:42:34 -04:00
|
|
|
};
|
|
|
|
|
2003-03-02 09:16:29 -05:00
|
|
|
|
2002-07-19 16:42:34 -04:00
|
|
|
#if defined(__WXMSW__)
|
|
|
|
#include "wx/msw/display.h"
|
|
|
|
#elif defined(__WXMOTIF__)
|
2003-08-03 16:12:57 -04:00
|
|
|
#include "wx/unix/displayx11.h"
|
2002-07-19 16:42:34 -04:00
|
|
|
#elif defined(__WXGTK__)
|
2003-06-01 12:03:24 -04:00
|
|
|
#include "wx/unix/displayx11.h"
|
2002-07-19 16:42:34 -04:00
|
|
|
#elif defined(__WXMAC__)
|
|
|
|
#include "wx/mac/display.h"
|
|
|
|
#elif defined(__WXPM__)
|
|
|
|
#include "wx/os2/display.h"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif // wxUSE_DISPLAY
|
|
|
|
|
|
|
|
#endif // _WX_DISPLAY_H_BASE_
|