awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

objects.client: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:27 -07:00
parent b662bf772f
commit 34f936b646
1 changed files with 109 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
objects/client.c
View File

@ -455,6 +455,8 @@ lua_class_t client_class;
*
* @property window
* @tparam integer window
* @propertydefault This is generated by X11.
* @negativeallowed false
* @propemits false false
* @readonly
*/
@ -467,6 +469,7 @@ lua_class_t client_class;
*
* @property name
* @tparam string name
* @propertydefault This is provided by the application.
* @propemits false false
* @see awful.titlebar
* @see awful.widget.tasklist
@ -530,6 +533,7 @@ lua_class_t client_class;
* @property type
* @tparam string type
* @propemits false false
* @propertydefault This is provided by the application.
* @readonly
* @see ruled.client
*/
@ -559,6 +563,7 @@ lua_class_t client_class;
* @property class
* @tparam string class
* @propemits false false
* @propertydefault This is provided by the application.
* @readonly
* @see instance
* @see ruled.client
@ -585,6 +590,7 @@ lua_class_t client_class;
*
* @property instance
* @tparam string instance
* @propertydefault This is provided by the application.
* @propemits false false
* @readonly
* @see class
@ -598,6 +604,8 @@ lua_class_t client_class;
*
* @property pid
* @tparam integer pid
* @negativeallowed false
* @propertydefault This is randomly assigned by the kernel.
* @propemits false false
* @readonly
*/
@ -607,6 +615,7 @@ lua_class_t client_class;
*
* @property role
* @tparam string role
* @propertydefault This is provided by the application.
* @propemits false false
* @readonly
* @see instance
@ -628,6 +637,8 @@ lua_class_t client_class;
*
* @property machine
* @tparam string machine
* @propertydefault This is the hostname unless the client is from an
* SSH session or using the rarely used direct X11 network socket.
* @propemits false false
* @readonly
*/
@ -637,6 +648,7 @@ lua_class_t client_class;
*
* @property icon_name
* @tparam string icon_name
* @propertydefault This is provided by the application.
* @propemits false false
* @readonly
*/
@ -668,7 +680,8 @@ lua_class_t client_class;
* smallest available)
*
* @property icon
* @tparam surface icon
* @tparam image icon
* @propertydefault This is provided by the application.
* @propemits false false
* @usage local ib = wibox.widget.imagebox(c.icon)
* @see awful.widget.clienticon
@ -688,6 +701,10 @@ lua_class_t client_class;
*
* @property icon_sizes
* @tparam table icon_sizes
* @tablerowtype A list of tables. Each table has the following rows:
* @tablerowkey integer 1 The width value.
* @tablerowkey integer 2 The height value.
* @propertydefault This is provided by the application.
* @propemits false false
* @readonly
* @see awful.widget.clienticon
@ -709,6 +726,8 @@ lua_class_t client_class;
*
* @property screen
* @tparam screen screen
* @propertydefault This usually correspond to where the top-left (or other
* gravities) is placed. Then it is mapped to the screen `geometry`.
* @propemits false false
* @see move_to_screen
*/
@ -717,7 +736,7 @@ lua_class_t client_class;
* Define if the client must be hidden (Never mapped, invisible in taskbar).
*
* @property hidden
* @tparam boolean hidden
* @tparam[opt=false] boolean hidden
* @propemits false false
* @see minimized
* @see skip_taskbar
@ -736,7 +755,7 @@ lua_class_t client_class;
* @DOC_sequences_client_minimize1_EXAMPLE@
*
* @property minimized
* @tparam boolean minimized
* @tparam[opt=false] boolean minimized
* @propemits false false
* @see hidden
* @see isvisible
@ -753,7 +772,7 @@ lua_class_t client_class;
* This is enabled by default. To disable it by default, see `ruled.client`.
*
* @property size_hints_honor
* @tparam boolean size_hints_honor
* @tparam[opt=true] boolean size_hints_honor
* @propemits false false
* @see size_hints
*/
@ -771,7 +790,10 @@ lua_class_t client_class;
* @DOC_awful_client_border_width_EXAMPLE@
*
* @property border_width
* @tparam integer border_width
* @tparam[opt=nil] integer|nil border_width
* @propertytype nil Let AwesomeWM manage it based on the client state.
* @negativeallowed false
* @propertyunit pixel
* @propemits false false
* @usebeautiful beautiful.border_width_active
* @usebeautiful beautiful.border_width_normal
@ -812,8 +834,9 @@ lua_class_t client_class;
* specifically. Other RGB colors with an alpha of `0` won't work.
*
* @property border_color
* @tparam color border_color Any string, gradient or pattern definition that
* can be converted to a cairo pattern.
* @tparam[opt=nil] color|nil border_color
* @propertytype nil Let AwesomeWM manage it based on the client state.
* @propertydefault
* @propemits false false
* @usebeautiful beautiful.border_color_marked The fallback color when the
* client is marked.
@ -872,7 +895,7 @@ lua_class_t client_class;
* @DOC_awful_client_urgent1_EXAMPLE@
*
* @property urgent
* @tparam boolean urgent
* @tparam[opt=false] boolean urgent
* @propemits false false
* @request client border active granted When a client becomes active and is no
* longer urgent.
@ -929,7 +952,9 @@ lua_class_t client_class;
* This property has no signals when the content changes.
*
* @property content
* @tparam surface content
* @tparam raw_curface content
* @propertydefault This is a live surface. Always use `gears.surface` to take
* a snapshot.
* @readonly
* @see gears.surface
*/
@ -944,7 +969,9 @@ lua_class_t client_class;
* @DOC_awful_client_opacity1_EXAMPLE@
*
* @property opacity
* @tparam number opacity Between 0 (transparent) to 1 (opaque).
* @tparam[opt=1.0] number opacity
* @rangestart 0.0 Transparent.
* @rangestop 1.0 Opaque.
* @propemits false false
* @see request::border
* @see awesome.composite_manager_running
@ -954,7 +981,7 @@ lua_class_t client_class;
* The client is on top of every other windows.
*
* @property ontop
* @tparam boolean ontop
* @tparam[opt=false] boolean ontop
* @propemits false false
* @see below
* @see above
@ -964,7 +991,7 @@ lua_class_t client_class;
* The client is above normal windows.
*
* @property above
* @tparam boolean above
* @tparam[opt=false] boolean above
* @propemits false false
* @see below
* @see ontop
@ -974,7 +1001,7 @@ lua_class_t client_class;
* The client is below normal windows.
*
* @property below
* @tparam boolean below
* @tparam[opt=false] boolean below
* @propemits false false
* @see above
* @see ontop
@ -986,7 +1013,7 @@ lua_class_t client_class;
* @DOC_sequences_client_fullscreen_EXAMPLE@
*
* @property fullscreen
* @tparam boolean fullscreen
* @tparam[opt=false] boolean fullscreen
* @propemits false false
* @request client geometry fullscreen granted When the client must be resized
* because it became (or stop being) fullscreen.
@ -1004,7 +1031,7 @@ lua_class_t client_class;
* @DOC_sequences_client_maximized_EXAMPLE@
*
* @property maximized
* @tparam boolean maximized
* @tparam[opt=false] boolean maximized
* @propemits false false
* @request client geometry maximized granted When the client must be resized
* because it became (or stop being) maximized.
@ -1022,7 +1049,7 @@ lua_class_t client_class;
* @DOC_sequences_client_maximized_horizontal_EXAMPLE@
*
* @property maximized_horizontal
* @tparam boolean maximized_horizontal
* @tparam[opt=false] boolean maximized_horizontal
* @propemits false false
* @request client geometry maximized_horizontal granted When the client must be resized
* because it became (or stop being) maximized horizontally.
@ -1039,7 +1066,7 @@ lua_class_t client_class;
* @DOC_sequences_client_maximized_vertical_EXAMPLE@
*
* @property maximized_vertical
* @tparam boolean maximized_vertical
* @tparam[opt=false] boolean maximized_vertical
* @propemits false false
* @request client geometry maximized_vertical granted When the client must be resized
* because it became (or stop being) maximized vertically.
@ -1065,7 +1092,7 @@ lua_class_t client_class;
* applications can belong to each other without being modal.
*
* @property transient_for
* @tparam client transient_for
* @tparam[opt=nil] client|nil transient_for
* @propemits false false
* @readonly
* @see modal
@ -1083,6 +1110,8 @@ lua_class_t client_class;
*
* @property group_window
* @tparam integer group_window
* @propertydefault This is auto-generated by X11.
* @negativeallowed false
* @propemits false false
* @readonly
* @see leader_window
@ -1094,7 +1123,9 @@ lua_class_t client_class;
* This is the ID of the group window, not a client object.
*
* @property leader_window
* @tparam number leader_window
* @tparam integer leader_window
* @propertydefault This is auto-generated by X11.
* @negativeallowed false
* @propemits false false
* @readonly
* @see transient_for
@ -1115,39 +1146,39 @@ lua_class_t client_class;
* advised to set `size_hints_honor` to `false` in the `ruled.client` rules.
*
* @property size_hints
* @tparam[opt] table|nil size_hints The hints.
* @tparam[opt] table|nil hints.user_position A table with `x` and `y` keys. It
* @tparam[opt=nil] table|nil size_hints
* @tparam[opt] table|nil size_hints.user_position A table with `x` and `y` keys. It
* contains the preferred position of the client. This is set when the
* position has been modified by the user. See `program_position`.
* @tparam[opt] table|nil hints.program_position A table with `x` and `y` keys. It
* @tparam[opt] table|nil size_hints.program_position A table with `x` and `y` keys. It
* contains the preferred position of the client. This is set when the
* application itself requests a specific position. See `user_position`.
* @tparam[opt] table|nil hints.user_size A table with `width` and `height`. This
* @tparam[opt] table|nil size_hints.user_size A table with `width` and `height`. This
* contains the client preferred size when it has previously been set by
* the user. See `program_size` for the equivalent when the applications
* itself wants to specify its preferred size.
* @tparam[opt] table|nil hints.program_size A table with `width` and `height`. This
* @tparam[opt] table|nil size_hints.program_size A table with `width` and `height`. This
* contains the client preferred size as specified by the application.
* @tparam[opt] integer|nil hints.max_width The maximum width (in pixels).
* @tparam[opt] integer|nil hints.max_height The maximum height (in pixels).
* @tparam[opt] integer|nil hints.min_width The minimum width (in pixels).
* @tparam[opt] integer|nil hints.min_height The minimum height (in pixels).
* @tparam[opt] integer|nil hints.width_inc The number of pixels by which the
* @tparam[opt] integer|nil size_hints.max_width The maximum width (in pixels).
* @tparam[opt] integer|nil size_hints.max_height The maximum height (in pixels).
* @tparam[opt] integer|nil size_hints.min_width The minimum width (in pixels).
* @tparam[opt] integer|nil size_hints.min_height The minimum height (in pixels).
* @tparam[opt] integer|nil size_hints.width_inc The number of pixels by which the
* client width may be increased or decreased. For example, for terminals,
* the size has to be proportional with the monospace font size.
* @tparam[opt] integer|nil hints.height_inc The number of pixels by which the
* @tparam[opt] integer|nil size_hints.height_inc The number of pixels by which the
* client height may be increased or decreased. For example, for terminals,
* the size has to be proportional with the monospace font size.
* @tparam[opt] string|nil hints.win_gravity The client `gravity` defines the corder
* @tparam[opt] string|nil size_hints.win_gravity The client `gravity` defines the corder
* from which the size is computed. For most clients, it is `north_west`, which
* corresponds to the top-left of the window. This will affect how the client
* is resized and other size related operations.
* @tparam[opt] integer|nil hints.min_aspect_num
* @tparam[opt] integer|nil hints.min_aspect_den
* @tparam[opt] integer|nil hints.max_aspect_num
* @tparam[opt] integer|nil hints.max_aspect_den
* @tparam[opt] integer|nil hints.base_width
* @tparam[opt] integer|nil hints.base_height
* @tparam[opt] integer|nil size_hints.min_aspect_num
* @tparam[opt] integer|nil size_hints.min_aspect_den
* @tparam[opt] integer|nil size_hints.max_aspect_num
* @tparam[opt] integer|nil size_hints.max_aspect_den
* @tparam[opt] integer|nil size_hints.base_width
* @tparam[opt] integer|nil size_hints.base_height
* @propemits false false
* @readonly
* @see size_hints_honor
@ -1166,24 +1197,24 @@ lua_class_t client_class;
* should be enabled.
*
* @property motif_wm_hints
* @tparam table motif_wm_hints The hints.
* @tparam[opt] boolean hints.functions.all
* @tparam[opt] boolean hints.functions.resize
* @tparam[opt] boolean hints.functions.move
* @tparam[opt] boolean hints.functions.minimize
* @tparam[opt] boolean hints.functions.maximize
* @tparam[opt] boolean hints.functions.close
* @tparam[opt] boolean hints.decorations.all
* @tparam[opt] boolean hints.decorations.border
* @tparam[opt] boolean hints.decorations.resizeh
* @tparam[opt] boolean hints.decorations.title
* @tparam[opt] boolean hints.decorations.menu
* @tparam[opt] boolean hints.decorations.minimize
* @tparam[opt] boolean hints.decorations.maximize
* @tparam[opt] string hints.input_mode This is either `modeless`,
* @tparam[opt={}] table motif_wm_hints
* @tparam[opt] boolean motif_wm_hints.functions.all
* @tparam[opt] boolean motif_wm_hints.functions.resize
* @tparam[opt] boolean motif_wm_hints.functions.move
* @tparam[opt] boolean motif_wm_hints.functions.minimize
* @tparam[opt] boolean motif_wm_hints.functions.maximize
* @tparam[opt] boolean motif_wm_hints.functions.close
* @tparam[opt] boolean motif_wm_hints.decorations.all
* @tparam[opt] boolean motif_wm_hints.decorations.border
* @tparam[opt] boolean motif_wm_hints.decorations.resizeh
* @tparam[opt] boolean motif_wm_hints.decorations.title
* @tparam[opt] boolean motif_wm_hints.decorations.menu
* @tparam[opt] boolean motif_wm_hints.decorations.minimize
* @tparam[opt] boolean motif_wm_hints.decorations.maximize
* @tparam[opt] string motif_wm_hints.input_mode This is either `modeless`,
* `primary_application_modal`, `system_modal`,
* `full_application_modal` or `unknown`.
* @tparam[opt] boolean hints.status.tearoff_window
* @tparam[opt] boolean motif_wm_hints.status.tearoff_window
* @propemits false false
* @readonly
*/
@ -1198,7 +1229,7 @@ lua_class_t client_class;
* @DOC_sequences_client_sticky_EXAMPLE@
*
* @property sticky
* @tparam boolean sticky
* @tparam[opt=false] boolean sticky
* @propemits false false
* @see skip_taskbar
*/
@ -1220,6 +1251,7 @@ lua_class_t client_class;
*
* @property modal
* @tparam boolean modal
* @propertydefault This is provided by the application.
* @propemits false false
* @see transient_for
*/
@ -1231,7 +1263,7 @@ lua_class_t client_class;
* click on it.
*
* @property focusable
* @tparam boolean focusable
* @tparam[opt=true] boolean focusable
* @propemits false false
* @see shape_input
* @see client.focus
@ -1251,7 +1283,8 @@ lua_class_t client_class;
* cases, use the `shape` property.
*
* @property shape_bounding
* @tparam surface shape_bounding
* @tparam image shape_bounding
* @propertydefault An A1 surface where all pixels are white.
* @propemits false false
* @see shape
* @see gears.surface.apply_shape_bounding
@ -1270,7 +1303,8 @@ lua_class_t client_class;
* border.
*
* @property shape_clip
* @tparam surface shape_clip
* @tparam image shape_clip
* @propertydefault An A1 surface where all pixels are white.
* @propemits false false
* @see shape_bounding
* @see shape_input
@ -1289,7 +1323,8 @@ lua_class_t client_class;
* client rather than propagated below it.
*
* @property shape_input
* @tparam surface shape_input
* @tparam image shape_input
* @propertydefault An A1 surface where all pixels are white.
* @propemits false false
* @see shape_bounding
* @see shape_clip
@ -1305,7 +1340,8 @@ lua_class_t client_class;
* The client's bounding shape as set by the program as a (native) cairo surface.
*
* @property client_shape_bounding
* @tparam surface client_shape_bounding
* @tparam image client_shape_bounding
* @propertydefault An A1 surface where all pixels are white.
* @propemits false false
* @readonly
* @see shape_bounding
@ -1322,7 +1358,8 @@ lua_class_t client_class;
* The client's clip shape as set by the program as a (native) cairo surface.
*
* @property client_shape_clip
* @tparam surface client_shape_clip
* @tparam image client_shape_clip
* @propertydefault An A1 surface where all pixels are white.
* @propemits false false
* @readonly
* @see shape_bounding
@ -1391,6 +1428,7 @@ lua_class_t client_class;
*
* @property startup_id
* @tparam string startup_id
* @propertydefault This is optionally provided by the application.
* @propemits false false
* @see awful.spawn
*/
@ -1403,7 +1441,7 @@ lua_class_t client_class;
* local is_valid = pcall(function() return c.valid end) and c.valid
*
* @property valid
* @tparam boolean valid
* @tparam[opt=true] boolean valid
* @propemits false false
* @readonly
* @see kill
@ -1417,7 +1455,7 @@ lua_class_t client_class;
* to only get the first tag and ignore everything else.
*
* @property first_tag
* @tparam tag first_tag
* @tparam[opt=nil] tag|nil first_tag
* @propemits false false
* @readonly
* @see tags
@ -1438,7 +1476,11 @@ lua_class_t client_class;
*
* @DOC_screen_struts_EXAMPLE@
*
* @tparam table struts A table with new strut values, or none.
* @tparam table|nil struts A table with new strut values, or none.
* @tparam[opt=0] integer struts.left
* @tparam[opt=0] integer struts.right
* @tparam[opt=0] integer struts.top
* @tparam[opt=0] integer struts.bottom
* @treturn table A table with strut values.
* @method struts
* @see geometry
@ -1449,7 +1491,8 @@ lua_class_t client_class;
/** Get or set mouse buttons bindings for a client.
*
* @property buttons
* @tparam table buttons
* @tparam[opt={}] table buttons
* @tablerowtype A list of `awful.button`s objects.
* @propemits false false
* @see awful.button
* @see append_mousebinding
@ -4302,7 +4345,8 @@ luaA_client_set_shape_input(lua_State *L, client_t *c)
/** Get or set keys bindings for a client.
*
* @property keys
* @tparam table keys
* @tparam[opt={}] table keys
* @tablerowtype A list of `awful.key`s objects.
* @propemits false false
* @see awful.key
* @see append_keybinding