Differential D13745 Diff 36857 libtaskmanager/virtualdesktopinfo.h

Changeset View

Standalone View

libtaskmanager/virtualdesktopinfo.h

Show All 23 Lines
24	#include <QObject>	24	#include <QObject>
25		25
26	#include "taskmanager_export.h"	26	#include "taskmanager_export.h"
27		27
28	namespace TaskManager	28	namespace TaskManager
29	{	29	{
30		30
31	/**	31	/**
32	* @short Provides basic virtual desktop information.	32	* @short Provides basic virtual desktop information. The underlying windowing
		33	* system is abstracted away.
33	*	34	*
34	* This class provides basic information about the virtual desktops present	35	* This class provides basic information about the virtual desktops present
35	* in the session as a set of notifiable properties.	36	* in the session as a set of notifiable properties.
36	*	37	*
37	* @NOTE: This is a placeholder, to be moved into KWindowSystem (which it
38	* wraps) or the Task Manager applet backend (which used to fill this role
39	* in the past).
40	*
41	* @see KWindowSystem
42	*
43	* @author Eike Hein <hein@kde.org>	38	* @author Eike Hein <hein@kde.org>
44	**/	39	**/
45		40
46	class TASKMANAGER_EXPORT VirtualDesktopInfo : public QObject	41	class TASKMANAGER_EXPORT VirtualDesktopInfo : public QObject
47	{	42	{
48	Q_OBJECT	43	Q_OBJECT
49		44
50	Q_PROPERTY(int currentDesktop READ currentDesktop NOTIFY currentDesktopChanged)	45	Q_PROPERTY(QVariant currentDesktop READ currentDesktop NOTIFY currentDesktopChanged)
51	Q_PROPERTY(int numberOfDesktops READ numberOfDesktops NOTIFY numberOfDesktopsChanged)	46	Q_PROPERTY(int numberOfDesktops READ numberOfDesktops NOTIFY numberOfDesktopsChanged)
		47	Q_PROPERTY(QVariantList desktopIds READ desktopIds NOTIFY desktopIdsChanged)
52	Q_PROPERTY(QStringList desktopNames READ desktopNames NOTIFY desktopNamesChanged)	48	Q_PROPERTY(QStringList desktopNames READ desktopNames NOTIFY desktopNamesChanged)
53	Q_PROPERTY(int desktopLayoutRows READ desktopLayoutRows NOTIFY desktopLayoutRowsChanged)	49	Q_PROPERTY(int desktopLayoutRows READ desktopLayoutRows NOTIFY desktopLayoutRowsChanged)
		50	Q_PROPERTY(bool canManageDesktops READ canManageDesktops CONSTANT)
54		51
55	public:	52	public:
56	explicit VirtualDesktopInfo(QObject *parent = nullptr);	53	explicit VirtualDesktopInfo(QObject *parent = nullptr);
57	~VirtualDesktopInfo() override;	54	~VirtualDesktopInfo() override;
58		55
59	/**	56	/**
60	* The currently active virtual desktop.	57	* The currently active virtual desktop.
61	*	58	*
62	* @returns the number of the currently active virtual desktop.	59	* @returns the id of the currently active virtual desktop. QString on
		60	* Wayland; uint >0 on X11.
63	**/	61	**/
64	int currentDesktop() const;	62	QVariant currentDesktop() const;
65		63
66	/**	64	/**
67	* The number of virtual desktops present in the session.	65	* The number of virtual desktops present in the session.
68	*	66	*
69	* @returns the number of virtual desktops present in the session.	67	* @returns the number of virtual desktops present in the session.
70	**/	68	**/
71	int numberOfDesktops() const;	69	int numberOfDesktops() const;
72		70
73	/**	71	/**
74	* The names of all virtual desktops present in the session. Note that	72	* The ids of all virtual desktops present in the session.
75	* virtual desktops are indexed starting at 1, so the name for virtual	73	*
76	* desktop 1 is at index 0 in this list.	74	* On Wayland, the ids are QString. On X11, they are uint >0.
		75	*
		76	* @returns a the list of ids of the virtual desktops present in the
		77	* session.
		78	**/
		79	QVariantList desktopIds() const;
		80
		81	/**
		82	* The names of all virtual desktops present in the session.
77	*	83	*
78	* @returns a the list of names for the virtual desktops present in the	84	* Note that on X11, virtual desktops are indexed starting at 1, so
		85	* the name for virtual desktop 1 is at index 0 in this list.
		86	*
		87	* @returns the list of names of the virtual desktops present in the
79	* session.	88	* session.
80	**/	89	**/
81	QStringList desktopNames() const;	90	QStringList desktopNames() const;
82		91
83	/**	92	/**
		93	* Returns the position of the passed-in virtual desktop.
		94	* @param desktop A virtual desktop id (QString on Wayland; uint >0 on X11).
		95	* @returns the position of the virtual desktop, or -1 if the desktop
		96	* id is not valid.
		97	**/
		98	quint32 position(const QVariant &desktop) const;
		99
		100	/**
84	* The number of rows in the virtual desktop layout.	101	* The number of rows in the virtual desktop layout.
85	*	102	*
86	* @returns the number of rows in the virtual desktop layout.	103	* @returns the number of rows in the virtual desktop layout.
87	**/	104	**/
88	int desktopLayoutRows() const;	105	int desktopLayoutRows() const;
89		106
		107	/**
		108	* Request activating the passed-in virtual desktop.
		109	*
		110	* @param desktop A virtual desktop id (QString on Wayland; uint >0 on X11).
		111	**/
		112	void requestActivate(const QVariant &desktop);
		113
		114	/**
		115	* Whether the underlying windowing system allows adding/removing virtual
		116	* desktops.
		117	**/
		118	bool canManageDesktops() const;
		119
90	Q_SIGNALS:	120	Q_SIGNALS:
91	void currentDesktopChanged() const;	121	void currentDesktopChanged() const;
92	void numberOfDesktopsChanged() const;	122	void numberOfDesktopsChanged() const;
		123	void desktopIdsChanged() const;
93	void desktopNamesChanged() const;	124	void desktopNamesChanged() const;
94	void desktopLayoutRowsChanged() const;	125	void desktopLayoutRowsChanged() const;
		126
		127	private:
		128	class Private;
		129	class XWindowPrivate;
		130	class WaylandPrivate;
		131	static Private *d;
95	};	132	};
96		133
97	}	134	}
98		135
99	#endif	136	#endif