Copyright (c) 2026 PaganDE
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Protokół pozwala klientowi opublikować ETYKIETY swojego głównego menu
(np. Plik, Edycja, Widok, Pomoc), aby kompozytor mógł narysować je
w pasku tytułu rysowanym po stronie serwera (SSD) — w tym samym rzędzie
co przyciski minimalizuj/maksymalizuj/zamknij.
Podział odpowiedzialności jest celowy:
* KOMPOZYTOR rysuje tylko górny poziom menu (etykiety) i informuje klienta,
która etykieta została kliknięta,
* KLIENT zna ZAWARTOŚĆ swojego menu (pozycje, skróty, stany) i pokazuje
rozwinięcie po otrzymaniu zdarzenia `clicked`.
Dzięki temu każde menu może być inne (bo pochodzi od aplikacji), a mimo to
wygląda spójnie, bo jest rysowane w firmowym pasku PaganDE.
Uwaga: to rozszerzenie jest specyficzne dla PaganDE.
Punkt wejścia protokołu. Klient pobiera z niego obiekt menu dla swojej
powierzchni najwyższego poziomu.
Tworzy obiekt menu związany z powierzchnią `surface`. Jeśli klient
utworzy kilka obiektów dla tej samej powierzchni, obowiązuje ostatni
ustawiony zestaw etykiet.
Reprezentuje górny poziom menu aplikacji. Etykiety są rozdzielone
znakiem nowej linii ("\n"); pusta wartość oznacza brak menu
(kompozytor pokaże wtedy pojedynczy przycisk „burger”).
Ustawia (zastępuje) listę etykiet menu. Etykiety są rozdzielone znakiem
nowej linii. Kolejność odpowiada indeksom w zdarzeniu `clicked`.
Wysłanie pustego napisu usuwa menu.
Kompozytor informuje, że użytkownik kliknął etykietę o podanym
indeksie (0 = pierwsza etykieta z ostatniego `set_labels`). Klient
powinien wtedy pokazać zawartość tego menu.
`x` to pozioma pozycja LEWEJ krawędzi etykiety we współrzędnych
powierzchni klienta — dzięki temu klient może ustawić rozwinięcie
dokładnie pod właściwą etykietą, nie znając układu paska kompozytora.