/usr/include/KF5/KWayland/Client/registry.h is in libkf5wayland-dev 4:5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 | /********************************************************************
Copyright 2014 Martin Gräßlin <mgraesslin@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) version 3, or any
later version accepted by the membership of KDE e.V. (or its
successor approved by the membership of KDE e.V.), which shall
act as a proxy defined in Section 6 of version 3 of the license.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef WAYLAND_REGISTRY_H
#define WAYLAND_REGISTRY_H
#include <QHash>
#include <QObject>
#include <KWayland/Client/kwaylandclient_export.h>
struct wl_compositor;
struct wl_data_device_manager;
struct wl_display;
struct wl_output;
struct wl_registry;
struct wl_seat;
struct wl_shell;
struct wl_shm;
struct wl_subcompositor;
struct wl_text_input_manager;
struct zwp_text_input_manager_v2;
struct _wl_fullscreen_shell;
struct org_kde_kwin_appmenu_manager;
struct org_kde_kwin_outputmanagement;
struct org_kde_kwin_outputdevice;
struct org_kde_kwin_fake_input;
struct org_kde_kwin_idle;
struct org_kde_kwin_dpms_manager;
struct org_kde_kwin_shadow_manager;
struct org_kde_kwin_blur_manager;
struct org_kde_kwin_contrast_manager;
struct org_kde_kwin_slide_manager;
struct org_kde_plasma_shell;
struct org_kde_plasma_window_management;
struct org_kde_kwin_server_decoration_manager;
struct org_kde_kwin_server_decoration_palette_manager;
struct xdg_shell;
struct zxdg_shell_v6;
struct zwp_relative_pointer_manager_v1;
struct zwp_pointer_gestures_v1;
struct zwp_pointer_constraints_v1;
struct zxdg_exporter_v2;
struct zxdg_importer_v2;
struct zwp_idle_inhibit_manager_v1;
namespace KWayland
{
namespace Client
{
class AppMenuManager;
class Compositor;
class ConnectionThread;
class DataDeviceManager;
class DpmsManager;
class EventQueue;
class FakeInput;
class FullscreenShell;
class OutputManagement;
class OutputDevice;
class Idle;
class IdleInhibitManager;
class Output;
class PlasmaShell;
class PlasmaWindowManagement;
class PointerConstraints;
class PointerGestures;
class Seat;
class ShadowManager;
class BlurManager;
class ContrastManager;
class SlideManager;
class Shell;
class ShmPool;
class ServerSideDecorationManager;
class ServerSideDecorationPaletteManager;
class SubCompositor;
class TextInputManager;
class TextInputManagerUnstableV0;
class TextInputManagerUnstableV2;
class XdgShell;
class RelativePointerManager;
class XdgExporterUnstableV2;
class XdgImporterUnstableV2;
class XdgExporter;
class XdgImporter;
/**
* @short Wrapper for the wl_registry interface.
*
* The purpose of this class is to manage the wl_registry interface.
* This class supports some well-known interfaces and can create a
* wrapper class for those.
*
* The main purpose is to emit signals whenever a new interface is
* added or an existing interface is removed. For the well known interfaces
* dedicated signals are emitted allowing a user to connect directly to the
* signal announcing the interface it is interested in.
*
* To create and setup the Registry one needs to call create with either a
* wl_display from an existing Wayland connection or a ConnectionThread instance:
*
* @code
* ConnectionThread *connection; // existing connection
* Registry registry;
* registry.create(connection);
* registry.setup();
* @endcode
*
* The interfaces are announced in an asynchronous way by the Wayland server.
* To initiate the announcing of the interfaces one needs to call setup.
**/
class KWAYLANDCLIENT_EXPORT Registry : public QObject
{
Q_OBJECT
public:
/**
* The well-known interfaces this Registry supports.
* For each of the enum values the Registry is able to create a Wrapper
* object.
**/
enum class Interface {
Unknown, ///< Refers to an Unknown interface
Compositor, ///< Refers to the wl_compositor interface
Shell, ///< Refers to the wl_shell interface
Seat, ///< Refers to the wl_seat interface
Shm, ///< Refers to the wl_shm interface
Output, ///< Refers to the wl_output interface
FullscreenShell, ///< Refers to the _wl_fullscreen_shell interface
SubCompositor, ///< Refers to the wl_subcompositor interface;
DataDeviceManager, ///< Refers to the wl_data_device_manager interface
PlasmaShell, ///< Refers to org_kde_plasma_shell interface
PlasmaWindowManagement, ///< Refers to org_kde_plasma_window_management interface
Idle, ///< Refers to org_kde_kwin_idle_interface interface
FakeInput, ///< Refers to org_kde_kwin_fake_input interface
Shadow, ///< Refers to org_kde_kwin_shadow_manager interface
Blur, ///< refers to org_kde_kwin_blur_manager interface
Contrast, ///< refers to org_kde_kwin_contrast_manager interface
Slide, ///< refers to org_kde_kwin_slide_manager
Dpms, ///< Refers to org_kde_kwin_dpms_manager interface
OutputManagement, ///< Refers to the wl_data_device_manager interface
OutputDevice, ///< Refers to the org_kde_kwin_outputdevice interface
ServerSideDecorationManager, ///< Refers to org_kde_kwin_server_decoration_manager
TextInputManagerUnstableV0, ///< Refers to wl_text_input_manager, @since 5.23
TextInputManagerUnstableV2, ///< Refers to zwp_text_input_manager_v2, @since 5.23
XdgShellUnstableV5, ///< Refers to xdg_shell (unstable version 5), @since 5.25
RelativePointerManagerUnstableV1, ///< Refers to zwp_relative_pointer_manager_v1, @since 5.28
PointerGesturesUnstableV1, ///< Refers to zwp_pointer_gestures_v1, @since 5.29
PointerConstraintsUnstableV1, ///< Refers to zwp_pointer_constraints_v1, @since 5.29
XdgExporterUnstableV2, ///< refers to zxdg_exporter_v2, @since 5.40
XdgImporterUnstableV2, ///< refers to zxdg_importer_v2, @since 5.40
XdgShellUnstableV6, ///< Refers to zxdg_shell_v6 (unstable version 6), @since 5.39
IdleInhibitManagerUnstableV1, ///< Refers to zwp_idle_inhibit_manager_v1 (unstable version 1), @since 5.41
AppMenu, ///Refers to org_kde_kwin_appmenu @since 5.42
ServerSideDecorationPalette ///Refers to org_kde_kwin_server_decoration_palette_manager @since 5.42
};
explicit Registry(QObject *parent = nullptr);
virtual ~Registry();
/**
* Releases the wl_registry interface.
* After the interface has been released the Registry instance is no
* longer valid and can be setup with another wl_registry interface.
**/
void release();
/**
* Destroys the data held by this Registry.
* This method is supposed to be used when the connection to the Wayland
* server goes away. If the connection is not valid anymore, it's not
* possible to call release anymore as that calls into the Wayland
* connection and the call would fail. This method cleans up the data, so
* that the instance can be deleted or set up to a new wl_registry interface
* once there is a new connection available.
*
* It is suggested to connect this method to ConnectionThread::connectionDied:
* @code
* connect(connection, &ConnectionThread::connectionDied, registry, &Registry::destroy);
* @endcode
*
* @see release
**/
void destroy();
/**
* Gets the registry from the @p display.
**/
void create(wl_display *display);
/**
* Gets the registry from the @p connection.
**/
void create(ConnectionThread *connection);
/**
* Finalizes the setup of the Registry.
* After calling this method the interfaces will be announced in an asynchronous way.
* The Registry must have been created when calling this method.
* @see create
**/
void setup();
/**
* Sets the @p queue to use for this Registry.
*
* The EventQueue should be set before the Registry gets setup.
* The EventQueue gets automatically added to all interfaces created by
* this Registry. So that all objects are in teh same EventQueue.
*
* @param queue The event queue to use for this Registry.
**/
void setEventQueue(EventQueue *queue);
/**
* @returns The EventQueue used by this Registry
**/
EventQueue *eventQueue();
/**
* @returns @c true if managing a wl_registry.
**/
bool isValid() const;
/**
* @returns @c true if the Registry has an @p interface.
**/
bool hasInterface(Interface interface) const;
/**
* Representation of one announced interface.
**/
struct AnnouncedInterface {
/**
* The name of the announced interface.
**/
quint32 name;
/**
* The maximum supported version of the announced interface.
**/
quint32 version;
};
/**
* Provides name and version for the @p interface.
*
* The first value of the returned pair is the "name", the second value is the "version".
* If the @p interface has not been announced, both values are set to 0.
* If there @p interface has been announced multiple times, the last announced is returned.
* In case one is interested in all announced interfaces, one should prefer @link interfaces(Interface) @endlink.
*
* The returned information can be passed into the bind or create methods.
*
* @param interface The well-known interface for which the name and version should be retrieved
* @returns name and version of the given interface
* @since 5.5
**/
AnnouncedInterface interface(Interface interface) const;
/**
* Provides all pairs of name and version for the well-known @p interface.
*
* If the @p interface has not been announced, an empty vector is returned.
*
* The returned information can be passed into the bind or create methods.
*
* @param interface The well-known interface for which the name and version should be retrieved
* @returns All pairs of name and version of the given interface
* @since 5.5
**/
QVector<AnnouncedInterface> interfaces(Interface interface) const;
/**
* @name Low-level bind methods for global interfaces.
**/
///@{
/**
* Binds the wl_compositor with @p name and @p version.
* If the @p name does not exist or is not for the compositor interface,
* @c null will be returned.
*
* Prefer using createCompositor instead.
* @see createCompositor
**/
wl_compositor *bindCompositor(uint32_t name, uint32_t version) const;
/**
* Binds the wl_shell with @p name and @p version.
* If the @p name does not exist or is not for the shell interface,
* @c null will be returned.
*
* Prefer using createShell instead.
* @see createShell
**/
wl_shell *bindShell(uint32_t name, uint32_t version) const;
/**
* Binds the wl_seat with @p name and @p version.
* If the @p name does not exist or is not for the seat interface,
* @c null will be returned.
*
* Prefer using createSeat instead.
* @see createSeat
**/
wl_seat *bindSeat(uint32_t name, uint32_t version) const;
/**
* Binds the wl_shm with @p name and @p version.
* If the @p name does not exist or is not for the shm interface,
* @c null will be returned.
*
* Prefer using createShmPool instead.
* @see createShmPool
**/
wl_shm *bindShm(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_outputmanagement with @p name and @p version.
* If the @p name does not exist or is not for the outputmanagement interface,
* @c null will be returned.
*
* Prefer using createOutputManagement instead.
* @see createOutputManagement
**/
org_kde_kwin_outputmanagement *bindOutputManagement(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_outputdevice with @p name and @p version.
* If the @p name does not exist or is not for the outputdevice interface,
* @c null will be returned.
*
* Prefer using createOutputDevice instead.
* @see createOutputDevice
**/
wl_output *bindOutput(uint32_t name, uint32_t version) const;
/**
* Binds the wl_subcompositor with @p name and @p version.
* If the @p name does not exist or is not for the subcompositor interface,
* @c null will be returned.
*
* Prefer using createSubCompositor instead.
* @see createSubCompositor
**/
wl_subcompositor *bindSubCompositor(uint32_t name, uint32_t version) const;
/**
* Binds the wl_output with @p name and @p version.
* If the @p name does not exist or is not for the output interface,
* @c null will be returned.
*
* Prefer using createOutput instead.
* @see createOutput
* @since 5.5
**/
org_kde_kwin_outputdevice *bindOutputDevice(uint32_t name, uint32_t version) const;
/**
* Binds the _wl_fullscreen_shell with @p name and @p version.
* If the @p name does not exist or is not for the fullscreen shell interface,
* @c null will be returned.
*
* Prefer using createFullscreenShell instead.
* @see createFullscreenShell
**/
_wl_fullscreen_shell *bindFullscreenShell(uint32_t name, uint32_t version) const;
/**
* Binds the wl_data_device_manager with @p name and @p version.
* If the @p name does not exist or is not for the data device manager interface,
* @c null will be returned.
*
* Prefer using createDataDeviceManager instead.
* @see createDataDeviceManager
**/
wl_data_device_manager *bindDataDeviceManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_plasma_shell with @p name and @p version.
* If the @p name does not exist or is not for the Plasma shell interface,
* @c null will be returned.
*
* Prefer using createPlasmaShell instead.
* @see createPlasmaShell
* @since 5.4
**/
org_kde_plasma_shell *bindPlasmaShell(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_plasma_window_management with @p name and @p version.
* If the @p name does not exist or is not for the Plasma window management interface,
* @c null will be returned.
*
* Prefer using createPlasmaWindowManagement instead.
* @see createPlasmaWindowManagement
* @since 5.4
**/
org_kde_plasma_window_management *bindPlasmaWindowManagement(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_idle with @p name and @p version.
* If the @p name does not exist or is not for the idle interface,
* @c null will be returned.
*
* Prefer using createIdle instead.
* @see createIdle
* @since 5.4
**/
org_kde_kwin_idle *bindIdle(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_fake_input with @p name and @p version.
* If the @p name does not exist or is not for the fake input interface,
* @c null will be returned.
*
* Prefer using createFakeInput instead.
* @see createFakeInput
* @since 5.4
**/
org_kde_kwin_fake_input *bindFakeInput(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_shadow_manager with @p name and @p version.
* If the @p name does not exist or is not for the shadow manager interface,
* @c null will be returned.
*
* Prefer using createShadowManager instead.
* @see createShadowManager
* @since 5.4
**/
org_kde_kwin_shadow_manager *bindShadowManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_blur_manager with @p name and @p version.
* If the @p name does not exist or is not for the blur manager interface,
* @c null will be returned.
*
* Prefer using createBlurManager instead.
* @see createBlurManager
* @since 5.5
**/
org_kde_kwin_blur_manager *bindBlurManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_contrast_manager with @p name and @p version.
* If the @p name does not exist or is not for the contrast manager interface,
* @c null will be returned.
*
* Prefer using createContrastManager instead.
* @see createContrastManager
* @since 5.5
**/
org_kde_kwin_contrast_manager *bindContrastManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_slide_manager with @p name and @p version.
* If the @p name does not exist or is not for the slide manager interface,
* @c null will be returned.
*
* Prefer using createSlideManager instead.
* @see createSlideManager
* @since 5.5
**/
org_kde_kwin_slide_manager * bindSlideManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_dpms_manager with @p name and @p version.
* If the @p name does not exist or is not for the dpms manager interface,
* @c null will be returned.
*
* Prefer using createDpmsManager instead.
* @see createDpmsManager
* @since 5.5
**/
org_kde_kwin_dpms_manager *bindDpmsManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_server_decoration_manager with @p name and @p version.
* If the @p name does not exist or is not for the server side decoration manager interface,
* @c null will be returned.
*
* Prefer using createServerSideDecorationManager instead.
* @see createServerSideDecorationManager
* @since 5.6
**/
org_kde_kwin_server_decoration_manager *bindServerSideDecorationManager(uint32_t name, uint32_t version) const;
/**
* Binds the wl_text_input_manager with @p name and @p version.
* If the @p name does not exist or is not for the text input interface in unstable version 0,
* @c null will be returned.
*
* Prefer using createTextInputManager instead.
* @see createTextInputManager
* @since 5.23
**/
wl_text_input_manager *bindTextInputManagerUnstableV0(uint32_t name, uint32_t version) const;
/**
* Binds the zwp_text_input_manager_v2 with @p name and @p version.
* If the @p name does not exist or is not for the text input interface in unstable version 2,
* @c null will be returned.
*
* Prefer using createTextInputManager instead.
* @see createTextInputManager
* @since 5.23
**/
zwp_text_input_manager_v2 *bindTextInputManagerUnstableV2(uint32_t name, uint32_t version) const;
/**
* Binds the xdg_shell (unstable version 5) with @p name and @p version.
* If the @p name does not exist or is not for the xdg shell interface in unstable version 5,
* @c null will be returned.
*
* Prefer using createXdgShell instead.
* @see createXdgShell
* @since 5.25
**/
xdg_shell *bindXdgShellUnstableV5(uint32_t name, uint32_t version) const;
/**
* Binds the zxdg_shell_v6 (unstable version 6) with @p name and @p version.
* If the @p name does not exist or is not for the xdg shell interface in unstable version 5,
* @c null will be returned.
*
* Prefer using createXdgShell instead.
* @see createXdgShell
* @since 5.39
**/
zxdg_shell_v6 *bindXdgShellUnstableV6(uint32_t name, uint32_t version) const;
/**
* Binds the zwp_relative_pointer_manager_v1 with @p name and @p version.
* If the @p name does not exist or is not for the relative pointer interface in unstable version 1,
* @c null will be returned.
*
* Prefer using createRelativePointerManager instead.
* @see createRelativePointerManager
* @since 5.28
**/
zwp_relative_pointer_manager_v1 *bindRelativePointerManagerUnstableV1(uint32_t name, uint32_t version) const;
/**
* Binds the zwp_pointer_gestures_v1 with @p name and @p version.
* If the @p name does not exist or is not for the pointer gestures interface in unstable version 1,
* @c null will be returned.
*
* Prefer using createPointerGestures instead.
* @see createPointerGestures
* @since 5.29
**/
zwp_pointer_gestures_v1 *bindPointerGesturesUnstableV1(uint32_t name, uint32_t version) const;
/**
* Binds the zwp_pointer_constraints_v1 with @p name and @p version.
* If the @p name does not exist or is not for the pointer constraints interface in unstable version 1,
* @c null will be returned.
*
* Prefer using createPointerConstraints instead.
* @see createPointerConstraints
* @since 5.29
**/
zwp_pointer_constraints_v1 *bindPointerConstraintsUnstableV1(uint32_t name, uint32_t version) const;
/**
* Binds the zxdg_exporter_v2 with @p name and @p version.
* If the @p name does not exists or isnot for the exporter
* extension in unstable version 1,
* @c null will be returned.
*
* Prefer using createXdgExporter
* @since 5.40
*/
zxdg_exporter_v2 *bindXdgExporterUnstableV2(uint32_t name, uint32_t version) const;
/**
* Binds the zxdg_importer_v2 with @p name and @p version.
* If the @p name does not exists or isnot for the importer
* extension in unstable version 1,
* @c null will be returned.
*
* Prefer using createXdgImporter
* @since 5.40
*/
zxdg_importer_v2 *bindXdgImporterUnstableV2(uint32_t name, uint32_t version) const;
/**
* Binds the zwp_idle_inhibit_manager_v1 with @p name and @p version.
* If the @p name does not exists or is not for the idle inhibit manager in unstable version 1,
* @c null will be returned.
*
* Prefer using createIdleInhibitManager
* @since 5.41
*/
zwp_idle_inhibit_manager_v1 *bindIdleInhibitManagerUnstableV1(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_appmenu_manager with @p name and @p version.
* If the @p name does not exist or is not for the appmenu manager interface,
* @c null will be returned.
*
* Prefer using createAppMenuManager instead.
* @see createAppMenuManager
* @since 5.42
**/
org_kde_kwin_appmenu_manager *bindAppMenuManager(uint32_t name, uint32_t version) const;
/**
* Binds the org_kde_kwin_server_decoration_palette_manager with @p name and @p version.
* If the @p name does not exist or is not for the server side decoration palette manager interface,
* @c null will be returned.
*
* Prefer using createServerSideDecorationPaletteManager instead.
* @see createAppMenuManager
* @since 5.42
**/
org_kde_kwin_server_decoration_palette_manager *bindServerSideDecorationPaletteManager(uint32_t name, uint32_t version) const;
///@}
/**
* @name Convenient factory methods for global objects.
**/
///@{
/**
* Creates a Compositor and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_compositor interface,
* the returned Compositor will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_compositor interface to bind
* @param version The version or the wl_compositor interface to use
* @param parent The parent for Compositor
*
* @returns The created Compositor.
**/
Compositor *createCompositor(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a Seat and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_seat interface,
* the returned Seat will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_seat interface to bind
* @param version The version or the wl_seat interface to use
* @param parent The parent for Seat
*
* @returns The created Seat.
**/
Shell *createShell(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a Compositor and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_compositor interface,
* the returned Compositor will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_compositor interface to bind
* @param version The version or the wl_compositor interface to use
* @param parent The parent for Compositor
*
* @returns The created Compositor.
**/
Seat *createSeat(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a ShmPool and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_shm interface,
* the returned ShmPool will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_shm interface to bind
* @param version The version or the wl_shm interface to use
* @param parent The parent for ShmPool
*
* @returns The created ShmPool.
**/
ShmPool *createShmPool(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a SubCompositor and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_subcompositor interface,
* the returned SubCompositor will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_subcompositor interface to bind
* @param version The version or the wl_subcompositor interface to use
* @param parent The parent for SubCompositor
*
* @returns The created SubCompositor.
**/
SubCompositor *createSubCompositor(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an Output and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_output interface,
* the returned Output will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_output interface to bind
* @param version The version or the wl_output interface to use
* @param parent The parent for Output
*
* @returns The created Output.
**/
Output *createOutput(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an KWinOutputManagement and sets it up to manage the interface identified
* by @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_output interface,
* the returned KWinConnectors will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_outputmanagement interface to bind
* @param version The version or the org_kde_kwin_outputmanagement interface to use
* @param parent The parent for KWinOutputManagement
*
* @returns The created KWinOutputManagement.
* @since 5.5
**/
OutputManagement *createOutputManagement(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an OutputDevice and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_outputdevice interface,
* the returned OutputDevice will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_outputdevice interface to bind
* @param version The version or the org_kde_kwin_outputdevice interface to use
* @param parent The parent for OutputDevice
*
* @returns The created Output.
* @since 5.5
**/
OutputDevice *createOutputDevice(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a FullscreenShell and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the _wl_fullscreen_shell interface,
* the returned FullscreenShell will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the _wl_fullscreen_shell interface to bind
* @param version The version or the _wl_fullscreen_shell interface to use
* @param parent The parent for FullscreenShell
*
* @returns The created FullscreenShell.
* @since 5.5
**/
FullscreenShell *createFullscreenShell(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a DataDeviceManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the wl_data_device_manager interface,
* the returned DataDeviceManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the wl_data_device_manager interface to bind
* @param version The version or the wl_data_device_manager interface to use
* @param parent The parent for DataDeviceManager
*
* @returns The created DataDeviceManager.
**/
DataDeviceManager *createDataDeviceManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a PlasmaShell and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_plasma_shell interface,
* the returned PlasmaShell will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_plasma_shell interface to bind
* @param version The version or the org_kde_plasma_shell interface to use
* @param parent The parent for PlasmaShell
*
* @returns The created PlasmaShell.
* @since 5.4
**/
PlasmaShell *createPlasmaShell(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a PlasmaWindowManagement and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_plasma_window_management interface,
* the returned PlasmaWindowManagement will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_plasma_window_management interface to bind
* @param version The version or the org_kde_plasma_window_management interface to use
* @param parent The parent for PlasmaWindowManagement
*
* @returns The created PlasmaWindowManagement.
* @since 5.4
**/
PlasmaWindowManagement *createPlasmaWindowManagement(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an Idle and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_idle interface,
* the returned Idle will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_idle interface to bind
* @param version The version or the org_kde_kwin_idle interface to use
* @param parent The parent for Idle
*
* @returns The created Idle.
* @since 5.4
**/
Idle *createIdle(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a FakeInput and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_fake_input interface,
* the returned FakeInput will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_fake_input interface to bind
* @param version The version or the org_kde_kwin_fake_input interface to use
* @param parent The parent for FakeInput
*
* @returns The created FakeInput.
* @since 5.4
**/
FakeInput *createFakeInput(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a ShadowManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_shadow_manager interface,
* the returned ShadowManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_shadow_manager interface to bind
* @param version The version or the org_kde_kwin_shadow_manager interface to use
* @param parent The parent for ShadowManager
*
* @returns The created ShadowManager.
* @since 5.4
**/
ShadowManager *createShadowManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a BlurManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_blur_manager interface,
* the returned BlurManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_blur_manager interface to bind
* @param version The version or the org_kde_kwin_blur_manager interface to use
* @param parent The parent for BlurManager
*
* @returns The created BlurManager.
* @since 5.5
**/
BlurManager *createBlurManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a ContrastManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_contrast_manager interface,
* the returned ContrastManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_contrast_manager interface to bind
* @param version The version or the org_kde_kwin_contrast_manager interface to use
* @param parent The parent for ContrastManager
*
* @returns The created ContrastManager.
* @since 5.5
**/
ContrastManager *createContrastManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a SlideManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_slide_manager interface,
* the returned SlideManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_slide_manager interface to bind
* @param version The version or the org_kde_kwin_slide_manager interface to use
* @param parent The parent for SlideManager
*
* @returns The created SlideManager.
* @since 5.5
**/
SlideManager *createSlideManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a DpmsManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_dpms_manager interface,
* the returned DpmsManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_dpms_manager interface to bind
* @param version The version or the org_kde_kwin_dpms_manager interface to use
* @param parent The parent for DpmsManager
*
* @returns The created DpmsManager.
* @since 5.5
**/
DpmsManager *createDpmsManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a ServerSideDecorationManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_server_decoration_manager interface,
* the returned ServerSideDecorationManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_server_decoration_manager interface to bind
* @param version The version or the org_kde_kwin_server_decoration_manager interface to use
* @param parent The parent for ServerSideDecorationManager
*
* @returns The created ServerSideDecorationManager.
* @since 5.6
**/
ServerSideDecorationManager *createServerSideDecorationManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a TextInputManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li wl_text_input_manager
* @li zwp_text_input_manager_v2
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @param name The name of the interface to bind
* @param version The version of the interface to use
* @param parent The parent for the TextInputManager
*
* @returns The created TextInputManager
* @since 5.23
**/
TextInputManager *createTextInputManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an XdgShell and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li xdg_shell (Unstable version 5)
*
* If @p name is for one of the supported interfaces the corresponding shell will be created,
* otherwise @c null will be returned.
*
* @param name The name of the interface to bind
* @param version The version of the interface to use
* @param parent The parent for the XdgShell
*
* @returns The created XdgShell
* @since 5.25
**/
XdgShell *createXdgShell(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a RelativePointerManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zwp_relative_pointer_manager_v1
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @param name The name of the interface to bind
* @param version The version of the interface to use
* @param parent The parent for the RelativePointerManager
*
* @returns The created RelativePointerManager
* @since 5.28
**/
RelativePointerManager *createRelativePointerManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a PointerGestures and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zwp_pointer_gestures_v1
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @param name The name of the interface to bind
* @param version The version of the interface to use
* @param parent The parent for the PointerGestures
*
* @returns The created PointerGestures
* @since 5.29
**/
PointerGestures *createPointerGestures(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a PointerConstraints and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zwp_pointer_constraints_v1
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @param name The name of the interface to bind
* @param version The version of the interface to use
* @param parent The parent for the PointerConstraints
*
* @returns The created PointerConstraints
* @since 5.29
**/
PointerConstraints *createPointerConstraints(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an XdgExporter and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zxdg_exporter_v2
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @returns The created XdgExporter
* @since 5.40
*/
XdgExporter *createXdgExporter(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an XdgImporter and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zxdg_importer_v2
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @returns The created XdgImporter
* @since 5.40
*/
XdgImporter *createXdgImporter(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates an IdleInhibitManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* This factory method supports the following interfaces:
* @li zwp_idle_inhibit_manager_v1
*
* If @p name is for one of the supported interfaces the corresponding manager will be created,
* otherwise @c null will be returned.
*
* @returns The created IdleInhibitManager
* @since 5.41
*/
IdleInhibitManager *createIdleInhibitManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a AppMenuManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_appmenu_manager interface,
* the returned AppMenuManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_appmenu_manager interface to bind
* @param version The version or the org_kde_kwin_appmenu_manager interface to use
* @param parent The parent for AppMenuManager
*
* @returns The created AppMenuManager.
* @since 5.42
**/
AppMenuManager *createAppMenuManager(quint32 name, quint32 version, QObject *parent = nullptr);
/**
* Creates a ServerSideDecorationPaletteManager and sets it up to manage the interface identified by
* @p name and @p version.
*
* Note: in case @p name is invalid or isn't for the org_kde_kwin_appmenu_manager interface,
* the returned ServerSideDecorationPaletteManager will not be valid. Therefore it's recommended to call
* isValid on the created instance.
*
* @param name The name of the org_kde_kwin_server_decoration_palette_manager interface to bind
* @param version The version or the org_kde_kwin_server_decoration_palette_manager interface to use
* @param parent The parent for ServerSideDecorationPaletteManager
*
* @returns The created ServerSideDecorationPaletteManager.
* @since 5.42
**/
ServerSideDecorationPaletteManager *createServerSideDecorationPaletteManager(quint32 name, quint32 version, QObject *parent = nullptr);
///@}
/**
* cast operator to the low-level Wayland @c wl_registry
**/
operator wl_registry*();
/**
* cast operator to the low-level Wayland @c wl_registry
**/
operator wl_registry*() const;
/**
* @returns access to the low-level Wayland @c wl_registry
**/
wl_registry *registry();
Q_SIGNALS:
/**
* @name Interface announced signals.
**/
///@{
/**
* Emitted whenever a wl_compositor interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void compositorAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_shell interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void shellAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_seat interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void seatAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_shm interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void shmAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_subcompositor interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void subCompositorAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_output interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void outputAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a _wl_fullscreen_shell interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void fullscreenShellAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_data_device_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void dataDeviceManagerAnnounced(quint32 name, quint32 version);
void outputManagementAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_outputdevice interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.5
**/
void outputDeviceAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_plasma_shell interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.4
**/
void plasmaShellAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_plasma_window_management interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.4
**/
void plasmaWindowManagementAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_idle interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.4
**/
void idleAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_fake_input interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.4
**/
void fakeInputAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_shadow_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.4
**/
void shadowAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_blur_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.5
**/
void blurAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_contrast_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.5
**/
void contrastAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_slide_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.5
**/
void slideAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_dpms_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.5
**/
void dpmsAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_server_decoration_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.6
**/
void serverSideDecorationManagerAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a wl_text_input_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.23
**/
void textInputManagerUnstableV0Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zwp_text_input_manager_v2 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.23
**/
void textInputManagerUnstableV2Announced(quint32 name, quint32 version);
/**
* Emitted whenever a xdg_shell (unstable version 5) interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.25
**/
void xdgShellUnstableV5Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zxdg_shell_v6 (unstable version 6) interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.25
**/
void xdgShellUnstableV6Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zwp_relative_pointer_manager_v1 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.28
**/
void relativePointerManagerUnstableV1Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zwp_pointer_gestures_v1 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.29
**/
void pointerGesturesUnstableV1Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zwp_pointer_constraints_v1 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.29
**/
void pointerConstraintsUnstableV1Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zxdg_exporter_v2 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.40
*/
void exporterUnstableV2Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zxdg_importer_v2 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.40
*/
void importerUnstableV2Announced(quint32 name, quint32 version);
/**
* Emitted whenever a zwp_idle_inhibit_manager_v1 interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.41
*/
void idleInhibitManagerUnstableV1Announced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_appmenu_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.42
*/
void appMenuAnnounced(quint32 name, quint32 version);
/**
* Emitted whenever a org_kde_kwin_server_decoration_palette_manager interface gets announced.
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
* @since 5.42
*/
void serverSideDecorationPaletteManagerAnnounced(quint32 name, quint32 version);
///@}
/**
* @name Interface removed signals.
**/
///@{
/**
* Emitted whenever a wl_compositor interface gets removed.
* @param name The name for the removed interface
**/
void compositorRemoved(quint32 name);
/**
* Emitted whenever a wl_shell interface gets removed.
* @param name The name for the removed interface
**/
void shellRemoved(quint32 name);
/**
* Emitted whenever a wl_seat interface gets removed.
* @param name The name for the removed interface
**/
void seatRemoved(quint32 name);
/**
* Emitted whenever a wl_shm interface gets removed.
* @param name The name for the removed interface
**/
void shmRemoved(quint32 name);
/**
* Emitted whenever a wl_subcompositor interface gets removed.
* @param name The name for the removed interface
**/
void subCompositorRemoved(quint32 name);
/**
* Emitted whenever a wl_output interface gets removed.
* @param name The name for the removed interface
**/
void outputRemoved(quint32 name);
/**
* Emitted whenever a _wl_fullscreen_shell interface gets removed.
* @param name The name for the removed interface
**/
void fullscreenShellRemoved(quint32 name);
/**
* Emitted whenever a wl_data_device_manager interface gets removed.
* @param name The name for the removed interface
**/
void dataDeviceManagerRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_outputmanagement interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void outputManagementRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_outputdevice interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void outputDeviceRemoved(quint32 name);
/**
* Emitted whenever a org_kde_plasma_shell interface gets removed.
* @param name The name for the removed interface
* @since 5.4
**/
void plasmaShellRemoved(quint32 name);
/**
* Emitted whenever a org_kde_plasma_window_management interface gets removed.
* @param name The name for the removed interface
* @since 5.4
**/
void plasmaWindowManagementRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_idle interface gets removed.
* @param name The name for the removed interface
* @since 5.4
**/
void idleRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_fake_input interface gets removed.
* @param name The name for the removed interface
* @since 5.4
**/
void fakeInputRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_shadow_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.4
**/
void shadowRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_blur_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void blurRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_contrast_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void contrastRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_slide_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void slideRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_dpms_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.5
**/
void dpmsRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_server_decoration_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.6
**/
void serverSideDecorationManagerRemoved(quint32 name);
/**
* Emitted whenever a wl_text_input_manager interface gets removed.
* @param name The name for the removed interface
* @since 5.23
**/
void textInputManagerUnstableV0Removed(quint32 name);
/**
* Emitted whenever a zwp_text_input_manager_v2 interface gets removed.
* @param name The name for the removed interface
* @since 5.23
**/
void textInputManagerUnstableV2Removed(quint32 name);
/**
* Emitted whenever an xdg_shell (unstable version 5) interface gets removed.
* @param name The name for the removed interface
* @since 5.25
**/
void xdgShellUnstableV5Removed(quint32 name);
/**
* Emitted whenever an xdg_shell (unstable version 5) interface gets removed.
* @param name The name for the removed interface
* @since 5.25
**/
void xdgShellUnstableV6Removed(quint32 name);
/**
* Emitted whenever a zwp_relative_pointer_manager_v1 interface gets removed.
* @param name The name for the removed interface
* @since 5.28
**/
void relativePointerManagerUnstableV1Removed(quint32 name);
/**
* Emitted whenever a zwp_pointer_gestures_v1 interface gets removed.
* @param name The name for the removed interface
* @since 5.29
**/
void pointerGesturesUnstableV1Removed(quint32 name);
/**
* Emitted whenever a zwp_pointer_constraints_v1 interface gets removed.
* @param name The name for the removed interface
* @since 5.29
**/
void pointerConstraintsUnstableV1Removed(quint32 name);
/**
* Emitted whenever a zxdg_exporter_v2 interface gets removed.
* @param name The name for the removed interface
* @since 5.40
**/
void exporterUnstableV2Removed(quint32 name);
/**
* Emitted whenever a zxdg_importer_v2 interface gets removed.
* @param name The name for the removed interface
* @since 5.40
**/
void importerUnstableV2Removed(quint32 name);
/**
* Emitted whenever a zwp_idle_inhibit_manager_v1 interface gets removed.
* @param name The name of the removed interface
* @since 5.41
**/
void idleInhibitManagerUnstableV1Removed(quint32 name);
/**
* Emitted whenever a org_kde_kwin_appmenu_manager gets removed.
* @param name The name of the removed interface
* @since 5.42
**/
void appMenuRemoved(quint32 name);
/**
* Emitted whenever a org_kde_kwin_server_decoration_palette_manager gets removed.
* @param name The name of the removed interface
* @since 5.42
**/
void serverSideDecorationPaletteManagerRemoved(quint32 name);
///@}
/**
* Generic announced signal which gets emitted whenever an interface gets
* announced.
*
* This signal is emitted before the dedicated signals are handled. If one
* wants to know about one of the well-known interfaces use the dedicated
* signals instead. Especially the bind methods might fail before the dedicated
* signals are emitted.
*
* @param interface The interface (e.g. wl_compositor) which is announced
* @param name The name for the announced interface
* @param version The maximum supported version of the announced interface
**/
void interfaceAnnounced(QByteArray interface, quint32 name, quint32 version);
/**
* Generic removal signal which gets emitted whenever an interface gets removed.
*
* This signal is emitted after the dedicated signals are handled.
*
* @param name The name for the removed interface
**/
void interfaceRemoved(quint32 name);
/**
* Emitted when the Wayland display is done flushing the initial interface
* callbacks, announcing wl_display properties. This can be used to compress
* events. Note that this signal is emitted only after announcing interfaces,
* such as outputs, but not after receiving callbacks of interface properties,
* such as the output's geometry, modes, etc..
* This signal is emitted from the wl_display_sync callback.
**/
void interfacesAnnounced();
Q_SIGNALS:
/*
* Emitted when the registry has been destroyed rather than released
*/
void registryDestroyed();
private:
class Private;
QScopedPointer<Private> d;
};
}
}
#endif
|