comments: added short description to view_edge enum

This commit is contained in:
lynxy 2025-07-14 23:47:42 +02:00 committed by Hiroaki Yamamoto
parent 254f526f71
commit 2bcd8277c4

View file

@ -28,7 +28,6 @@
* In labwc, a view is a container for surfaces which can be moved around by * In labwc, a view is a container for surfaces which can be moved around by
* the user. In practice this means XDG toplevel and XWayland windows. * the user. In practice this means XDG toplevel and XWayland windows.
*/ */
enum view_type { enum view_type {
LAB_XDG_SHELL_VIEW, LAB_XDG_SHELL_VIEW,
#if HAVE_XWAYLAND #if HAVE_XWAYLAND
@ -59,6 +58,12 @@ enum view_axis {
VIEW_AXIS_INVALID = (1 << 2), VIEW_AXIS_INVALID = (1 << 2),
}; };
/**
* Edges to which a view can be snapped to. "All" is used as
* a catchall for every valid edge in order to simplify certain
* types of conditionals, but it is only valid for a selection
* of options in rc.xml.
*/
enum view_edge { enum view_edge {
VIEW_EDGE_INVALID = 0, VIEW_EDGE_INVALID = 0,