Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QXcbIntegration Class Reference

#include <qxcbintegration.h>

Inheritance diagram for QXcbIntegration:
Collaboration diagram for QXcbIntegration:

Public Member Functions

 QXcbIntegration (const QStringList &parameters, int &argc, char **argv)
 ~QXcbIntegration ()
QPlatformPixmapcreatePlatformPixmap (QPlatformPixmap::PixelType type) const override
 Factory function for QPlatformPixmap.
QPlatformWindowcreatePlatformWindow (QWindow *window) const override
 Factory function for QPlatformWindow.
QPlatformWindowcreateForeignWindow (QWindow *window, WId nativeHandle) const override
QPlatformOpenGLContextcreatePlatformOpenGLContext (QOpenGLContext *context) const override
 Factory function for QPlatformOpenGLContext.
QPlatformBackingStorecreatePlatformBackingStore (QWindow *window) const override
 Factory function for QPlatformBackingStore.
QPlatformOffscreenSurfacecreatePlatformOffscreenSurface (QOffscreenSurface *surface) const override
 Factory function for QOffscreenSurface.
bool hasCapability (Capability cap) const override
QAbstractEventDispatchercreateEventDispatcher () const override
 Factory function for the GUI event dispatcher.
void initialize () override
 Performs initialization steps that depend on having an event dispatcher available.
void moveToScreen (QWindow *window, int screen)
QPlatformFontDatabasefontDatabase () const override
 Accessor for the platform integration's fontdatabase.
QPlatformNativeInterfacenativeInterface () const override
QPlatformClipboardclipboard () const override
 Accessor for the platform integration's clipboard.
QPlatformInputContextinputContext () const override
 Returns the platforms input context.
QPlatformServicesservices () const override
QPlatformKeyMapperkeyMapper () const override
 Accessor for the platform integration's key mapper.
QStringList themeNames () const override
QPlatformThemecreatePlatformTheme (const QString &name) const override
QVariant styleHint (StyleHint hint) const override
bool hasConnection () const
QXcbConnectionconnection () const
QByteArray wmClass () const
void sync () override
void beep () const override
bool nativePaintingEnabled () const
void setApplicationBadge (qint64 number) override
Public Member Functions inherited from QPlatformIntegration
virtual ~QPlatformIntegration ()
virtual QPlatformSharedGraphicsCachecreatePlatformSharedGraphicsCache (const char *cacheId) const
 Factory function for QPlatformSharedGraphicsCache.
virtual QPaintEnginecreateImagePaintEngine (QPaintDevice *paintDevice) const
 Factory function for QPaintEngine.
virtual void destroy ()
 Called before the platform integration is deleted.
virtual Qt::WindowState defaultWindowState (Qt::WindowFlags) const
virtual QPlatformSessionManagercreatePlatformSessionManager (const QString &id, const QString &key) const
virtual QOpenGLContext::OpenGLModuleType openGLModuleType ()
 Platform integration function for querying the OpenGL implementation type.
virtual void setApplicationIcon (const QIcon &icon) const
virtual void quit () const
template<auto func, typename... Args>
auto call (Args... args)

Static Public Member Functions

static QXcbIntegrationinstance ()

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 23 of file qxcbintegration.h.

Constructor & Destructor Documentation

◆ QXcbIntegration()

QXcbIntegration::QXcbIntegration ( const QStringList & parameters,
int & argc,
char ** argv )

Definition at line 111 of file qxcbintegration.cpp.

◆ ~QXcbIntegration()

QXcbIntegration::~QXcbIntegration ( )

Definition at line 192 of file qxcbintegration.cpp.

Member Function Documentation

◆ beep()

void QXcbIntegration::beep ( ) const
overridevirtual
Since
5.7

Should sound a bell, using the default volume and sound.

See also
QApplication::beep()

Reimplemented from QPlatformIntegration.

Definition at line 566 of file qxcbintegration.cpp.

◆ clipboard()

QPlatformClipboard * QXcbIntegration::clipboard ( ) const
overridevirtual

Accessor for the platform integration's clipboard.

Default implementation returns a default QPlatformClipboard.

See also
QPlatformClipboard

Reimplemented from QPlatformIntegration.

Definition at line 389 of file qxcbintegration.cpp.

◆ connection()

QXcbConnection * QXcbIntegration::connection ( ) const
inline

Definition at line 85 of file qxcbintegration.h.

◆ createEventDispatcher()

QAbstractEventDispatcher * QXcbIntegration::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 334 of file qxcbintegration.cpp.

◆ createForeignWindow()

QPlatformWindow * QXcbIntegration::createForeignWindow ( QWindow * window,
WId nativeHandle ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 237 of file qxcbintegration.cpp.

◆ createPlatformBackingStore()

QPlatformBackingStore * QXcbIntegration::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 277 of file qxcbintegration.cpp.

◆ createPlatformOffscreenSurface()

QPlatformOffscreenSurface * QXcbIntegration::createPlatformOffscreenSurface ( QOffscreenSurface * surface) const
overridevirtual

Factory function for QOffscreenSurface.

An offscreen surface will typically be implemented with a pixel buffer (pbuffer). If the platform doesn't support offscreen surfaces, an invisible window will be used by QOffscreenSurface instead.

Reimplemented from QPlatformIntegration.

Definition at line 295 of file qxcbintegration.cpp.

◆ createPlatformOpenGLContext()

QPlatformOpenGLContext * QXcbIntegration::createPlatformOpenGLContext ( QOpenGLContext * context) const
overridevirtual

Factory function for QPlatformOpenGLContext.

The context parameter is a pointer to the context for which a platform-specific context backend needs to be created. Configuration settings like the format, share context and screen have to be taken from this QOpenGLContext and the resulting platform context is expected to be backed by a native context that fulfills these criteria.

If the context has native handles set, no new native context is expected to be created. Instead, the provided handles have to be used. In this case the ownership of the handle must not be taken and the platform implementation is not allowed to destroy the native context. Configuration parameters like the format are also to be ignored. Instead, the platform implementation is responsible for querying the configuriation from the provided native context.

Returns a pointer to a QPlatformOpenGLContext instance or \nullptr if the context could not be created.

See also
QOpenGLContext

Reimplemented from QPlatformIntegration.

Definition at line 243 of file qxcbintegration.cpp.

◆ createPlatformPixmap()

QPlatformPixmap * QXcbIntegration::createPlatformPixmap ( QPlatformPixmap::PixelType type) const
overridevirtual

Factory function for QPlatformPixmap.

PixelType can be either PixmapType or BitmapType.

See also
QPlatformPixmap

Reimplemented from QPlatformIntegration.

Definition at line 199 of file qxcbintegration.cpp.

◆ createPlatformTheme()

QPlatformTheme * QXcbIntegration::createPlatformTheme ( const QString & name) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 446 of file qxcbintegration.cpp.

◆ createPlatformWindow()

QPlatformWindow * QXcbIntegration::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 209 of file qxcbintegration.cpp.

◆ fontDatabase()

QPlatformFontDatabase * QXcbIntegration::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 378 of file qxcbintegration.cpp.

◆ hasCapability()

bool QXcbIntegration::hasCapability ( QPlatformIntegration::Capability cap) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 306 of file qxcbintegration.cpp.

◆ hasConnection()

bool QXcbIntegration::hasConnection ( ) const
inline

Definition at line 84 of file qxcbintegration.h.

◆ initialize()

void QXcbIntegration::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 345 of file qxcbintegration.cpp.

◆ inputContext()

QPlatformInputContext * QXcbIntegration::inputContext ( ) const
overridevirtual

Returns the platforms input context.

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

Reimplemented from QPlatformIntegration.

Definition at line 411 of file qxcbintegration.cpp.

◆ instance()

QXcbIntegration * QXcbIntegration::instance ( )
inlinestatic

Definition at line 103 of file qxcbintegration.h.

◆ keyMapper()

QPlatformKeyMapper * QXcbIntegration::keyMapper ( ) const
overridevirtual

Accessor for the platform integration's key mapper.

Default implementation returns a default QPlatformKeyMapper.

See also
QPlatformKeyMapper

Reimplemented from QPlatformIntegration.

Definition at line 436 of file qxcbintegration.cpp.

◆ moveToScreen()

void QXcbIntegration::moveToScreen ( QWindow * window,
int screen )

Definition at line 372 of file qxcbintegration.cpp.

◆ nativeInterface()

QPlatformNativeInterface * QXcbIntegration::nativeInterface ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 383 of file qxcbintegration.cpp.

◆ nativePaintingEnabled()

bool QXcbIntegration::nativePaintingEnabled ( ) const

Definition at line 579 of file qxcbintegration.cpp.

◆ services()

QPlatformServices * QXcbIntegration::services ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 431 of file qxcbintegration.cpp.

◆ setApplicationBadge()

void QXcbIntegration::setApplicationBadge ( qint64 number)
overridevirtual
Since
6.5

Should set the application's badge to number.

If the number is 0 the badge should be cleared.

See also
QGuiApplication::setBadge()

Reimplemented from QPlatformIntegration.

Definition at line 596 of file qxcbintegration.cpp.

◆ styleHint()

QVariant QXcbIntegration::styleHint ( QPlatformIntegration::StyleHint hint) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 456 of file qxcbintegration.cpp.

◆ sync()

void QXcbIntegration::sync ( )
overridevirtual
Since
5.2

Function to sync the platform integrations state with the window system.

This is often implemented as a roundtrip from the platformintegration to the window system.

This function should not call QWindowSystemInterface::flushWindowSystemEvents() or QCoreApplication::processEvents()

Reimplemented from QPlatformIntegration.

Definition at line 560 of file qxcbintegration.cpp.

◆ themeNames()

QStringList QXcbIntegration::themeNames ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 441 of file qxcbintegration.cpp.

◆ wmClass()

QByteArray QXcbIntegration::wmClass ( ) const

Definition at line 526 of file qxcbintegration.cpp.


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