QWSOnScreenSurface Class Reference

#include <qwindowsurface_qws_p.h>

Inheritance diagram for QWSOnScreenSurface:

Public Functions
bool	isValid () const
	Implement this function to return true if the surface is a valid surface for the given top-level window; otherwise return false. More...
QString	key () const
	Implement this function to return a string that uniquely identifies the class of this surface. More...
QPoint	painterOffset () const
	Returns the offset to be used when painting. More...
QByteArray	permanentState () const
	Implement this function to return the data required for creating a server-side representation of the surface. More...
	QWSOnScreenSurface ()
	QWSOnScreenSurface (QWidget *widget)
void	setPermanentState (const QByteArray &data)
	Implement this function to attach a server-side surface instance to the corresponding client side instance using the given data. More...
	~QWSOnScreenSurface ()
Public Functions inherited from QWSMemorySurface
void	beginPaint (const QRegion &rgn)
	This function is called before painting onto the surface begins, with the region in which the painting will occur. More...
QImage	image () const
	Implement this function to return an image of the top-level window. More...
bool	lock (int timeout=-1)
QPaintDevice *	paintDevice ()
	Implement this function to return the appropriate paint device. More...
	QWSMemorySurface ()
	QWSMemorySurface (QWidget *widget)
bool	scroll (const QRegion &area, int dx, int dy)
	Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative. More...
void	unlock ()
	~QWSMemorySurface ()
Public Functions inherited from QWSWindowSurface
const QRegion	clipRegion () const
	Returns the region currently visible on the screen. More...
virtual void	endPaint (const QRegion &)
	This function is called after painting onto the surface has ended, with the region in which the painting was performed. More...
virtual void	flush (QWidget *widget, const QRegion &region, const QPoint &offset)
	Flushes the given region from the specified widget onto the screen. More...
bool	isBuffered () const
	Returns true if the QWSWindowSurface::Buffered is set; otherwise returns false. More...
bool	isOpaque () const
	Returns true if the QWSWindowSurface::Opaque is set; otherwise returns false. More...
bool	isRegionReserved () const
	Returns true if the QWSWindowSurface::RegionReserved is set; otherwise returns false. More...
virtual bool	move (const QPoint &offset)
	Move the surface with the given offset. More...
virtual QRegion	move (const QPoint &offset, const QRegion &newClip)
	Move the surface with the given offset. More...
	QWSWindowSurface ()
	Constructs an empty surface. More...
	QWSWindowSurface (QWidget *widget)
	Constructs an empty surface for the given top-level widget. More...
virtual void	releaseSurface ()
void	setClipRegion (const QRegion &)
	Sets the region currently visible on the screen to be the given clip region. More...
virtual void	setGeometry (const QRect &rect)
	Sets the currently allocated area to be the given rect. More...
virtual void	setGeometry (const QRect &rect, const QRegion &mask)
virtual void	setTransientState (const QByteArray &state)
SurfaceFlags	surfaceFlags () const
	Returns the surface flags describing the contents of this surface. More...
virtual QByteArray	transientState () const
int	winId () const
	~QWSWindowSurface ()
Public Functions inherited from QWindowSurface
virtual QImage *	buffer (const QWidget *widget)
	Returns a QImage pointer which represents the actual buffer the widget is drawn into or 0 if this is unavailable. More...
virtual WindowSurfaceFeatures	features () const
QRect	geometry () const
	Returns the currently allocated area on the screen. More...
virtual QPixmap	grabWidget (const QWidget *widget, const QRect &rectangle=QRect()) const
	Returns a QPixmap generated from the part of the backing store corresponding to widget. More...
bool	hasFeature (WindowSurfaceFeature feature) const
virtual QPoint	offset (const QWidget *widget) const
	Returns the offset of widget in the coordinates of this window surface. More...
	QWindowSurface (QWidget *window, bool setDefaultSurface=true)
	Constructs an empty surface for the given top-level window. More...
QRect	rect (const QWidget *widget) const
	Returns the rectangle for widget in the coordinates of this window surface. More...
void	setStaticContents (const QRegion &region)
QRegion	staticContents () const
QWidget *	window () const
	Returns a pointer to the top-level window associated with this surface. More...
virtual	~QWindowSurface ()
	Destroys this surface. More...

Private Functions
void	attachToScreen (const QScreen *screen)

Properties
const QScreen *	screen

Additional Inherited Members
Public Types inherited from QWSWindowSurface
enum	SurfaceFlag { RegionReserved = 0x1, Buffered = 0x2, Opaque = 0x4 }
	This enum is used to describe the window surface's contents. More...
Public Types inherited from QWindowSurface
enum	WindowSurfaceFeature { PartialUpdates = 0x00000001, PreservedContents = 0x00000002, StaticContents = 0x00000004, AllFeatures = 0xffffffff }
Protected Functions inherited from QWSMemorySurface
QImage::Format	preferredImageFormat (const QWidget *widget) const
void	setLock (int lockId)
Protected Functions inherited from QWSWindowSurface
void	setSurfaceFlags (SurfaceFlags type)
	Sets the surface flags describing the contents of this surface, to be the given flags. More...
void	setWinId (int id)
Protected Functions inherited from QWindowSurface
bool	hasStaticContents () const
Protected Variables inherited from QWSMemorySurface
QImage	img
QWSLock *	memlock
QMutex	threadLock

Detailed Description

Definition at line 246 of file qwindowsurface_qws_p.h.

Constructors and Destructors

QWSOnScreenSurface() [1/2]

QWSOnScreenSurface::QWSOnScreenSurface

(

)

Definition at line 1225 of file qwindowsurface_qws.cpp.

    : QWSMemorySurface()
{
    setSurfaceFlags(Opaque);
}

QWSOnScreenSurface() [2/2]

QWSOnScreenSurface::QWSOnScreenSurface

(

QWidget *

widget

)

Definition at line 1218 of file qwindowsurface_qws.cpp.

    : QWSMemorySurface(w)
{
    attachToScreen(getScreen(w));
    setSurfaceFlags(Opaque);
}

~QWSOnScreenSurface()

QWSOnScreenSurface::~QWSOnScreenSurface

(

)

Definition at line 1247 of file qwindowsurface_qws.cpp.

{
}

Functions

attachToScreen()

void QWSOnScreenSurface::attachToScreen ( const QScreen *  screen )

private

Definition at line 1231 of file qwindowsurface_qws.cpp.

Referenced by QWSOnScreenSurface(), and setPermanentState().

{
    screen = s;
    uchar *base = screen->base();
    QImage::Format format  = screen->pixelFormat();

    if (format == QImage::Format_Invalid || format == QImage::Format_Indexed8) {
        //### currently we have no paint engine for indexed image formats
        qFatal("QWSOnScreenSurface::attachToScreen(): screen depth %d "
               "not implemented", screen->depth());
        return;
    }
    QWSMemorySurface::img = QImage(base, screen->width(), screen->height(),
                                   screen->linestep(), format );
}

isValid()

bool QWSOnScreenSurface::isValid ( ) const

virtual

Implement this function to return true if the surface is a valid surface for the given top-level window; otherwise return false.

Since

4.3

See also

window(), key()

Reimplemented from QWSMemorySurface.

Definition at line 1256 of file qwindowsurface_qws.cpp.

{
    const QWidget *win = window();
    if (screen != getScreen(win))
        return false;
    if (img.isNull())
        return false;
    return QScreen::isWidgetPaintOnScreen(win);
}

key()

QString QWSOnScreenSurface::key ( ) const

inlinevirtual

Implement this function to return a string that uniquely identifies the class of this surface.

See also

window(), isValid()

Implements QWSWindowSurface.

Definition at line 256 of file qwindowsurface_qws_p.h.

{ return QLatin1String("OnScreen"); }

painterOffset()

QPoint QWSOnScreenSurface::painterOffset ( ) const

virtual

Returns the offset to be used when painting.

See also

paintDevice()

Reimplemented from QWSMemorySurface.

Definition at line 1251 of file qwindowsurface_qws.cpp.

{
    return geometry().topLeft() + QWSWindowSurface::painterOffset();
}

permanentState()

QByteArray QWSOnScreenSurface::permanentState ( ) const

virtual

Implement this function to return the data required for creating a server-side representation of the surface.

Since

4.3

See also

attach()

Reimplemented from QWSWindowSurface.

Definition at line 1266 of file qwindowsurface_qws.cpp.

{
    QByteArray array(sizeof(int), Qt::Uninitialized);

    int *ptr = reinterpret_cast<int*>(array.data());
    ptr[0] = QApplication::desktop()->screenNumber(window());
    return array;
}

setPermanentState()

void QWSOnScreenSurface::setPermanentState ( const QByteArray &  data )

virtual

Implement this function to attach a server-side surface instance to the corresponding client side instance using the given data.

Since

4.3

Return true if successful; otherwise return false.

See also

data()

Reimplemented from QWSWindowSurface.

Definition at line 1275 of file qwindowsurface_qws.cpp.

{
    const int *ptr = reinterpret_cast<const int*>(data.constData());
    const int screenNo = ptr[0];

    QScreen *screen = qt_screen;
    if (screenNo > 0)
        screen = qt_screen->subScreens().at(screenNo);
    attachToScreen(screen);
}

Properties

screen

const QScreen* QWSOnScreenSurface::screen

private

Definition at line 264 of file qwindowsurface_qws_p.h.

Referenced by attachToScreen(), isValid(), and setPermanentState().

---

The documentation for this class was generated from the following files:

• /src/gui/painting/qwindowsurface_qws_p.h
• /src/gui/painting/qwindowsurface_qws.cpp