gre-ilya/fltk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: replace HTML table with Doxygen table

Browse Source 
... for better readability in the source code.

Note: the documentation output is identical.
This commit is contained in:
Albrecht Schlosser 2026-01-08 19:05:16 +01:00
parent bc05edd385
commit 7fae181d95
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
documentation/src/wayland.dox
View File

@ -314,26 +314,29 @@ The prototype of function \c registry_handle_global is:
static void registry_handle_global(void *user_data, struct wl_registry *wl_registry,
uint32_t id, const char *interface, uint32_t version)
\endcode
Each time Wayland calls \c registry_handle_global(), \c interface and \c version give the name
and version of a component or feature of the Wayland system.
Here is the list of the \c interface value for all protocols and system features relevant for FLTK:
<table>
<tr><th>Interface </th><th>How FLTK uses this interface</th> </tr>
<tr><td>wl_compositor </td><td> create wl_surface objects </td> </tr>
<tr><td>wl_subcompositor </td><td>create subwindows </td> </tr>
<tr><td>wl_shm </td><td> create shared memory pools and buffers</td> </tr>
<tr><td>wl_seat </td><td> create the unique "seat"</td> </tr>
<tr><td>wl_data_device </td><td> support of copy/paste/drag-n-drop</td> </tr>
<tr><td>wl_output </td><td>received once for each display </td> </tr>
<tr><td>xdg_wm_base </td><td>create mapped windows </td> </tr>
<tr><td>xdg_wm_dialog_v1 </td><td>create dialogs related to other windows</td> </tr>
<tr><td>wp_cursor_shape_manager_v1 </td><td>set cursor images using enumerated cursors </td></tr>
<tr><td>gtk_shell1 </td><td>indicates Mutter is in use + titlebar gestures</td> </tr>
<tr><td>weston_desktop_shell </td><td> indicates Weston is in use</td></tr>
<tr><td>org_kde_plasma_shell </td><td> indicates KDE/Plasma is in use</td></tr>
<tr><td>zwp_text_input_manager_v3 </td><td>interface with Text Input Methods </td></tr>
<tr><td>zxdg_decoration_manager_v1 </td><td>select between CSD and SSD modes </td></tr>
</table>
Interface | How FLTK uses this interface
-----------------------------------|-----------------------------------------------
wl_compositor | create wl_surface objects
wl_subcompositor | create subwindows
wl_shm | create shared memory pools and buffers
wl_seat | create the unique "seat"
wl_data_device | support of copy/paste/drag-n-drop
wl_output | received once for each display
xdg_wm_base | create mapped windows
xdg_wm_dialog_v1 | create dialogs related to other windows
wp_cursor_shape_manager_v1 | set cursor images using enumerated cursors
gtk_shell1 | indicates Mutter is in use + titlebar gestures
weston_desktop_shell | indicates Weston is in use
org_kde_plasma_shell | indicates KDE/Plasma is in use
zwp_text_input_manager_v3 | interface with Text Input Methods
zxdg_decoration_manager_v1 | select between CSD and SSD modes
Wayland compositors typically support several other protocols (e.g., \c zxdg_output_manager_v1)
that FLTK does not use.