QX11Info Class

Provides information about the X display configuration. More...

Header:	#include <QX11Info>
qmake:	QT += x11extras
Since:	Qt 5.1

This class was introduced in Qt 5.1.

• List of all members, including inherited members

Public Types

enum	PeekOption { PeekDefault, PeekFromCachedIndex }
flags	PeekOptions
typedef	PeekerCallback

Static Public Members

int	appDpiX(int screen = -1)
int	appDpiY(int screen = -1)
unsigned long	appRootWindow(int screen = -1)
int	appScreen()
unsigned long	appTime()
unsigned long	appUserTime()
xcb_connection_t *	connection()
Display *	display()
qint32	generatePeekerId()
unsigned long	getTimestamp()
bool	isCompositingManagerRunning(int screen = -1)
bool	isPlatformX11()
QByteArray	nextStartupId()
bool	peekEventQueue(QX11Info::PeekerCallback peeker, void *peekerData = nullptr, QX11Info::PeekOptions option = PeekDefault, qint32 peekerId = -1)
bool	removePeekerId(qint32 peekerId)
void	setAppTime(unsigned long time)
void	setAppUserTime(unsigned long time)
void	setNextStartupId(const QByteArray &id)

Detailed Description

The class provides two APIs: a set of non-static functions that provide information about a specific widget or pixmap, and a set of static functions that provide the default information for the application.

Warning: This class is only available on X11. For querying per-screen information in a portable way, use QDesktopWidget.

Member Type Documentation

enum QX11Info::PeekOptionflags QX11Info::PeekOptions

An enum to tune the behavior of QX11Info::peekEventQueue().

Constant	Value	Description
QX11Info::PeekDefault	0	Peek from the beginning of the buffered native event queue. A peeker id is optional with PeekDefault. If a peeker id is provided to peekEventQueue() when using PeekDefault, then peeking starts from the beginning of the queue, not from the cached index; thus, this can be used to manually reset a cached index to peek from the start of the queue. When this operation completes, the associated index will be updated to the new position in the queue.
QX11Info::PeekFromCachedIndex	1	QX11Info::peekEventQueue() can optimize the peeking algorithm by skipping events that it already has seen in earlier calls to peekEventQueue(). When control returns to the main event loop, which causes the buffered native event queue to be flushed to Qt's event queue, the cached indices are marked invalid and will be reset on the next access. The same is true if the program explicitly flushes the buffered native event queue by QCoreApplication::processEvents().

This enum was introduced or modified in Qt 5.10.

The PeekOptions type is a typedef for QFlags<PeekOption>. It stores an OR combination of PeekOption values.

typedef QX11Info::PeekerCallback

Typedef for a pointer to a function with the following signature:

bool (*PeekerCallback)(xcb_generic_event_t *event, void *peekerData);

The event is a native XCB event. The peekerData is a pointer to data, passed in via peekEventQueue().

Return true from this function to stop examining the buffered native event queue or false to continue.

Note: A non-capturing lambda can serve as a PeekerCallback.

This typedef was introduced in Qt 5.10.

Member Function Documentation

[static] int QX11Info::appDpiX(int screen = -1)

Returns the horizontal resolution of the given screen in terms of the number of dots per inch.

The screen argument is an X screen number. Be aware that if the user's system uses Xinerama (as opposed to traditional X11 multiscreen), there is only one X screen. Use QDesktopWidget to query for information about Xinerama screens.

See also appDpiY().

[static] int QX11Info::appDpiY(int screen = -1)

Returns the vertical resolution of the given screen in terms of the number of dots per inch.

The screen argument is an X screen number. Be aware that if the user's system uses Xinerama (as opposed to traditional X11 multiscreen), there is only one X screen. Use QDesktopWidget to query for information about Xinerama screens.

See also appDpiX().

[static] unsigned long QX11Info::appRootWindow(int screen = -1)

Returns a handle for the applications root window on the given screen.

The screen argument is an X screen number. Be aware that if the user's system uses Xinerama (as opposed to traditional X11 multiscreen), there is only one X screen. Use QDesktopWidget to query for information about Xinerama screens.

See also QApplication::desktop().

[static] int QX11Info::appScreen()

Returns the number of the screen where the application is being displayed.

This method refers to screens in the original X11 meaning with a different DISPLAY environment variable per screen. This information is only useful if your application needs to know on which X screen it is running.

In a typical multi-head configuration, multiple physical monitors are combined in one X11 screen. This means this method returns the same number for each of the physical monitors. In such a setup you are interested in the monitor information as provided by the X11 RandR extension. This is available through QDesktopWidget and QScreen.

See also display().

[static] unsigned long QX11Info::appTime()

Returns the X11 time.

See also setAppTime() and appUserTime().

[static] unsigned long QX11Info::appUserTime()

Returns the X11 user time.

See also setAppUserTime() and appTime().

[static] xcb_connection_t *QX11Info::connection()

Returns the default XCB connection for the application.

See also display().

[static] Display *QX11Info::display()

Returns the default display for the application.

See also appScreen().

[static] qint32 QX11Info::generatePeekerId()

Returns a new peeker id or -1 if some interal error has occurred. Each peeker id is associated with an index in the buffered native event queue.

For more details see QX11Info::PeekOption and peekEventQueue().

This function was introduced in Qt 5.10.

See also peekEventQueue() and removePeekerId().

[static] unsigned long QX11Info::getTimestamp()

Fetches the current X11 time stamp from the X Server.

This method creates a property notify event and blocks till it is received back from the X Server.

This function was introduced in Qt 5.2.

[static] bool QX11Info::isCompositingManagerRunning(int screen = -1)

Returns true if there is a compositing manager running for the connection attached to screen.

If screen equals -1, the application's primary screen is used.

This function was introduced in Qt 5.7.

[static] bool QX11Info::isPlatformX11()

Returns true if the application is currently running on X11.

This function was introduced in Qt 5.2.

[static] QByteArray QX11Info::nextStartupId()

Returns the startup ID that will be used for the next window to be shown by this process.

After the next window is shown, the next startup ID will be empty.

http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt

This function was introduced in Qt 5.4.

See also setNextStartupId().

[static] bool QX11Info::peekEventQueue(QX11Info::PeekerCallback peeker, void *peekerData = nullptr, QX11Info::PeekOptions option = PeekDefault, qint32 peekerId = -1)

Peek into the buffered XCB event queue.

You can call peekEventQueue() periodically, when your program is busy performing a long-running operation, to peek into the buffered native event queue. The more time the long-running operation blocks the program from returning control to the main event loop, the more events will accumulate in the buffered XCB event queue. Once control returns to the main event loop these events will be flushed to Qt's event queue, which is a separate event queue from the queue this function is peeking into.

Note: It is usually better to run CPU-intensive operations in a non-GUI thread, instead of blocking the main event loop.

The buffered XCB event queue is populated from a non-GUI thread and therefore might be ahead of the current GUI state. To handle native events as they are processed by the GUI thread, see QAbstractNativeEventFilter::nativeEventFilter().

The peeker is a callback function as documented in PeekerCallback. The peekerData can be used to pass in arbitrary data to the peeker callback. The option is an enum that tunes the behavior of peekEventQueue(). The peekerId is used to track an index in the queue, for more details see QX11Info::PeekOption. There can be several indices, each tracked individually by a peeker id obtained via generatePeekerId().

This function returns true when the peeker has stopped the event proccesing by returning true from the callback. If there were no events in the buffered native event queue to peek at or all the events have been processed by the peeker, this function returns false.

This function was introduced in Qt 5.10.

See also generatePeekerId() and QAbstractNativeEventFilter::nativeEventFilter().

[static] bool QX11Info::removePeekerId(qint32 peekerId)

Removes peekerId, which was earlier obtained via generatePeekerId().

Returns true on success or false if unknown peeker id was provided or some interal error has occurred.

This function was introduced in Qt 5.10.

See also generatePeekerId().

[static] void QX11Info::setAppTime(unsigned long time)

Sets the X11 time to the value specified by time.

See also appTime() and setAppUserTime().

[static] void QX11Info::setAppUserTime(unsigned long time)

Sets the X11 user time as specified by time.

See also appUserTime() and setAppTime().

[static] void QX11Info::setNextStartupId(const QByteArray &id)

Sets the next startup ID to id.

This is the startup ID that will be used for the next window to be shown by this process.

The startup ID of the first window comes from the environment variable DESKTOP_STARTUP_ID. This method is useful for subsequent windows, when the request comes from another process (e.g. via DBus).

This function was introduced in Qt 5.4.

See also nextStartupId().