Changeset View
Changeset View
Standalone View
Standalone View
src/client/registry.h
Show All 36 Lines | |||||
37 | struct wl_text_input_manager; | 37 | struct wl_text_input_manager; | ||
38 | struct zwp_text_input_manager_v2; | 38 | struct zwp_text_input_manager_v2; | ||
39 | struct _wl_fullscreen_shell; | 39 | struct _wl_fullscreen_shell; | ||
40 | struct org_kde_kwin_appmenu_manager; | 40 | struct org_kde_kwin_appmenu_manager; | ||
41 | struct org_kde_kwin_outputmanagement; | 41 | struct org_kde_kwin_outputmanagement; | ||
42 | struct org_kde_kwin_outputdevice; | 42 | struct org_kde_kwin_outputdevice; | ||
43 | struct org_kde_kwin_fake_input; | 43 | struct org_kde_kwin_fake_input; | ||
44 | struct org_kde_kwin_idle; | 44 | struct org_kde_kwin_idle; | ||
45 | struct org_kde_kwin_remote_access_manager; | ||||
45 | struct org_kde_kwin_dpms_manager; | 46 | struct org_kde_kwin_dpms_manager; | ||
46 | struct org_kde_kwin_shadow_manager; | 47 | struct org_kde_kwin_shadow_manager; | ||
47 | struct org_kde_kwin_blur_manager; | 48 | struct org_kde_kwin_blur_manager; | ||
48 | struct org_kde_kwin_contrast_manager; | 49 | struct org_kde_kwin_contrast_manager; | ||
49 | struct org_kde_kwin_slide_manager; | 50 | struct org_kde_kwin_slide_manager; | ||
50 | struct org_kde_plasma_shell; | 51 | struct org_kde_plasma_shell; | ||
51 | struct org_kde_plasma_window_management; | 52 | struct org_kde_plasma_window_management; | ||
52 | struct org_kde_kwin_server_decoration_manager; | 53 | struct org_kde_kwin_server_decoration_manager; | ||
Show All 19 Lines | |||||
72 | class DpmsManager; | 73 | class DpmsManager; | ||
73 | class EventQueue; | 74 | class EventQueue; | ||
74 | class FakeInput; | 75 | class FakeInput; | ||
75 | class FullscreenShell; | 76 | class FullscreenShell; | ||
76 | class OutputManagement; | 77 | class OutputManagement; | ||
77 | class OutputDevice; | 78 | class OutputDevice; | ||
78 | class Idle; | 79 | class Idle; | ||
79 | class IdleInhibitManager; | 80 | class IdleInhibitManager; | ||
81 | class RemoteAccessManager; | ||||
80 | class Output; | 82 | class Output; | ||
81 | class PlasmaShell; | 83 | class PlasmaShell; | ||
82 | class PlasmaWindowManagement; | 84 | class PlasmaWindowManagement; | ||
83 | class PointerConstraints; | 85 | class PointerConstraints; | ||
84 | class PointerGestures; | 86 | class PointerGestures; | ||
85 | class Seat; | 87 | class Seat; | ||
86 | class ShadowManager; | 88 | class ShadowManager; | ||
87 | class BlurManager; | 89 | class BlurManager; | ||
Show All 30 Lines | |||||
118 | * wl_display from an existing Wayland connection or a ConnectionThread instance: | 120 | * wl_display from an existing Wayland connection or a ConnectionThread instance: | ||
119 | * | 121 | * | ||
120 | * @code | 122 | * @code | ||
121 | * ConnectionThread *connection; // existing connection | 123 | * ConnectionThread *connection; // existing connection | ||
122 | * Registry registry; | 124 | * Registry registry; | ||
123 | * registry.create(connection); | 125 | * registry.create(connection); | ||
124 | * registry.setup(); | 126 | * registry.setup(); | ||
125 | * @endcode | 127 | * @endcode | ||
126 | * | 128 | * | ||
graesslin: please add as last interface otherwise it breaks API | |||||
Moved to last in enum. Or did you mean in forward references declaration too?.. Kanedias: Moved to last in enum. Or did you mean in forward references declaration too?.. | |||||
127 | * The interfaces are announced in an asynchronous way by the Wayland server. | 129 | * The interfaces are announced in an asynchronous way by the Wayland server. | ||
128 | * To initiate the announcing of the interfaces one needs to call setup. | 130 | * To initiate the announcing of the interfaces one needs to call setup. | ||
129 | **/ | 131 | **/ | ||
130 | class KWAYLANDCLIENT_EXPORT Registry : public QObject | 132 | class KWAYLANDCLIENT_EXPORT Registry : public QObject | ||
131 | { | 133 | { | ||
132 | Q_OBJECT | 134 | Q_OBJECT | ||
133 | public: | 135 | public: | ||
134 | /** | 136 | /** | ||
135 | * The well-known interfaces this Registry supports. | 137 | * The well-known interfaces this Registry supports. | ||
136 | * For each of the enum values the Registry is able to create a Wrapper | 138 | * For each of the enum values the Registry is able to create a Wrapper | ||
137 | * object. | 139 | * object. | ||
138 | **/ | 140 | **/ | ||
139 | enum class Interface { | 141 | enum class Interface { | ||
140 | Unknown, ///< Refers to an Unknown interface | 142 | Unknown, ///< Refers to an Unknown interface | ||
141 | Compositor, ///< Refers to the wl_compositor interface | 143 | Compositor, ///< Refers to the wl_compositor interface | ||
142 | Shell, ///< Refers to the wl_shell interface | 144 | Shell, ///< Refers to the wl_shell interface | ||
graesslin: just a note: it's 5.24 since today... | |||||
Kanedias: Understood, changed | |||||
143 | Seat, ///< Refers to the wl_seat interface | 145 | Seat, ///< Refers to the wl_seat interface | ||
144 | Shm, ///< Refers to the wl_shm interface | 146 | Shm, ///< Refers to the wl_shm interface | ||
145 | Output, ///< Refers to the wl_output interface | 147 | Output, ///< Refers to the wl_output interface | ||
146 | FullscreenShell, ///< Refers to the _wl_fullscreen_shell interface | 148 | FullscreenShell, ///< Refers to the _wl_fullscreen_shell interface | ||
147 | SubCompositor, ///< Refers to the wl_subcompositor interface; | 149 | SubCompositor, ///< Refers to the wl_subcompositor interface; | ||
148 | DataDeviceManager, ///< Refers to the wl_data_device_manager interface | 150 | DataDeviceManager, ///< Refers to the wl_data_device_manager interface | ||
149 | PlasmaShell, ///< Refers to org_kde_plasma_shell interface | 151 | PlasmaShell, ///< Refers to org_kde_plasma_shell interface | ||
150 | PlasmaWindowManagement, ///< Refers to org_kde_plasma_window_management interface | 152 | PlasmaWindowManagement, ///< Refers to org_kde_plasma_window_management interface | ||
Show All 13 Lines | |||||
164 | RelativePointerManagerUnstableV1, ///< Refers to zwp_relative_pointer_manager_v1, @since 5.28 | 166 | RelativePointerManagerUnstableV1, ///< Refers to zwp_relative_pointer_manager_v1, @since 5.28 | ||
165 | PointerGesturesUnstableV1, ///< Refers to zwp_pointer_gestures_v1, @since 5.29 | 167 | PointerGesturesUnstableV1, ///< Refers to zwp_pointer_gestures_v1, @since 5.29 | ||
166 | PointerConstraintsUnstableV1, ///< Refers to zwp_pointer_constraints_v1, @since 5.29 | 168 | PointerConstraintsUnstableV1, ///< Refers to zwp_pointer_constraints_v1, @since 5.29 | ||
167 | XdgExporterUnstableV2, ///< refers to zxdg_exporter_v2, @since 5.40 | 169 | XdgExporterUnstableV2, ///< refers to zxdg_exporter_v2, @since 5.40 | ||
168 | XdgImporterUnstableV2, ///< refers to zxdg_importer_v2, @since 5.40 | 170 | XdgImporterUnstableV2, ///< refers to zxdg_importer_v2, @since 5.40 | ||
169 | XdgShellUnstableV6, ///< Refers to zxdg_shell_v6 (unstable version 6), @since 5.39 | 171 | XdgShellUnstableV6, ///< Refers to zxdg_shell_v6 (unstable version 6), @since 5.39 | ||
170 | IdleInhibitManagerUnstableV1, ///< Refers to zwp_idle_inhibit_manager_v1 (unstable version 1), @since 5.41 | 172 | IdleInhibitManagerUnstableV1, ///< Refers to zwp_idle_inhibit_manager_v1 (unstable version 1), @since 5.41 | ||
171 | AppMenu, ///Refers to org_kde_kwin_appmenu @since 5.42 | 173 | AppMenu, ///Refers to org_kde_kwin_appmenu @since 5.42 | ||
172 | ServerSideDecorationPalette ///Refers to org_kde_kwin_server_decoration_palette_manager @since 5.42 | 174 | ServerSideDecorationPalette, ///Refers to org_kde_kwin_server_decoration_palette_manager @since 5.42 | ||
175 | RemoteAccessManager ///< Refers to org_kde_kwin_remote_access_manager interface, @since 5.45 | ||||
173 | }; | 176 | }; | ||
174 | explicit Registry(QObject *parent = nullptr); | 177 | explicit Registry(QObject *parent = nullptr); | ||
175 | virtual ~Registry(); | 178 | virtual ~Registry(); | ||
176 | 179 | | |||
177 | /** | 180 | /** | ||
178 | * Releases the wl_registry interface. | 181 | * Releases the wl_registry interface. | ||
179 | * After the interface has been released the Registry instance is no | 182 | * After the interface has been released the Registry instance is no | ||
180 | * longer valid and can be setup with another wl_registry interface. | 183 | * longer valid and can be setup with another wl_registry interface. | ||
▲ Show 20 Lines • Show All 187 Lines • ▼ Show 20 Line(s) | |||||
368 | /** | 371 | /** | ||
369 | * Binds the wl_data_device_manager with @p name and @p version. | 372 | * Binds the wl_data_device_manager with @p name and @p version. | ||
370 | * If the @p name does not exist or is not for the data device manager interface, | 373 | * If the @p name does not exist or is not for the data device manager interface, | ||
371 | * @c null will be returned. | 374 | * @c null will be returned. | ||
372 | * | 375 | * | ||
373 | * Prefer using createDataDeviceManager instead. | 376 | * Prefer using createDataDeviceManager instead. | ||
374 | * @see createDataDeviceManager | 377 | * @see createDataDeviceManager | ||
375 | **/ | 378 | **/ | ||
376 | wl_data_device_manager *bindDataDeviceManager(uint32_t name, uint32_t version) const; | 379 | wl_data_device_manager *bindDataDeviceManager(uint32_t name, uint32_t version) const; | ||
we moved to frameworks which means we are now at 5.23 - sorry about that. I also had to rename a bunch of @since 5.7 ;-) graesslin: we moved to frameworks which means we are now at 5.23 - sorry about that. I also had to rename… | |||||
Kanedias: Corrected | |||||
377 | /** | 380 | /** | ||
378 | * Binds the org_kde_plasma_shell with @p name and @p version. | 381 | * Binds the org_kde_plasma_shell with @p name and @p version. | ||
379 | * If the @p name does not exist or is not for the Plasma shell interface, | 382 | * If the @p name does not exist or is not for the Plasma shell interface, | ||
380 | * @c null will be returned. | 383 | * @c null will be returned. | ||
381 | * | 384 | * | ||
382 | * Prefer using createPlasmaShell instead. | 385 | * Prefer using createPlasmaShell instead. | ||
383 | * @see createPlasmaShell | 386 | * @see createPlasmaShell | ||
384 | * @since 5.4 | 387 | * @since 5.4 | ||
Show All 15 Lines | |||||
400 | * @c null will be returned. | 403 | * @c null will be returned. | ||
401 | * | 404 | * | ||
402 | * Prefer using createIdle instead. | 405 | * Prefer using createIdle instead. | ||
403 | * @see createIdle | 406 | * @see createIdle | ||
404 | * @since 5.4 | 407 | * @since 5.4 | ||
405 | **/ | 408 | **/ | ||
406 | org_kde_kwin_idle *bindIdle(uint32_t name, uint32_t version) const; | 409 | org_kde_kwin_idle *bindIdle(uint32_t name, uint32_t version) const; | ||
407 | /** | 410 | /** | ||
411 | * Binds the org_kde_kwin_remote_access_manager with @p name and @p version. | ||||
412 | * If the @p name does not exist or is not for the idle interface, | ||||
413 | * @c null will be returned. | ||||
414 | * | ||||
415 | * Prefer using createRemoteAccessManager instead. | ||||
416 | * @see createRemoteAccessManager | ||||
417 | * @since 5.45 | ||||
418 | **/ | ||||
419 | org_kde_kwin_remote_access_manager *bindRemoteAccessManager(uint32_t name, uint32_t version) const; | ||||
420 | /** | ||||
408 | * Binds the org_kde_kwin_fake_input with @p name and @p version. | 421 | * Binds the org_kde_kwin_fake_input with @p name and @p version. | ||
409 | * If the @p name does not exist or is not for the fake input interface, | 422 | * If the @p name does not exist or is not for the fake input interface, | ||
410 | * @c null will be returned. | 423 | * @c null will be returned. | ||
411 | * | 424 | * | ||
412 | * Prefer using createFakeInput instead. | 425 | * Prefer using createFakeInput instead. | ||
413 | * @see createFakeInput | 426 | * @see createFakeInput | ||
414 | * @since 5.4 | 427 | * @since 5.4 | ||
415 | **/ | 428 | **/ | ||
▲ Show 20 Lines • Show All 385 Lines • ▼ Show 20 Line(s) | |||||
801 | * @param version The version or the org_kde_kwin_idle interface to use | 814 | * @param version The version or the org_kde_kwin_idle interface to use | ||
802 | * @param parent The parent for Idle | 815 | * @param parent The parent for Idle | ||
803 | * | 816 | * | ||
804 | * @returns The created Idle. | 817 | * @returns The created Idle. | ||
805 | * @since 5.4 | 818 | * @since 5.4 | ||
806 | **/ | 819 | **/ | ||
807 | Idle *createIdle(quint32 name, quint32 version, QObject *parent = nullptr); | 820 | Idle *createIdle(quint32 name, quint32 version, QObject *parent = nullptr); | ||
808 | /** | 821 | /** | ||
822 | * Creates a RemoteAccessManager and sets it up to manage the interface identified by | ||||
823 | * @p name and @p version. | ||||
824 | * | ||||
825 | * Note: in case @p name is invalid or isn't for the org_kde_kwin_remote_access_manager interface, | ||||
826 | * the returned RemoteAccessManager will not be valid. Therefore it's recommended to call | ||||
827 | * isValid on the created instance. | ||||
828 | * | ||||
829 | * @param name The name of the org_kde_kwin_remote_access_manager interface to bind | ||||
830 | * @param version The version or the org_kde_kwin_remote_access_manager interface to use | ||||
831 | * @param parent The parent for RemoteAccessManager | ||||
832 | * | ||||
833 | * @returns The created RemoteAccessManager. | ||||
834 | * @since 5.45 | ||||
835 | **/ | ||||
836 | RemoteAccessManager *createRemoteAccessManager(quint32 name, quint32 version, QObject *parent = nullptr); | ||||
837 | /** | ||||
809 | * Creates a FakeInput and sets it up to manage the interface identified by | 838 | * Creates a FakeInput and sets it up to manage the interface identified by | ||
810 | * @p name and @p version. | 839 | * @p name and @p version. | ||
811 | * | 840 | * | ||
812 | * Note: in case @p name is invalid or isn't for the org_kde_kwin_fake_input interface, | 841 | * Note: in case @p name is invalid or isn't for the org_kde_kwin_fake_input interface, | ||
813 | * the returned FakeInput will not be valid. Therefore it's recommended to call | 842 | * the returned FakeInput will not be valid. Therefore it's recommended to call | ||
814 | * isValid on the created instance. | 843 | * isValid on the created instance. | ||
815 | * | 844 | * | ||
816 | * @param name The name of the org_kde_kwin_fake_input interface to bind | 845 | * @param name The name of the org_kde_kwin_fake_input interface to bind | ||
▲ Show 20 Lines • Show All 365 Lines • ▼ Show 20 Line(s) | 1135 | Q_SIGNALS: | |||
1182 | /** | 1211 | /** | ||
1183 | * Emitted whenever a org_kde_kwin_idle interface gets announced. | 1212 | * Emitted whenever a org_kde_kwin_idle interface gets announced. | ||
1184 | * @param name The name for the announced interface | 1213 | * @param name The name for the announced interface | ||
1185 | * @param version The maximum supported version of the announced interface | 1214 | * @param version The maximum supported version of the announced interface | ||
1186 | * @since 5.4 | 1215 | * @since 5.4 | ||
1187 | **/ | 1216 | **/ | ||
1188 | void idleAnnounced(quint32 name, quint32 version); | 1217 | void idleAnnounced(quint32 name, quint32 version); | ||
1189 | /** | 1218 | /** | ||
1219 | * Emitted whenever a org_kde_kwin_remote_access_manager interface gets announced. | ||||
1220 | * @param name The name for the announced interface | ||||
1221 | * @param version The maximum supported version of the announced interface | ||||
1222 | * @since 5.45 | ||||
1223 | **/ | ||||
1224 | void remoteAccessManagerAnnounced(quint32 name, quint32 version); | ||||
1225 | /** | ||||
1190 | * Emitted whenever a org_kde_kwin_fake_input interface gets announced. | 1226 | * Emitted whenever a org_kde_kwin_fake_input interface gets announced. | ||
1191 | * @param name The name for the announced interface | 1227 | * @param name The name for the announced interface | ||
1192 | * @param version The maximum supported version of the announced interface | 1228 | * @param version The maximum supported version of the announced interface | ||
1193 | * @since 5.4 | 1229 | * @since 5.4 | ||
1194 | **/ | 1230 | **/ | ||
1195 | void fakeInputAnnounced(quint32 name, quint32 version); | 1231 | void fakeInputAnnounced(quint32 name, quint32 version); | ||
1196 | /** | 1232 | /** | ||
1197 | * Emitted whenever a org_kde_kwin_shadow_manager interface gets announced. | 1233 | * Emitted whenever a org_kde_kwin_shadow_manager interface gets announced. | ||
▲ Show 20 Lines • Show All 200 Lines • ▼ Show 20 Line(s) | |||||
1398 | void plasmaWindowManagementRemoved(quint32 name); | 1434 | void plasmaWindowManagementRemoved(quint32 name); | ||
1399 | /** | 1435 | /** | ||
1400 | * Emitted whenever a org_kde_kwin_idle interface gets removed. | 1436 | * Emitted whenever a org_kde_kwin_idle interface gets removed. | ||
1401 | * @param name The name for the removed interface | 1437 | * @param name The name for the removed interface | ||
1402 | * @since 5.4 | 1438 | * @since 5.4 | ||
1403 | **/ | 1439 | **/ | ||
1404 | void idleRemoved(quint32 name); | 1440 | void idleRemoved(quint32 name); | ||
1405 | /** | 1441 | /** | ||
1442 | * Emitted whenever a org_kde_kwin_remote_access_manager interface gets removed. | ||||
1443 | * @param name The name for the removed interface | ||||
1444 | * @since 5.45 | ||||
1445 | **/ | ||||
1446 | void remoteAccessManagerRemoved(quint32 name); | ||||
1447 | /** | ||||
1406 | * Emitted whenever a org_kde_kwin_fake_input interface gets removed. | 1448 | * Emitted whenever a org_kde_kwin_fake_input interface gets removed. | ||
1407 | * @param name The name for the removed interface | 1449 | * @param name The name for the removed interface | ||
1408 | * @since 5.4 | 1450 | * @since 5.4 | ||
1409 | **/ | 1451 | **/ | ||
1410 | void fakeInputRemoved(quint32 name); | 1452 | void fakeInputRemoved(quint32 name); | ||
1411 | /** | 1453 | /** | ||
1412 | * Emitted whenever a org_kde_kwin_shadow_manager interface gets removed. | 1454 | * Emitted whenever a org_kde_kwin_shadow_manager interface gets removed. | ||
1413 | * @param name The name for the removed interface | 1455 | * @param name The name for the removed interface | ||
▲ Show 20 Lines • Show All 159 Lines • Show Last 20 Lines |
please add as last interface otherwise it breaks API