#include <qoffscreenintegration.h>

Inheritance diagram for QOffscreenIntegration:

Collaboration diagram for QOffscreenIntegration:

Public Member Functions
	QOffscreenIntegration (const QStringList &paramList)
	~QOffscreenIntegration ()
QJsonObject	defaultConfiguration () const
std::optional< QJsonObject >	resolveConfigFileConfiguration (const QStringList &paramList) const
void	setConfiguration (const QJsonObject &configuration)
QJsonObject	configuration () const
void	initialize () override
	Performs initialization steps that depend on having an event dispatcher available.
bool	hasCapability (QPlatformIntegration::Capability cap) const override
QPlatformWindow *	createPlatformWindow (QWindow *window) const override
	Factory function for QPlatformWindow.
QPlatformBackingStore *	createPlatformBackingStore (QWindow *window) const override
	Factory function for QPlatformBackingStore.
QPlatformInputContext *	inputContext () const override
	Returns the platforms input context.
QPlatformServices *	services () const override
QPlatformFontDatabase *	fontDatabase () const override
	Accessor for the platform integration's fontdatabase.
QAbstractEventDispatcher *	createEventDispatcher () const override
	Factory function for the GUI event dispatcher.
QPlatformNativeInterface *	nativeInterface () const override
QStringList	themeNames () const override
QPlatformTheme *	createPlatformTheme (const QString &name) const override
QList< QOffscreenScreen * >	screens () const
Public Member Functions inherited from QPlatformIntegration
virtual	~QPlatformIntegration ()
virtual QPlatformPixmap *	createPlatformPixmap (QPlatformPixmap::PixelType type) const
	Factory function for QPlatformPixmap.
virtual QPlatformWindow *	createForeignWindow (QWindow *, WId) const
virtual QPlatformOpenGLContext *	createPlatformOpenGLContext (QOpenGLContext *context) const
	Factory function for QPlatformOpenGLContext.
virtual QPlatformSharedGraphicsCache *	createPlatformSharedGraphicsCache (const char *cacheId) const
	Factory function for QPlatformSharedGraphicsCache.
virtual QPaintEngine *	createImagePaintEngine (QPaintDevice *paintDevice) const
	Factory function for QPaintEngine.
virtual void	destroy ()
	Called before the platform integration is deleted.
virtual QPlatformClipboard *	clipboard () const
	Accessor for the platform integration's clipboard.
virtual QVariant	styleHint (StyleHint hint) const
virtual Qt::WindowState	defaultWindowState (Qt::WindowFlags) const
virtual QPlatformKeyMapper *	keyMapper () const
	Accessor for the platform integration's key mapper.
virtual QPlatformOffscreenSurface *	createPlatformOffscreenSurface (QOffscreenSurface *surface) const
	Factory function for QOffscreenSurface.
virtual QPlatformSessionManager *	createPlatformSessionManager (const QString &id, const QString &key) const
virtual void	sync ()
virtual QOpenGLContext::OpenGLModuleType	openGLModuleType ()
	Platform integration function for querying the OpenGL implementation type.
virtual void	setApplicationIcon (const QIcon &icon) const
virtual void	setApplicationBadge (qint64 number)
virtual void	beep () const
virtual void	quit () const
template<auto func, typename... Args>
auto	call (Args... args)

Static Public Member Functions
static QOffscreenIntegration *	createOffscreenIntegration (const QStringList &paramList)

Protected Attributes
QScopedPointer< QPlatformFontDatabase >	m_fontDatabase
QScopedPointer< QPlatformInputContext >	m_inputContext
QScopedPointer< QPlatformServices >	m_services
QScopedPointer< QPlatformNativeInterface >	m_nativeInterface
QList< QOffscreenScreen * >	m_screens
bool	m_windowFrameMarginsEnabled = true
QJsonObject	m_configuration

Additional Inherited Members
Public Types inherited from QPlatformIntegration
enum	Capability { ThreadedPixmaps = 1 , OpenGL , ThreadedOpenGL , SharedGraphicsCache , BufferQueueingOpenGL , WindowMasks , MultipleWindows , ApplicationState , ForeignWindows , NonFullScreenWindows , NativeWidgets , WindowManagement , WindowActivation , SyncState , AllGLFunctionsQueryable , ApplicationIcon , SwitchableWidgetComposition , TopStackedNativeChildWindows , OpenGLOnRasterSurface , MaximizeUsingFullscreenGeometry , PaintEvents , RhiBasedRendering , ScreenWindowGrabbing , BackingStoreStaticContents }
	Capabilities are used to determine specific features of a platform integration. More...
enum	StyleHint { CursorFlashTime , KeyboardInputInterval , MouseDoubleClickInterval , StartDragDistance , StartDragTime , KeyboardAutoRepeatRate , ShowIsFullScreen , PasswordMaskDelay , FontSmoothingGamma , StartDragVelocity , UseRtlExtensions , PasswordMaskCharacter , SetFocusOnTouchRelease , ShowIsMaximized , MousePressAndHoldInterval , TabFocusBehavior , ReplayMousePressOutsidePopup , ItemViewActivateItemOnSingleClick , UiEffects , WheelScrollLines , ShowShortcutsInContextMenus , MouseQuickSelectionThreshold , MouseDoubleClickDistance , FlickStartDistance , FlickMaximumVelocity , FlickDeceleration , UnderlineShortcut }
Protected Member Functions inherited from QPlatformIntegration
virtual Qt::KeyboardModifiers	queryKeyboardModifiers () const
virtual QList< int >	possibleKeys (const QKeyEvent *) const
	Should be used to obtain a list of possible shortcuts for the given key event.
	QPlatformIntegration ()=default

Detailed Description

Definition at line 18 of file qoffscreenintegration.h.

Constructor & Destructor Documentation

◆ QOffscreenIntegration()

QOffscreenIntegration::QOffscreenIntegration ( const QStringList & paramList )

Definition at line 62 of file qoffscreenintegration.cpp.

◆ ~QOffscreenIntegration()

QOffscreenIntegration::~QOffscreenIntegration ( )

Definition at line 82 of file qoffscreenintegration.cpp.

Member Function Documentation

◆ configuration()

QJsonObject QOffscreenIntegration::configuration ( ) const

Definition at line 304 of file qoffscreenintegration.cpp.

◆ createEventDispatcher()

QAbstractEventDispatcher * QOffscreenIntegration::createEventDispatcher ( ) const

overridevirtual

Factory function for the GUI event dispatcher.

The platform plugin should create and return a QAbstractEventDispatcher subclass when this function is called.

If the platform plugin for some reason creates the event dispatcher outside of this function (for example in the constructor), it needs to handle the case where this function is never called, ensuring that the event dispatcher is still deleted at some point (typically in the destructor).

Note that the platform plugin should never explicitly set the event dispatcher itself, using QCoreApplication::setEventDispatcher(), but let QCoreApplication decide when and which event dispatcher to create.

Since: 5.2

Implements QPlatformIntegration.

Definition at line 342 of file qoffscreenintegration.cpp.

◆ createOffscreenIntegration()

QOffscreenIntegration * QOffscreenIntegration::createOffscreenIntegration ( const QStringList & paramList )

static

Definition at line 425 of file qoffscreenintegration.cpp.

◆ createPlatformBackingStore()

QPlatformBackingStore * QOffscreenIntegration::createPlatformBackingStore ( QWindow * window ) const

overridevirtual

Factory function for QPlatformBackingStore.

The QWindow parameter is a pointer to the top level widget(tlw) the window surface is created for. A QPlatformWindow is always created before the QPlatformBackingStore for tlw where the widget also requires a backing store.

See also: QBackingStore; createPlatformWindow()

Implements QPlatformIntegration.

Definition at line 337 of file qoffscreenintegration.cpp.

◆ createPlatformTheme()

QPlatformTheme * QOffscreenIntegration::createPlatformTheme ( const QString & name ) const

overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 400 of file qoffscreenintegration.cpp.

◆ createPlatformWindow()

QPlatformWindow * QOffscreenIntegration::createPlatformWindow ( QWindow * window ) const

overridevirtual

Factory function for QPlatformWindow.

The window parameter is a pointer to the window which the QPlatformWindow is supposed to be created for.

All windows have to have a QPlatformWindow, and it will be created on-demand when the QWindow is made visible for the first time, or explicitly through calling QWindow::create().

In the constructor, of the QPlatformWindow, the window flags, state, title and geometry of the window should be applied to the underlying window. If the resulting flags or state differs, the resulting values should be set on the window using QWindow::setWindowFlags() or QWindow::setWindowState(), respectively.

See also: QPlatformWindow, QPlatformWindowFormat; createPlatformBackingStore()

Implements QPlatformIntegration.

Definition at line 329 of file qoffscreenintegration.cpp.

References m_windowFrameMarginsEnabled.

◆ defaultConfiguration()

QJsonObject QOffscreenIntegration::defaultConfiguration ( ) const

Definition at line 118 of file qoffscreenintegration.cpp.

◆ fontDatabase()

QPlatformFontDatabase * QOffscreenIntegration::fontDatabase ( ) const

overridevirtual

Accessor for the platform integration's fontdatabase.

Default implementation returns a default QPlatformFontDatabase.

See also: QPlatformFontDatabase

Reimplemented from QPlatformIntegration.

Definition at line 405 of file qoffscreenintegration.cpp.

◆ hasCapability()

bool QOffscreenIntegration::hasCapability ( QPlatformIntegration::Capability cap ) const

overridevirtual

Reimplemented from QPlatformIntegration.

Reimplemented in QOffscreenX11Integration.

Definition at line 319 of file qoffscreenintegration.cpp.

◆ initialize()

void QOffscreenIntegration::initialize ( )

overridevirtual

Performs initialization steps that depend on having an event dispatcher available.

Called after the event dispatcher has been created.

Tasks that require an event dispatcher, for example creating socket notifiers, cannot be performed in the constructor. Instead, they should be performed here. The default implementation does nothing.

Reimplemented from QPlatformIntegration.

Definition at line 309 of file qoffscreenintegration.cpp.

◆ inputContext()

QPlatformInputContext * QOffscreenIntegration::inputContext ( ) const

overridevirtual

Returns the platforms input context.

The default implementation returns \nullptr, implying no input method support.

Reimplemented from QPlatformIntegration.

Definition at line 314 of file qoffscreenintegration.cpp.

◆ nativeInterface()

QPlatformNativeInterface * QOffscreenIntegration::nativeInterface ( ) const

overridevirtual

Reimplemented from QPlatformIntegration.

Reimplemented in QOffscreenX11Integration.

Definition at line 353 of file qoffscreenintegration.cpp.

◆ resolveConfigFileConfiguration()

std::optional< QJsonObject > QOffscreenIntegration::resolveConfigFileConfiguration ( const QStringList & paramList ) const

Definition at line 138 of file qoffscreenintegration.cpp.

◆ screens()

QList< QOffscreenScreen * > QOffscreenIntegration::screens ( ) const

Definition at line 440 of file qoffscreenintegration.cpp.

◆ services()

QPlatformServices * QOffscreenIntegration::services ( ) const

overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 417 of file qoffscreenintegration.cpp.

◆ setConfiguration()

void QOffscreenIntegration::setConfiguration ( const QJsonObject & configuration )

Definition at line 172 of file qoffscreenintegration.cpp.

◆ themeNames()

QStringList QOffscreenIntegration::themeNames ( ) const

overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 362 of file qoffscreenintegration.cpp.

Member Data Documentation

◆ m_configuration

QJsonObject QOffscreenIntegration::m_configuration

protected

Definition at line 62 of file qoffscreenintegration.h.

◆ m_fontDatabase

QScopedPointer<QPlatformFontDatabase> QOffscreenIntegration::m_fontDatabase

protected

Definition at line 53 of file qoffscreenintegration.h.

◆ m_inputContext

QScopedPointer<QPlatformInputContext> QOffscreenIntegration::m_inputContext

protected

Definition at line 57 of file qoffscreenintegration.h.

◆ m_nativeInterface

QScopedPointer<QPlatformNativeInterface> QOffscreenIntegration::m_nativeInterface

mutableprotected

Definition at line 59 of file qoffscreenintegration.h.

◆ m_screens

QList<QOffscreenScreen *> QOffscreenIntegration::m_screens

protected

Definition at line 60 of file qoffscreenintegration.h.

◆ m_services

QScopedPointer<QPlatformServices> QOffscreenIntegration::m_services

mutableprotected

Definition at line 58 of file qoffscreenintegration.h.

◆ m_windowFrameMarginsEnabled

bool QOffscreenIntegration::m_windowFrameMarginsEnabled = true

protected

Definition at line 61 of file qoffscreenintegration.h.

Referenced by createPlatformWindow().

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

qtbase/src/plugins/platforms/offscreen/qoffscreenintegration.h (ff51ea5418d131248b07e327513b41dad1231f37)
qtbase/src/plugins/platforms/offscreen/qoffscreenintegration.cpp (ff51ea5418d131248b07e327513b41dad1231f37)

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QOffscreenIntegration()

◆ ~QOffscreenIntegration()

Member Function Documentation

◆ configuration()

◆ createEventDispatcher()

◆ createOffscreenIntegration()

◆ createPlatformBackingStore()

◆ createPlatformTheme()

◆ createPlatformWindow()

◆ defaultConfiguration()

◆ fontDatabase()

◆ hasCapability()

◆ initialize()

◆ inputContext()

◆ nativeInterface()

◆ resolveConfigFileConfiguration()

◆ screens()

◆ services()

◆ setConfiguration()

◆ themeNames()

Member Data Documentation

◆ m_configuration

◆ m_fontDatabase

◆ m_inputContext

◆ m_nativeInterface

◆ m_screens

◆ m_services

◆ m_windowFrameMarginsEnabled