QPaintDeviceWindow Class Reference

Convenience subclass of QWindow that is also a QPaintDevice. More...

#include <qpaintdevicewindow.h>

Inheritance diagram for QPaintDeviceWindow:

Collaboration diagram for QPaintDeviceWindow:

Public Slots
void	update ()
Public Slots inherited from QWindow
	Q_REVISION (2, 1) void requestActivate()
void	setVisible (bool visible)
void	show ()
void	hide ()
void	showMinimized ()
void	showMaximized ()
void	showFullScreen ()
void	showNormal ()
bool	close ()
void	raise ()
void	lower ()
bool	startSystemResize (Qt::Edges edges)
	Start a system-specific resize operation. More...
bool	startSystemMove ()
	Start a system-specific move operation. More...
void	setTitle (const QString &)
void	setX (int arg)
void	setY (int arg)
void	setWidth (int arg)
void	setHeight (int arg)
void	setGeometry (int posx, int posy, int w, int h)
void	setGeometry (const QRect &rect)
	Sets the geometry of the window, excluding its window frame, to rect. More...
void	setMinimumWidth (int w)
void	setMinimumHeight (int h)
void	setMaximumWidth (int w)
void	setMaximumHeight (int h)
	Q_REVISION (2, 1) void alert(int msec)
	Q_REVISION (2, 3) void requestUpdate()
Public Slots inherited from QObject
void	deleteLater ()

Public Member Functions
void	update (const QRect &rect)
void	update (const QRegion &region)
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
virtual	~QObject ()
virtual bool	eventFilter (QObject *watched, QEvent *event)
QString	objectName () const
void	setObjectName (const QString &name)
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
bool	isWindowType () const
bool	signalsBlocked () const noexcept
bool	blockSignals (bool b) noexcept
QThread *	thread () const
void	moveToThread (QThread *thread)
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
const QObjectList &	children () const
void	setParent (QObject *parent)
void	installEventFilter (QObject *filterObj)
void	removeEventFilter (QObject *obj)
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject *receiver, const char *member=nullptr) const
void	dumpObjectTree () const
void	dumpObjectInfo () const
bool	setProperty (const char *name, const QVariant &value)
QVariant	property (const char *name) const
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
bool	inherits (const char *classname) const
Public Member Functions inherited from QSurface
virtual	~QSurface ()
SurfaceClass	surfaceClass () const
virtual QPlatformSurface *	surfaceHandle () const =0
bool	supportsOpenGL () const
Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()
virtual int	devType () const
bool	paintingActive () const
int	width () const
int	height () const
int	widthMM () const
int	heightMM () const
int	logicalDpiX () const
int	logicalDpiY () const
int	physicalDpiX () const
int	physicalDpiY () const
qreal	devicePixelRatio () const
qreal	devicePixelRatioF () const
int	colorCount () const
int	depth () const

Protected Member Functions
void	exposeEvent (QExposeEvent *) override
void	paintEvent (QPaintEvent *event) override
int	metric (PaintDeviceMetric metric) const override
bool	event (QEvent *event) override
	QPaintDeviceWindow (QPaintDeviceWindowPrivate &dd, QWindow *parent)
Protected Member Functions inherited from QWindow
virtual void	resizeEvent (QResizeEvent *)
virtual void	moveEvent (QMoveEvent *)
virtual void	focusInEvent (QFocusEvent *)
virtual void	focusOutEvent (QFocusEvent *)
virtual void	showEvent (QShowEvent *)
virtual void	hideEvent (QHideEvent *)
virtual void	closeEvent (QCloseEvent *)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	keyReleaseEvent (QKeyEvent *)
virtual void	mousePressEvent (QMouseEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
virtual void	mouseDoubleClickEvent (QMouseEvent *)
virtual void	mouseMoveEvent (QMouseEvent *)
virtual void	touchEvent (QTouchEvent *)
virtual bool	nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
	QWindow (QWindowPrivate &dd, QWindow *parent)
Protected Member Functions inherited from QObject
QObject *	sender () const
int	senderSignalIndex () const
int	receivers (const char *signal) const
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
virtual void	childEvent (QChildEvent *event)
virtual void	customEvent (QEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Member Functions inherited from QSurface
	QSurface (SurfaceClass type)
Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept
virtual void	initPainter (QPainter *painter) const
virtual QPaintDevice *	redirected (QPoint *offset) const
virtual QPainter *	sharedPainter () const

Properties
int	width
	the width of the window's geometry More...
int	height
	the height of the window's geometry More...
Properties inherited from QWindow
QString	title
	the window's title in the windowing system More...
Qt::WindowModality	modality
	the modality of the window More...
Qt::WindowFlags	flags
	the window flags of the window More...
int	x
	the x position of the window's geometry More...
int	y
	the y position of the window's geometry More...
int	width
	the width of the window's geometry More...
int	height
	the height of the window's geometry More...
int	minimumWidth
	the minimum width of the window's geometry More...
int	minimumHeight
	the minimum height of the window's geometry More...
int	maximumWidth
	the maximum width of the window's geometry More...
int	maximumHeight
	the maximum height of the window's geometry More...
bool	visible
	whether the window is visible or not More...
bool	active
	the active status of the window More...
Visibility	visibility
	the screen-occupation state of the window More...
Qt::ScreenOrientation	contentOrientation
	the orientation of the window's contents More...
qreal	opacity
	The opacity of the window in the windowing system. More...
Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Types inherited from QSurface
enum	SurfaceClass { Window , Offscreen }
enum	SurfaceType {   RasterSurface , OpenGLSurface , RasterGLSurface , OpenVGSurface ,   VulkanSurface , MetalSurface , Direct3DSurface }
Public Types inherited from QPaintDevice
enum	PaintDeviceMetric {   PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,   PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,   PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }
Signals inherited from QWindow
void	screenChanged (QScreen *screen)
void	modalityChanged (Qt::WindowModality modality)
void	windowStateChanged (Qt::WindowState windowState)
	Q_REVISION (2, 2) void windowTitleChanged(const QString &title)
void	xChanged (int arg)
void	yChanged (int arg)
void	widthChanged (int arg)
void	heightChanged (int arg)
void	minimumWidthChanged (int arg)
void	minimumHeightChanged (int arg)
void	maximumWidthChanged (int arg)
void	maximumHeightChanged (int arg)
void	visibleChanged (bool arg)
Q_REVISION(2, 1) void visibilityChanged(QWindow	Q_REVISION (2, 1) void activeChanged()
void	contentOrientationChanged (Qt::ScreenOrientation orientation)
void	focusObjectChanged (QObject *object)
	Q_REVISION (2, 1) void opacityChanged(qreal opacity)
	Q_REVISION (2, 13) void transientParentChanged(QWindow *transientParent)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
void	objectNameChanged (const QString &objectName, QPrivateSignal)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
static QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Protected Attributes inherited from QSurface
SurfaceClass	m_type
QSurfacePrivate *	m_reserved
Protected Attributes inherited from QPaintDevice
ushort	painters
Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList

Detailed Description

Convenience subclass of QWindow that is also a QPaintDevice.

\inmodule QtGui

Since

5.4

QPaintDeviceWindow is like a regular QWindow, with the added functionality of being a paint device too. Whenever the content needs to be updated, the virtual paintEvent() function is called. Subclasses, that reimplement this function, can then simply open a QPainter on the window.

Note

This class cannot directly be used in applications. It rather serves as a base for subclasses like QOpenGLWindow.

See also

QOpenGLWindow

Definition at line 52 of file qpaintdevicewindow.h.

Constructor & Destructor Documentation

QPaintDeviceWindow()

QPaintDeviceWindow::QPaintDeviceWindow ( QPaintDeviceWindowPrivate &  dd, QWindow *  parent  )

protected

Definition at line 218 of file qpaintdevicewindow.cpp.

Member Function Documentation

event()

bool QPaintDeviceWindow::event ( QEvent *  ev )

overrideprotectedvirtual

Override this to handle any event (ev) sent to the window. Return true if the event was recognized and processed.

Remember to call the base class version if you wish for mouse events, key events, resize events, etc to be dispatched as usual.

Reimplemented from QWindow.

Reimplemented in Window, Window, Window, RasterWindow, InputTestWindow, Window, Window, Window, and RasterWindow.

Definition at line 193 of file qpaintdevicewindow.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

exposeEvent()

void QPaintDeviceWindow::exposeEvent ( QExposeEvent *  ev )

overrideprotectedvirtual

The expose event (ev) is sent by the window system when a window moves between the un-exposed and exposed states.

An exposed window is potentially visible to the user. If the window is moved off screen, is made totally obscured by another window, is minimized, or similar, this function might be called and the value of isExposed() might change to false. You may use this event to limit expensive operations such as animations to only run when the window is exposed.

This event should not be used to paint. To handle painting implement paintEvent() instead.

A resize event will always be sent before the expose event the first time a window is shown.

See also

paintEvent(), isExposed()

Reimplemented from QWindow.

Reimplemented in Window, RasterWindow, Window, Window, Window, Window, Window, GLWindow, Window, Window, Window, and RasterWindow.

Definition at line 185 of file qpaintdevicewindow.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

metric()

int QPaintDeviceWindow::metric ( PaintDeviceMetric  metric ) const

overrideprotectedvirtual

Reimplemented from QPaintDevice.

Reimplemented in QOpenGLWindow, and QRasterWindow.

Definition at line 134 of file qpaintdevicewindow.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

paintEvent()

void QPaintDeviceWindow::paintEvent ( QPaintEvent *  event )

overrideprotectedvirtual

Handles paint events passed in the event parameter.

The default implementation does nothing. Reimplement this function to perform painting. If necessary, the dirty area is retrievable from the event.

Reimplemented from QWindow.

Reimplemented in Window, ColoredWindow, QOpenGLWindow, EventPosterWindow, ClickWindow, ClickWindow, ClickWindow, CursorWindow, CursorWindow, ItemWindow, PaintWindow, ColoredWindow, PainterWindow, Window, QWindowsDragCursorWindow, QShapedPixmapWindow, and RasterWindow.

Definition at line 125 of file qpaintdevicewindow.cpp.

Here is the call graph for this function:

update [1/3]

void QPaintDeviceWindow::update ( )

slot

Marks the entire window as dirty and schedules a repaint.

Note

Subsequent calls to this function before the next paint event will get ignored.

For non-exposed windows the update is deferred until the window becomes exposed again.

Definition at line 79 of file qpaintdevicewindow.cpp.

Here is the caller graph for this function:

update() [2/3]

void QPaintDeviceWindow::update

(

const QRect &

rect

)

Marks the rect of the window as dirty and schedules a repaint.

Note

Subsequent calls to this function before the next paint event will get ignored, but rect is added to the region to update.

For non-exposed windows the update is deferred until the window becomes exposed again.

Definition at line 93 of file qpaintdevicewindow.cpp.

Here is the caller graph for this function:

update() [3/3]

void QPaintDeviceWindow::update

(

const QRegion &

region

)

Marks the region of the window as dirty and schedules a repaint.

Note

Subsequent calls to this function before the next paint event will get ignored, but region is added to the region to update.

For non-exposed windows the update is deferred until the window becomes exposed again.

Definition at line 110 of file qpaintdevicewindow.cpp.

Here is the caller graph for this function:

Property Documentation

height

QWindow::height

readwrite

the height of the window's geometry

Definition at line 419 of file qwindow.h.

width

QWindow::width

readwrite

the width of the window's geometry

Definition at line 419 of file qwindow.h.

---

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

• src/gui/kernel/qpaintdevicewindow.h
• src/gui/kernel/qpaintdevicewindow.cpp