doc: Proof reading fixes.
* Rendering problems * Incomplete type information * Obsolete type information * Missing type information * Missing return value * Incomplete return value type
This commit is contained in:
Emmanuel Lepage Vallee
parent
b8cd009b37
commit
75ab366769
|
|
@ -35,12 +35,12 @@ mouse.wibox = {}
|
|||
--
|
||||
-- @DOC_screen_client_snap_EXAMPLE@
|
||||
--
|
||||
-- @tfield integer snap.default_distance
|
||||
-- @tfield integer awful.mouse.snap.default_distance
|
||||
-- @tparam[opt=8] integer default_distance
|
||||
-- @see awful.mouse.snap
|
||||
|
||||
--- The default distance before activating screen edge snap.
|
||||
-- @tfield integer snap.aerosnap_distance
|
||||
-- @tfield integer awful.mouse.snap.aerosnap_distance
|
||||
-- @tparam[opt=16] integer aerosnap_distance
|
||||
-- @see awful.mouse.snap
|
||||
|
||||
|
|
@ -48,15 +48,15 @@ mouse.wibox = {}
|
|||
--
|
||||
--@DOC_awful_placement_aero_snap_EXAMPLE@
|
||||
--
|
||||
-- @tfield[opt=true] boolean snap.edge_enabled
|
||||
-- @tfield[opt=true] boolean awful.mouse.snap.edge_enabled
|
||||
-- @tparam boolean edge_enabled
|
||||
|
||||
--- Enable client to client snapping.
|
||||
-- @tfield[opt=true] boolean snap.client_enabled
|
||||
-- @tfield[opt=true] boolean awful.mouse.snap.client_enabled
|
||||
-- @tparam boolean client_enabled
|
||||
|
||||
--- Enable changing tag when a client is dragged to the edge of the screen.
|
||||
-- @tfield[opt=false] boolean drag_to_tag.enabled
|
||||
-- @tfield[opt=false] boolean awful.mouse.drag_to_tag.enabled
|
||||
-- @tparam boolean enabled
|
||||
|
||||
--- The snap outline background color.
|
||||
|
|
@ -65,7 +65,7 @@ mouse.wibox = {}
|
|||
|
||||
--- The snap outline width.
|
||||
-- @beautiful beautiful.snap_border_width
|
||||
-- @param integer
|
||||
-- @tparam integer snap_border_width
|
||||
|
||||
--- The snap outline shape.
|
||||
-- @beautiful beautiful.snap_shape
|
||||
|
|
@ -75,9 +75,17 @@ mouse.wibox = {}
|
|||
-- @beautiful beautiful.snapper_gap
|
||||
-- @tparam[opt=0] number snapper_gap
|
||||
|
||||
--- The resize cursor name.
|
||||
-- @beautiful beautiful.cursor_mouse_resize
|
||||
-- @tparam[opt=cross] string cursor
|
||||
|
||||
--- The move cursor name.
|
||||
-- @beautiful beautiful.cursor_mouse_move
|
||||
-- @tparam[opt=fleur] string cursor
|
||||
|
||||
--- Get the client object under the pointer.
|
||||
-- @deprecated awful.mouse.client_under_pointer
|
||||
-- @return The client object under the pointer, if one can be found.
|
||||
-- @treturn client|nil The client object under the pointer, if one can be found.
|
||||
-- @see current_client
|
||||
function mouse.client_under_pointer()
|
||||
gdebug.deprecate("Use mouse.current_client instead of awful.mouse.client_under_pointer()", {deprecated_in=4})
|
||||
|
|
@ -222,15 +230,15 @@ end
|
|||
|
||||
--- True if the left mouse button is pressed.
|
||||
-- @property is_left_mouse_button_pressed
|
||||
-- @param boolean
|
||||
-- @tparam boolean is_left_mouse_button_pressed
|
||||
|
||||
--- True if the right mouse button is pressed.
|
||||
-- @property is_right_mouse_button_pressed
|
||||
-- @param boolean
|
||||
-- @tparam boolean is_right_mouse_button_pressed
|
||||
|
||||
--- True if the middle mouse button is pressed.
|
||||
-- @property is_middle_mouse_button_pressed
|
||||
-- @param boolean
|
||||
-- @tparam boolean is_right_mouse_button_pressed
|
||||
|
||||
--- Add an `awful.button` based mousebinding to the global set.
|
||||
--
|
||||
|
|
@ -252,6 +260,7 @@ end
|
|||
-- no focused client. If your intent is too add a mousebinding which acts on
|
||||
-- the focused client do **not** use this
|
||||
--
|
||||
-- @staticfct awful.mouse.append_global_mousebindings
|
||||
-- @tparam table buttons A table of `awful.button` objects. Optionally, it can have
|
||||
-- a `group` entry. If set, the `group` property will be set on all `awful.buttons`
|
||||
-- objects.
|
||||
|
|
@ -387,11 +396,13 @@ end)
|
|||
-- @tparam[opt=nil] integer coords_table.y The mouse vertical position
|
||||
-- @tparam[opt=false] boolean silent Disable mouse::enter or mouse::leave events that
|
||||
-- could be triggered by the pointer when moving.
|
||||
-- @treturn integer table.x The horizontal position
|
||||
-- @treturn integer table.y The vertical position
|
||||
-- @treturn table table.buttons Table containing the status of buttons, e.g. field [1] is true
|
||||
-- when button 1 is pressed.
|
||||
-- @treturn table The coords. It contains the `x`, `y` and `buttons` keys.
|
||||
-- `buttons` contains the button number as key and a boolean as value (if it is
|
||||
-- pressed).
|
||||
-- @staticfct mouse.coords
|
||||
-- @see is_left_mouse_button_pressed
|
||||
-- @see is_right_mouse_button_pressed
|
||||
-- @see is_middle_mouse_button_pressed
|
||||
|
||||
capi.client.connect_signal("scanning", function()
|
||||
capi.client.emit_signal("request::default_mousebindings", "startup")
|
||||
|
|
|
|||
|
|
@ -33,14 +33,6 @@ local cursors = {
|
|||
["mouse.resize_bottom_right"] = "bottom_right_corner",
|
||||
}
|
||||
|
||||
--- The resize cursor name.
|
||||
-- @beautiful beautiful.cursor_mouse_resize
|
||||
-- @tparam[opt=cross] string cursor
|
||||
|
||||
--- The move cursor name.
|
||||
-- @beautiful beautiful.cursor_mouse_move
|
||||
-- @tparam[opt=fleur] string cursor
|
||||
|
||||
--- Set the resize mode.
|
||||
-- The available modes are:
|
||||
--
|
||||
|
|
|
|||
|
|
@ -191,13 +191,15 @@ local function snap_inside(g, sg, snap)
|
|||
end
|
||||
|
||||
--- Snap a client to the closest client or screen edge.
|
||||
--
|
||||
-- @function awful.mouse.snap
|
||||
-- @param c The client to snap.
|
||||
-- @param snap The pixel to snap clients.
|
||||
-- @param x The client x coordinate.
|
||||
-- @param y The client y coordinate.
|
||||
-- @param fixed_x True if the client isn't allowed to move in the x direction.
|
||||
-- @param fixed_y True if the client isn't allowed to move in the y direction.
|
||||
-- @tparam[opt=client.focus] client c The client to snap.
|
||||
-- @tparam integer snap The pixel to snap clients.
|
||||
-- @tparam integer x The client x coordinate.
|
||||
-- @tparam integer y The client y coordinate.
|
||||
-- @tparam boolean fixed_x True if the client isn't allowed to move in the x direction.
|
||||
-- @tparam boolean fixed_y True if the client isn't allowed to move in the y direction.
|
||||
-- @treturn table The new geometry.
|
||||
function module.snap(c, snap, x, y, fixed_x, fixed_y)
|
||||
snap = snap or module.default_distance
|
||||
c = c or capi.client.focus
|
||||
|
|
|
|||
|
|
@ -49,10 +49,10 @@ end
|
|||
|
||||
--- Get the square distance between a `screen` and a point.
|
||||
-- @deprecated awful.screen.getdistance_sq
|
||||
-- @param s Screen
|
||||
-- @param x X coordinate of point
|
||||
-- @param y Y coordinate of point
|
||||
-- @return The squared distance of the screen to the provided point.
|
||||
-- @tparam screen s Screen
|
||||
-- @tparam integer x X coordinate of point
|
||||
-- @tparam integer y Y coordinate of point
|
||||
-- @treturn number The squared distance of the screen to the provided point.
|
||||
-- @see screen.get_square_distance
|
||||
function screen.getdistance_sq(s, x, y)
|
||||
gdebug.deprecate("Use s:get_square_distance(x, y) instead of awful.screen.getdistance_sq", {deprecated_in=4})
|
||||
|
|
@ -90,7 +90,7 @@ end
|
|||
-- This moves the mouse pointer to the last known position on the new screen,
|
||||
-- or keeps its position relative to the current focused screen.
|
||||
-- @staticfct awful.screen.focus
|
||||
-- @tparam screen _screen Screen number (defaults / falls back to mouse.screen).
|
||||
-- @tparam screen screen Screen number (defaults / falls back to mouse.screen).
|
||||
-- @request client activate screen.focus granted The most recent focused client
|
||||
-- for this screen should be re-activated.
|
||||
function screen.focus(_screen)
|
||||
|
|
@ -134,8 +134,8 @@ end
|
|||
-- the specified direction.
|
||||
--
|
||||
-- @method get_next_in_direction
|
||||
-- @param self Screen.
|
||||
-- @param dir The direction, can be either "up", "down", "left" or "right".
|
||||
-- @tparam string dir The direction, can be either "up", "down", "left" or "right".
|
||||
-- @treturn screen The next screen.
|
||||
function screen.object.get_next_in_direction(self, dir)
|
||||
local sel = get_screen(self)
|
||||
if not sel then
|
||||
|
|
@ -156,7 +156,8 @@ end
|
|||
-- or keeps its position relative to the current focused screen.
|
||||
-- @staticfct awful.screen.focus_bydirection
|
||||
-- @tparam string dir The direction, can be either "up", "down", "left" or "right".
|
||||
-- @tparam screen s Screen.
|
||||
-- @tparam[opt=awful.screen.focused()] screen s Screen.
|
||||
-- @treturn screen The next screen.
|
||||
function screen.focus_bydirection(dir, s)
|
||||
local sel = get_screen(s or screen.focused())
|
||||
local target = sel:get_next_in_direction(dir)
|
||||
|
|
@ -228,8 +229,8 @@ end
|
|||
--- Get or set the screen padding.
|
||||
--
|
||||
-- @deprecated awful.screen.padding
|
||||
-- @param s The screen object to change the padding on
|
||||
-- @param[opt=nil] padding The padding, a table with 'top', 'left', 'right' and/or
|
||||
-- @tparam screen s The screen object to change the padding on.
|
||||
-- @tparam[opt=nil] table|integer|nil padding The padding, a table with 'top', 'left', 'right' and/or
|
||||
-- 'bottom' or a number value to apply set the same padding on all sides. Can be
|
||||
-- nil if you only want to retrieve padding
|
||||
-- @treturn table A table with left, right, top and bottom number values.
|
||||
|
|
@ -253,7 +254,7 @@ end
|
|||
-- @DOC_screen_padding_EXAMPLE@
|
||||
--
|
||||
-- @property padding
|
||||
-- @param table
|
||||
-- @tparam table padding
|
||||
-- @tfield integer table.left The padding on the left.
|
||||
-- @tfield integer table.right The padding on the right.
|
||||
-- @tfield integer table.top The padding on the top.
|
||||
|
|
@ -304,7 +305,7 @@ end
|
|||
-- * *property::outputs*
|
||||
--
|
||||
-- @property outputs
|
||||
-- @param table
|
||||
-- @tparam table outputs
|
||||
-- @tfield table table.name A table with the screen name as key (like `eDP1` on a laptop)
|
||||
-- @tfield integer table.mm_width The screen physical width.
|
||||
-- @tfield integer table.mm_height The screen physical height.
|
||||
|
|
@ -439,7 +440,7 @@ end
|
|||
-- default.
|
||||
--
|
||||
-- @property clients
|
||||
-- @param table The clients list, ordered from top to bottom.
|
||||
-- @tparam table clients The clients list, ordered from top to bottom.
|
||||
-- @see all_clients
|
||||
-- @see hidden_clients
|
||||
-- @see client.get
|
||||
|
|
@ -467,7 +468,7 @@ end
|
|||
-- This includes minimized clients and clients on hidden tags.
|
||||
--
|
||||
-- @property hidden_clients
|
||||
-- @param table The clients list, ordered from top to bottom.
|
||||
-- @tparam table hidden_clients The clients list, ordered from top to bottom.
|
||||
-- @see clients
|
||||
-- @see all_clients
|
||||
-- @see client.get
|
||||
|
|
@ -486,7 +487,7 @@ end
|
|||
--- All clients assigned to the screen.
|
||||
--
|
||||
-- @property all_clients
|
||||
-- @param table The clients list, ordered from top to bottom.
|
||||
-- @tparam table all_clients The clients list, ordered from top to bottom.
|
||||
-- @see clients
|
||||
-- @see hidden_clients
|
||||
-- @see client.get
|
||||
|
|
@ -513,7 +514,7 @@ end
|
|||
-- @DOC_screen_tiled_clients_EXAMPLE@
|
||||
--
|
||||
-- @property tiled_clients
|
||||
-- @param table The clients list, ordered from top to bottom.
|
||||
-- @tparam table tiled_clients The clients list, ordered from top to bottom.
|
||||
|
||||
--- Get tiled clients for the screen.
|
||||
--
|
||||
|
|
@ -548,7 +549,7 @@ function screen.connect_for_each_screen(func)
|
|||
capi.screen.connect_signal("added", func)
|
||||
end
|
||||
|
||||
--- Undo the effect of connect_for_each_screen.
|
||||
--- Undo the effect of `awful.screen.connect_for_each_screen`.
|
||||
-- @staticfct awful.screen.disconnect_for_each_screen
|
||||
-- @tparam function func The function that should no longer be called.
|
||||
function screen.disconnect_for_each_screen(func)
|
||||
|
|
@ -561,7 +562,7 @@ end
|
|||
-- `awful.tag.new` or `t:delete()` to alter this list.
|
||||
--
|
||||
-- @property tags
|
||||
-- @param table
|
||||
-- @tparam table tags
|
||||
-- @treturn table A table with all available tags.
|
||||
-- @readonly
|
||||
|
||||
|
|
@ -585,7 +586,7 @@ end
|
|||
|
||||
--- A list of all selected tags on the screen.
|
||||
-- @property selected_tags
|
||||
-- @param table
|
||||
-- @tparam table selected_tags
|
||||
-- @treturn table A table with all selected tags.
|
||||
-- @readonly
|
||||
-- @see tag.selected
|
||||
|
|
@ -605,7 +606,7 @@ end
|
|||
|
||||
--- The first selected tag.
|
||||
-- @property selected_tag
|
||||
-- @param tag
|
||||
-- @tparam tag selected_tag
|
||||
-- @treturn ?tag The first selected tag or nil.
|
||||
-- @readonly
|
||||
-- @see tag.selected
|
||||
|
|
@ -753,16 +754,16 @@ end
|
|||
-- screen is duplicated on a projector).
|
||||
--
|
||||
-- @property dpi
|
||||
-- @param number the DPI value.
|
||||
-- @tparam number dpi The DPI value.
|
||||
|
||||
--- The lowest density DPI from all of the (physical) outputs.
|
||||
-- @property minimum_dpi
|
||||
-- @param number the DPI value.
|
||||
-- @tparam number minimum_dpi The DPI value.
|
||||
-- @readonly
|
||||
|
||||
--- The highest density DPI from all of the (physical) outputs.
|
||||
-- @property maximum_dpi
|
||||
-- @param number the DPI value.
|
||||
-- @tparam number maximum_dpi The DPI value.
|
||||
-- @readonly
|
||||
|
||||
--- The preferred DPI from all of the (physical) outputs.
|
||||
|
|
@ -771,28 +772,28 @@ end
|
|||
-- the lowest of the resulting virtual DPIs.
|
||||
--
|
||||
-- @property preferred_dpi
|
||||
-- @param number the DPI value.
|
||||
-- @tparam number preferred_dpi the DPI value.
|
||||
-- @readonly
|
||||
|
||||
--- The maximum diagonal size in millimeters.
|
||||
--
|
||||
-- @property mm_maximum_size
|
||||
-- @param number
|
||||
-- @tparam number mm_maximum_size
|
||||
|
||||
--- The minimum diagonal size in millimeters.
|
||||
--
|
||||
-- @property mm_minimum_size
|
||||
-- @param number
|
||||
-- @tparam number mm_minimum_size
|
||||
|
||||
--- The maximum diagonal size in inches.
|
||||
--
|
||||
-- @property inch_maximum_size
|
||||
-- @param number
|
||||
-- @tparam number inch_maximum_size
|
||||
|
||||
--- The minimum diagonal size in inches.
|
||||
--
|
||||
-- @property inch_minimum_size
|
||||
-- @param number
|
||||
-- @tparam number inch_minimum_size
|
||||
|
||||
--- Emitted when a new screen is added.
|
||||
--
|
||||
|
|
|
|||
|
|
@ -205,8 +205,8 @@ end
|
|||
|
||||
--- Move a tag to an absolute position in the screen[]:tags() table.
|
||||
-- @deprecated awful.tag.move
|
||||
-- @param new_index Integer absolute position in the table to insert.
|
||||
-- @param target_tag The tag that should be moved. If null, the currently
|
||||
-- @tparam integer new_index Integer absolute position in the table to insert.
|
||||
-- @tparam tag target_tag The tag that should be moved. If null, the currently
|
||||
-- selected tag is used.
|
||||
-- @see index
|
||||
function tag.move(new_index, target_tag)
|
||||
|
|
@ -243,8 +243,8 @@ end
|
|||
--- Swap 2 tags
|
||||
-- @deprecated awful.tag.swap
|
||||
-- @see tag.swap
|
||||
-- @param tag1 The first tag
|
||||
-- @param tag2 The second tag
|
||||
-- @tparam tag tag1 The first tag
|
||||
-- @tparam tag tag2 The second tag
|
||||
function tag.swap(tag1, tag2)
|
||||
gdebug.deprecate("Use t:swap(tag2) instead of awful.tag.swap", {deprecated_in=4})
|
||||
|
||||
|
|
@ -263,7 +263,7 @@ end
|
|||
-- @constructorfct awful.tag.add
|
||||
-- @tparam string name The tag name, a string
|
||||
-- @tparam[opt=nil] table|nil props The tags initial properties, a table
|
||||
-- @return The created tag
|
||||
-- @treturn tag The created tag.
|
||||
-- @see tag.delete
|
||||
function tag.add(name, props)
|
||||
local properties = props or {}
|
||||
|
|
@ -397,7 +397,7 @@ end
|
|||
-- stickied tags to.
|
||||
-- @tparam[opt=false] boolean force Move even non-sticky clients to the fallback
|
||||
-- tag.
|
||||
-- @return Returns true if the tag is successfully deleted.
|
||||
-- @treturn boolean Returns true if the tag is successfully deleted.
|
||||
-- If there are no clients exclusively on this tag then delete it. Any
|
||||
-- stickied clients are assigned to the optional 'fallback_tag'.
|
||||
-- If after deleting the tag there is no selected tag, try and restore from
|
||||
|
|
@ -465,9 +465,9 @@ end
|
|||
--- Delete a tag.
|
||||
-- @deprecated awful.tag.delete
|
||||
-- @see tag.delete
|
||||
-- @param target_tag Optional tag object to delete. [selected()]
|
||||
-- @param fallback_tag Tag to assign stickied tags to. [~selected()]
|
||||
-- @return Returns true if the tag is successfully deleted, nil otherwise.
|
||||
-- @tparam tag target_tag Optional tag object to delete. [selected()]
|
||||
-- @tparam tag|nil fallback_tag Tag to assign stickied tags to. [~selected()]
|
||||
-- @treturn boolean Returns true if the tag is successfully deleted, nil otherwise.
|
||||
-- If there are no clients exclusively on this tag then delete it. Any
|
||||
-- stickied clients are assigned to the optional 'fallback_tag'.
|
||||
-- If after deleting the tag there is no selected tag, try and restore from
|
||||
|
|
@ -558,7 +558,7 @@ end
|
|||
--- Get a list of all tags on a screen
|
||||
-- @deprecated awful.tag.gettags
|
||||
-- @tparam screen s Screen
|
||||
-- @return A table with all available tags
|
||||
-- @treturn table A table with all available tags
|
||||
-- @see screen.tags
|
||||
function tag.gettags(s)
|
||||
gdebug.deprecate("Use s.tags instead of awful.tag.gettags", {deprecated_in=4})
|
||||
|
|
@ -571,7 +571,7 @@ end
|
|||
--- Find a tag by name.
|
||||
-- @tparam screen s The screen of the tag
|
||||
-- @tparam string name The name of the tag
|
||||
-- @return The tag found, or `nil`
|
||||
-- @treturn tag|nil The tag found, or `nil`
|
||||
-- @staticfct awful.tag.find_by_name
|
||||
-- @usage -- For the current screen
|
||||
-- local t = awful.tag.find_by_name(awful.screen.focused(), "name")
|
||||
|
|
@ -637,8 +637,8 @@ end
|
|||
--- Set a tag's screen
|
||||
-- @deprecated awful.tag.setscreen
|
||||
-- @see screen
|
||||
-- @param s Screen
|
||||
-- @param t tag object
|
||||
-- @tparam screen s Screen
|
||||
-- @tparam tag t tag object
|
||||
function tag.setscreen(s, t)
|
||||
-- For API consistency, the arguments have been swapped for Awesome 3.6
|
||||
-- this method is already deprecated, so be silent and swap the args
|
||||
|
|
@ -654,8 +654,8 @@ end
|
|||
--- Get a tag's screen
|
||||
-- @deprecated awful.tag.getscreen
|
||||
-- @see screen
|
||||
-- @param[opt] t tag object
|
||||
-- @return Screen number
|
||||
-- @tparam[opt] tag|nil t tag object
|
||||
-- @treturn screen The tag screen.
|
||||
function tag.getscreen(t)
|
||||
gdebug.deprecate("Use t.screen instead of awful.tag.getscreen(t)", {deprecated_in=4})
|
||||
|
||||
|
|
@ -668,8 +668,8 @@ end
|
|||
|
||||
--- Return a table with all visible tags
|
||||
-- @deprecated awful.tag.selectedlist
|
||||
-- @param s Screen.
|
||||
-- @return A table with all selected tags.
|
||||
-- @tparam screen s Screen.
|
||||
-- @treturn table A table with all selected tags.
|
||||
-- @see screen.selected_tags
|
||||
function tag.selectedlist(s)
|
||||
gdebug.deprecate("Use s.selected_tags instead of awful.tag.selectedlist", {deprecated_in=4})
|
||||
|
|
@ -681,7 +681,7 @@ end
|
|||
|
||||
--- Return only the first visible tag.
|
||||
-- @deprecated awful.tag.selected
|
||||
-- @param s Screen.
|
||||
-- @tparam screen s Screen.
|
||||
-- @see screen.selected_tag
|
||||
function tag.selected(s)
|
||||
gdebug.deprecate("Use s.selected_tag instead of awful.tag.selected", {deprecated_in=4})
|
||||
|
|
@ -694,7 +694,7 @@ end
|
|||
--- The default master width factor
|
||||
--
|
||||
-- @beautiful beautiful.master_width_factor
|
||||
-- @param number (default: 0.5)
|
||||
-- @tparam number master_width_factor (default: 0.5)
|
||||
-- @see master_width_factor
|
||||
-- @see gap
|
||||
|
||||
|
|
@ -740,8 +740,8 @@ end
|
|||
-- @deprecated awful.tag.setmwfact
|
||||
-- @see master_fill_policy
|
||||
-- @see master_width_factor
|
||||
-- @param mwfact Master width factor.
|
||||
-- @param t The tag to modify, if null tag.selected() is used.
|
||||
-- @tparam number mwfact Master width factor.
|
||||
-- @tparam tag t The tag to modify, if null tag.selected() is used.
|
||||
function tag.setmwfact(mwfact, t)
|
||||
gdebug.deprecate("Use t.master_width_factor = mwfact instead of awful.tag.setmwfact", {deprecated_in=4})
|
||||
|
||||
|
|
@ -762,7 +762,7 @@ end
|
|||
-- @deprecated awful.tag.getmwfact
|
||||
-- @see master_width_factor
|
||||
-- @see master_fill_policy
|
||||
-- @param[opt] t The tag.
|
||||
-- @tparam[opt] tag|nil t The tag.
|
||||
function tag.getmwfact(t)
|
||||
gdebug.deprecate("Use t.master_width_factor instead of awful.tag.getmwfact", {deprecated_in=4})
|
||||
|
||||
|
|
@ -795,6 +795,8 @@ end
|
|||
-- }
|
||||
--
|
||||
-- @tfield table awful.tag.layouts
|
||||
-- @tparam[opt={}] table awful.tag.layouts
|
||||
-- @see request::layouts
|
||||
|
||||
--- The tag client layout.
|
||||
--
|
||||
|
|
@ -1003,7 +1005,7 @@ end
|
|||
-- @deprecated awful.tag.setlayout
|
||||
-- @see layout
|
||||
-- @param layout a layout table or a constructor function
|
||||
-- @param t The tag to modify
|
||||
-- @tparam tag t The tag to modify
|
||||
-- @return The layout
|
||||
function tag.setlayout(layout, t)
|
||||
gdebug.deprecate("Use t.layout = layout instead of awful.tag.setlayout", {deprecated_in=4})
|
||||
|
|
@ -1053,7 +1055,7 @@ end
|
|||
-- @deprecated awful.tag.setvolatile
|
||||
-- @see volatile
|
||||
-- @tparam boolean volatile If the tag must be deleted when the last client is untagged
|
||||
-- @param t The tag to modify, if null tag.selected() is used.
|
||||
-- @tparam tag t The tag to modify, if null tag.selected() is used.
|
||||
function tag.setvolatile(volatile, t)
|
||||
gdebug.deprecate("Use t.volatile = volatile instead of awful.tag.setvolatile", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1063,7 +1065,7 @@ end
|
|||
--- Get if the tag must be deleted when the last client closes
|
||||
-- @deprecated awful.tag.getvolatile
|
||||
-- @see volatile
|
||||
-- @param t The tag to modify, if null tag.selected() is used.
|
||||
-- @tparam tag t The tag to modify, if null tag.selected() is used.
|
||||
-- @treturn boolean If the tag will be deleted when the last client is untagged
|
||||
function tag.getvolatile(t)
|
||||
gdebug.deprecate("Use t.volatile instead of awful.tag.getvolatile", {deprecated_in=4})
|
||||
|
|
@ -1074,7 +1076,7 @@ end
|
|||
--- The default gap.
|
||||
--
|
||||
-- @beautiful beautiful.useless_gap
|
||||
-- @param number (default: 0)
|
||||
-- @tparam tag number (default: 0)
|
||||
-- @see gap
|
||||
-- @see gap_single_client
|
||||
|
||||
|
|
@ -1112,8 +1114,8 @@ end
|
|||
--- Set the spacing between clients
|
||||
-- @deprecated awful.tag.setgap
|
||||
-- @see gap
|
||||
-- @param useless_gap The spacing between clients
|
||||
-- @param t The tag to modify, if null tag.selected() is used.
|
||||
-- @tparam number|nil useless_gap The spacing between clients
|
||||
-- @tparam tag t The tag to modify, if null tag.selected() is used.
|
||||
function tag.setgap(useless_gap, t)
|
||||
gdebug.deprecate("Use t.gap = useless_gap instead of awful.tag.setgap", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1133,7 +1135,7 @@ end
|
|||
--- Enable gaps for a single client.
|
||||
--
|
||||
-- @beautiful beautiful.gap_single_client
|
||||
-- @param boolean (default: true)
|
||||
-- @tparam boolean gap_single_client (default: true)
|
||||
-- @see gap
|
||||
-- @see gap_single_client
|
||||
|
||||
|
|
@ -1199,7 +1201,7 @@ end
|
|||
-- `master_width_factor`
|
||||
--
|
||||
-- @beautiful beautiful.master_fill_policy
|
||||
-- @param string (default: "expand")
|
||||
-- @tparam string master_fill_policy (default: "expand")
|
||||
-- @see master_fill_policy
|
||||
|
||||
--- Set size fill policy for the master client(s).
|
||||
|
|
@ -1283,7 +1285,7 @@ end
|
|||
--- The default number of master windows.
|
||||
--
|
||||
-- @beautiful beautiful.master_count
|
||||
-- @param integer (default: 1)
|
||||
-- @tparam integer master_count (default: 1)
|
||||
-- @see master_count
|
||||
|
||||
--- Set the number of master windows.
|
||||
|
|
@ -1312,8 +1314,8 @@ end
|
|||
--- The number of master clients.
|
||||
-- @deprecated awful.tag.setnmaster
|
||||
-- @see master_count
|
||||
-- @param nmaster The number of master windows.
|
||||
-- @param[opt] t The tag.
|
||||
-- @tparam nmaster The number of master windows.
|
||||
-- @tparam[opt] tag t The tag.
|
||||
function tag.setnmaster(nmaster, t)
|
||||
gdebug.deprecate("Use t.master_count = nmaster instead of awful.tag.setnmaster", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1323,7 +1325,7 @@ end
|
|||
--- Get the number of master windows.
|
||||
-- @deprecated awful.tag.getnmaster
|
||||
-- @see master_count
|
||||
-- @param[opt] t The tag.
|
||||
-- @tparam[opt] tag t The tag.
|
||||
function tag.getnmaster(t)
|
||||
gdebug.deprecate("Use t.master_count instead of awful.tag.setnmaster", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1375,7 +1377,7 @@ end
|
|||
--- Set the tag icon
|
||||
-- @deprecated awful.tag.seticon
|
||||
-- @see icon
|
||||
-- @param icon the icon to set, either path or image object
|
||||
-- @tparam gears.surface|string icon the icon to set, either path or image object
|
||||
-- @tparam tag tag the tag
|
||||
function tag.seticon(icon, _tag)
|
||||
gdebug.deprecate("Use t.icon = icon instead of awful.tag.seticon", {deprecated_in=4})
|
||||
|
|
@ -1398,7 +1400,7 @@ end
|
|||
--- The default number of columns.
|
||||
--
|
||||
-- @beautiful beautiful.column_count
|
||||
-- @param integer (default: 1)
|
||||
-- @tparam integer column_count (default: 1)
|
||||
-- @see column_count
|
||||
|
||||
--- Set the number of columns.
|
||||
|
|
@ -1427,8 +1429,8 @@ end
|
|||
--- Set number of column windows.
|
||||
-- @deprecated awful.tag.setncol
|
||||
-- @see column_count
|
||||
-- @param ncol The number of column.
|
||||
-- @param t The tag to modify, if null tag.selected() is used.
|
||||
-- @tparam integer ncol The number of column.
|
||||
-- @tparam tag t The tag to modify, if null tag.selected() is used.
|
||||
function tag.setncol(ncol, t)
|
||||
gdebug.deprecate("Use t.column_count = new_index instead of awful.tag.setncol", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1442,7 +1444,7 @@ end
|
|||
--- Get number of column windows.
|
||||
-- @deprecated awful.tag.getncol
|
||||
-- @see column_count
|
||||
-- @param[opt] t The tag.
|
||||
-- @tparam[opt] tag t The tag.
|
||||
function tag.getncol(t)
|
||||
gdebug.deprecate("Use t.column_count instead of awful.tag.getncol", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1530,8 +1532,8 @@ end
|
|||
--- Get a tag's index in the gettags() table.
|
||||
-- @deprecated awful.tag.getidx
|
||||
-- @see index
|
||||
-- @param query_tag The tag object to find. [selected()]
|
||||
-- @return The index of the tag, nil if the tag is not found.
|
||||
-- @tparam tag query_tag The tag object to find. [selected()]
|
||||
-- @treturn integer|nil The index of the tag, nil if the tag is not found.
|
||||
function tag.getidx(query_tag)
|
||||
gdebug.deprecate("Use t.index instead of awful.tag.getidx", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1651,7 +1653,7 @@ end
|
|||
--
|
||||
-- @deprecated awful.tag.getdata
|
||||
-- @tparam tag t The tag.
|
||||
-- @return The data table.
|
||||
-- @treturn table The data table.
|
||||
function tag.getdata(t)
|
||||
return t._private.awful_tag_properties
|
||||
end
|
||||
|
|
@ -1679,8 +1681,8 @@ end
|
|||
-- Use `t.prop = value`
|
||||
--
|
||||
-- @deprecated awful.tag.setproperty
|
||||
-- @param t The tag.
|
||||
-- @param prop The property name.
|
||||
-- @tparam tag t The tag.
|
||||
-- @tparam string prop The property name.
|
||||
-- @param value The value.
|
||||
function tag.setproperty(t, prop, value)
|
||||
if not t._private.awful_tag_properties then
|
||||
|
|
@ -1695,7 +1697,7 @@ end
|
|||
|
||||
--- Tag a client with the set of current tags.
|
||||
-- @deprecated awful.tag.withcurrent
|
||||
-- @param c The client to tag.
|
||||
-- @tparam client c The client to tag.
|
||||
function tag.withcurrent(c)
|
||||
gdebug.deprecate("Use c:to_selected_tags() instead of awful.tag.selectedlist", {deprecated_in=4})
|
||||
|
||||
|
|
@ -1809,12 +1811,12 @@ capi.tag.connect_signal("request::select", tag.object.view_only)
|
|||
|
||||
--- Emitted when the number of urgent clients on this tag changes.
|
||||
-- @signal property::urgent
|
||||
-- @param boolean `true` if there is at least one urgent client on the tag.
|
||||
-- @tparam boolean urgent `true` if there is at least one urgent client on the tag.
|
||||
-- @see client.urgent
|
||||
|
||||
--- Emitted when the number of urgent clients on this tag changes.
|
||||
-- @signal property::urgent_count
|
||||
-- @param integer The number of urgent clients on the tag.
|
||||
-- @tparam integer count The number of urgent clients on the tag.
|
||||
-- @see client.urgent
|
||||
|
||||
--- Emitted when a screen is removed.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ gtable.crush(naughty, require("naughty.constants"))
|
|||
-- useful when watching movies or doing presentations.
|
||||
--
|
||||
-- @property suspended
|
||||
-- @param boolean
|
||||
-- @tparam boolean suspended
|
||||
-- @emits added
|
||||
-- @propemits true false
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ gtable.crush(naughty, require("naughty.constants"))
|
|||
-- just vanish.
|
||||
--
|
||||
-- @property expiration_paused
|
||||
-- @param[opt=false] boolean
|
||||
-- @tparam[opt=false] boolean expiration_paused
|
||||
-- @propemits true false
|
||||
|
||||
--- A table with all active notifications.
|
||||
|
|
@ -125,12 +125,12 @@ gtable.crush(naughty, require("naughty.constants"))
|
|||
-- * property::active
|
||||
--
|
||||
-- @property active
|
||||
-- @param table
|
||||
-- @tparam table active
|
||||
-- @propemits false false
|
||||
|
||||
--- True when there is a handler connected to `request::display`.
|
||||
-- @property has_display_handler
|
||||
-- @param boolean
|
||||
-- @tparam boolean has_display_handler
|
||||
|
||||
--- If the timeout needs to be reset when a property changes.
|
||||
--
|
||||
|
|
@ -148,7 +148,7 @@ gtable.crush(naughty, require("naughty.constants"))
|
|||
-- support for this and enabling it will cause bugs.
|
||||
--
|
||||
-- @property image_animations_enabled
|
||||
-- @param[opt=false] boolean
|
||||
-- @tparam[opt=false] boolean image_animations_enabled
|
||||
-- @propemits true false
|
||||
|
||||
--- Enable or disable the persistent notifications.
|
||||
|
|
@ -164,7 +164,7 @@ gtable.crush(naughty, require("naughty.constants"))
|
|||
-- that.
|
||||
--
|
||||
-- @property persistence_enabled
|
||||
-- @param[opt=false] boolean
|
||||
-- @tparam[opt=false] boolean persistence_enabled
|
||||
-- @propemits true false
|
||||
|
||||
local properties = {
|
||||
|
|
@ -339,9 +339,9 @@ end
|
|||
-- This function is deprecated in favor of
|
||||
-- `notification:destroy(reason, keep_visible)`.
|
||||
--
|
||||
-- @param notification Notification object to be destroyed
|
||||
-- @param reason One of the reasons from `notification_closed_reason`
|
||||
-- @param[opt=false] keep_visible If true, keep the notification visible
|
||||
-- @tparam naughty.notification notification Notification object to be destroyed
|
||||
-- @tparam string reason One of the reasons from `notification_closed_reason`
|
||||
-- @tparam[opt=false] boolean keep_visible If true, keep the notification visible
|
||||
-- @return True if the popup was successfully destroyed, nil otherwise
|
||||
-- @deprecated naughty.destroy
|
||||
function naughty.destroy(notification, reason, keep_visible)
|
||||
|
|
@ -385,8 +385,8 @@ end
|
|||
|
||||
--- Get notification by ID
|
||||
--
|
||||
-- @param id ID of the notification
|
||||
-- @return notification object if it was found, nil otherwise
|
||||
-- @tparam integer id ID of the notification
|
||||
-- @treturn naughty.notification|nil notification object if it was found, nil otherwise
|
||||
-- @deprecated naughty.getById
|
||||
function naughty.getById(id)
|
||||
gdebug.deprecate("Use naughty.get_by_id", {deprecated_in=5})
|
||||
|
|
@ -395,8 +395,8 @@ end
|
|||
|
||||
--- Get notification by ID
|
||||
--
|
||||
-- @param id ID of the notification
|
||||
-- @return notification object if it was found, nil otherwise
|
||||
-- @tparam integer id ID of the notification
|
||||
-- @treturn naughty.notification|nil notification object if it was found, nil otherwise
|
||||
-- @staticfct naughty.get_by_id
|
||||
function naughty.get_by_id(id)
|
||||
-- iterate the notifications to get the notfications with the correct ID
|
||||
|
|
|
|||
|
|
@ -901,49 +901,50 @@ end
|
|||
|
||||
--- Create a notification.
|
||||
--
|
||||
-- @tparam table args The argument table containing any of the arguments below.
|
||||
-- @string[opt=""] args.text Text of the notification.
|
||||
-- @string[opt] args.title Title of the notification.
|
||||
-- @int[opt=5] args.timeout Time in seconds after which popup expires.
|
||||
-- @tparam[opt={}] table args The argument table containing any of the arguments below.
|
||||
-- @tparam[opt=""] string args.text Text of the notification.
|
||||
-- @tparam[opt] string args.title Title of the notification.
|
||||
-- @tparam[opt=5] integer args.timeout Time in seconds after which popup expires.
|
||||
-- Set 0 for no timeout.
|
||||
-- @int[opt] args.hover_timeout Delay in seconds after which hovered popup disappears.
|
||||
-- @tparam[opt] number args.hover_timeout Delay in seconds after which hovered popup disappears.
|
||||
-- @tparam[opt=focused] integer|screen args.screen Target screen for the notification.
|
||||
-- @string[opt="top_right"] args.position Corner of the workarea displaying the popups.
|
||||
-- @tparam[opt="top_right"] string args.position Corner of the workarea displaying the popups.
|
||||
-- Values: `"top_right"`, `"top_left"`, `"bottom_left"`,
|
||||
-- `"bottom_right"`, `"top_middle"`, `"bottom_middle"`, `"middle"`.
|
||||
-- @bool[opt=true] args.ontop Boolean forcing popups to display on top.
|
||||
-- @int[opt=`beautiful.notification_height` or auto] args.height Popup height.
|
||||
-- @int[opt=`beautiful.notification_width` or auto] args.width Popup width.
|
||||
-- @string[opt=`beautiful.notification_font` or `beautiful.font` or `awesome.font`] args.font Notification font.
|
||||
-- @string[opt] args.icon Path to icon.
|
||||
-- @int[opt] args.icon_size Desired icon size in px.
|
||||
-- @string[opt=`beautiful.notification_fg` or `beautiful.fg_focus` or `'#ffffff'`] args.fg Foreground color.
|
||||
-- @string[opt=`beautiful.notification_fg` or `beautiful.bg_focus` or `'#535d6c'`] args.bg Background color.
|
||||
-- @int[opt=`beautiful.notification_border_width` or 1] args.border_width Border width.
|
||||
-- @string[opt=`beautiful.notification_border_color` or
|
||||
-- `beautiful.border_color_active` or `'#535d6c'`] args.border_color Border color.
|
||||
-- @tparam[opt=true] boolean args.ontop Boolean forcing popups to display on top.
|
||||
-- @tparam[opt=`beautiful.notification_height` or auto] integer args.height Popup height.
|
||||
-- @tparam[opt=`beautiful.notification_width` or auto] integer args.width Popup width.
|
||||
-- @tparam[opt=`beautiful.notification_font` or `beautiful.font` or `awesome.font`] string|lgi.Pango.FontDescription args.font Notification font.
|
||||
-- @tparam[opt] gears.surface args.icon Path to icon.
|
||||
-- @tparam[opt] integer args.icon_size Desired icon size in px.
|
||||
-- @tparam[opt=`beautiful.notification_fg` or `beautiful.fg_focus` or `'#ffffff'`] string args.fg Foreground color.
|
||||
-- @tparam[opt=`beautiful.notification_fg` or `beautiful.bg_focus` or `'#535d6c'`] string args.bg Background color.
|
||||
-- @tparam[opt=`beautiful.notification_border_width` or 1] integer args.border_width Border width.
|
||||
-- @tparam[opt=`beautiful.notification_border_color` or `beautiful.border_color_active` or `'#535d6c'`] gears.color args.border_color Border color.
|
||||
-- @tparam[opt=`beautiful.notification_shape`] gears.shape args.shape Widget shape.
|
||||
-- @tparam[opt=`beautiful.notification_opacity`] gears.opacity args.opacity Widget opacity.
|
||||
-- @tparam[opt=`beautiful.notification_margin`] gears.margin args.margin Widget margin.
|
||||
-- @tparam[opt] func args.run Function to run on left click. The notification
|
||||
-- @tparam[opt] function args.run Function to run on left click. The notification
|
||||
-- object will be passed to it as an argument.
|
||||
-- You need to call e.g.
|
||||
-- `notification.die(naughty.notification_closed_reason.dismissedByUser)` from
|
||||
-- there to dismiss the notification yourself.
|
||||
-- @tparam[opt] func args.destroy Function to run when notification is destroyed.
|
||||
-- @tparam[opt] function args.destroy Function to run when notification is destroyed.
|
||||
-- @tparam[opt] table args.preset Table with any of the above parameters.
|
||||
-- Note: Any parameters specified directly in args will override ones defined
|
||||
-- in the preset.
|
||||
-- @tparam[opt] func args.callback Function that will be called with all arguments.
|
||||
-- @tparam[opt] function args.callback Function that will be called with all arguments.
|
||||
-- The notification will only be displayed if the function returns true.
|
||||
-- Note: this function is only relevant to notifications sent via dbus.
|
||||
-- @tparam[opt] table args.actions A list of `naughty.action`s.
|
||||
-- @bool[opt=false] args.ignore_suspend If set to true this notification
|
||||
-- @tparam[opt=false] boolean args.ignore_suspend If set to true this notification
|
||||
-- will be shown even if notifications are suspended via `naughty.suspend`.
|
||||
-- @usage naughty.notify({ title = "Achtung!", message = "You're idling", timeout = 0 })
|
||||
-- @treturn ?table The notification object, or nil in case a notification was
|
||||
-- not displayed.
|
||||
-- @treturn naughty.notification A new notification object.
|
||||
-- @constructorfct naughty.notification
|
||||
-- @usage naughty.notification {
|
||||
-- title = "Achtung!",
|
||||
-- message = "You're idling", timeout = 0
|
||||
-- }
|
||||
local function create(args)
|
||||
if cst.config.notify_callback then
|
||||
args = cst.config.notify_callback(args)
|
||||
|
|
|
|||
31
luaa.c
31
luaa.c
|
|
@ -97,7 +97,7 @@ signal_array_t global_signals;
|
|||
*
|
||||
* This signal is used in the example configuration, @{05-awesomerc.md},
|
||||
* to let a notification box pop up.
|
||||
* @param err Table with the error object, can be converted to a string with
|
||||
* @tparam table err Table with the error object, can be converted to a string with
|
||||
* `tostring(err)`.
|
||||
* @signal debug::error
|
||||
*/
|
||||
|
|
@ -151,7 +151,7 @@ signal_array_t global_signals;
|
|||
/** Keyboard group has changed.
|
||||
*
|
||||
* It's used in `awful.widget.keyboardlayout` to redraw the layout.
|
||||
* @param group Integer containing the changed group
|
||||
* @tparam number group Integer containing the changed group
|
||||
* @signal xkb::group_changed.
|
||||
*/
|
||||
|
||||
|
|
@ -172,8 +172,8 @@ signal_array_t global_signals;
|
|||
*
|
||||
* This signal is emitted in the `atexit` handler as well when awesome
|
||||
* restarts.
|
||||
* @param reason_restart Boolean value is true if the signal was sent
|
||||
* because of a restart.
|
||||
* @tparam boolean reason_restart Boolean value is true if the signal was sent
|
||||
* because of a restart.
|
||||
* @signal exit
|
||||
*/
|
||||
|
||||
|
|
@ -244,7 +244,7 @@ luaA_quit(lua_State *L)
|
|||
/** Execute another application, probably a window manager, to replace
|
||||
* awesome.
|
||||
*
|
||||
* @param cmd The command line to execute.
|
||||
* @tparam string cmd The command line to execute.
|
||||
* @staticfct exec
|
||||
*/
|
||||
static int
|
||||
|
|
@ -302,7 +302,7 @@ luaA_sync(lua_State *L)
|
|||
*
|
||||
* @param pixbuf The pixbuf as a light user datum.
|
||||
* @param path The pixbuf origin path
|
||||
* @return A cairo surface as light user datum.
|
||||
* @treturn gears.surface A cairo surface as light user datum.
|
||||
* @staticfct pixbuf_to_surface
|
||||
*/
|
||||
static int
|
||||
|
|
@ -318,10 +318,9 @@ luaA_pixbuf_to_surface(lua_State *L)
|
|||
|
||||
/** Load an image from a given path.
|
||||
*
|
||||
* @param name The file name.
|
||||
* @return[1] A cairo surface as light user datum.
|
||||
* @return[2] nil
|
||||
* @treturn[2] string Error message
|
||||
* @tparam string name The file name.
|
||||
* @treturn gears.surface A cairo surface as light user datum.
|
||||
* @treturn nil|string The error message, if any.
|
||||
* @staticfct load_image
|
||||
*/
|
||||
static int
|
||||
|
|
@ -351,7 +350,7 @@ luaA_load_image(lua_State *L)
|
|||
* The closest equal or bigger size is picked if present, otherwise the closest
|
||||
* smaller size is picked. The default is 0 pixels, ie. the smallest icon.
|
||||
*
|
||||
* @param size The size of the icons in pixels.
|
||||
* @tparam integer size The size of the icons in pixels.
|
||||
* @staticfct set_preferred_icon_size
|
||||
*/
|
||||
static int
|
||||
|
|
@ -806,8 +805,8 @@ luaA_awesome_index(lua_State *L)
|
|||
|
||||
/** Add a global signal.
|
||||
*
|
||||
* @param name A string with the event name.
|
||||
* @param func The function to call.
|
||||
* @tparam string name A string with the event name.
|
||||
* @tparam function func The function to call.
|
||||
* @staticfct connect_signal
|
||||
*/
|
||||
static int
|
||||
|
|
@ -821,8 +820,8 @@ luaA_awesome_connect_signal(lua_State *L)
|
|||
|
||||
/** Remove a global signal.
|
||||
*
|
||||
* @param name A string with the event name.
|
||||
* @param func The function to call.
|
||||
* @tparam string name A string with the event name.
|
||||
* @tparam function func The function to call.
|
||||
* @staticfct disconnect_signal
|
||||
*/
|
||||
static int
|
||||
|
|
@ -838,7 +837,7 @@ luaA_awesome_disconnect_signal(lua_State *L)
|
|||
|
||||
/** Emit a global signal.
|
||||
*
|
||||
* @param name A string with the event name.
|
||||
* @tparam function name A string with the event name.
|
||||
* @param ... The signal arguments.
|
||||
* @staticfct emit_signal
|
||||
*/
|
||||
|
|
|
|||
4
mouse.c
4
mouse.c
|
|
@ -76,7 +76,7 @@ static int miss_newindex_handler = LUA_REFNIL;
|
|||
/**
|
||||
* The `screen` under the cursor
|
||||
* @property screen
|
||||
* @param screen
|
||||
* @tparam screen screen
|
||||
*/
|
||||
|
||||
/** Get the pointer position.
|
||||
|
|
@ -273,7 +273,7 @@ luaA_mouse_coords(lua_State *L)
|
|||
|
||||
/** Get the client or any object which is under the pointer.
|
||||
*
|
||||
* @treturn client.object|nil A client or nil.
|
||||
* @treturn client|wibox|nil A client, wibox or nil.
|
||||
* @staticfct object_under_pointer
|
||||
*/
|
||||
static int
|
||||
|
|
|
|||
|
|
@ -4351,7 +4351,7 @@ luaA_client_get_icon_sizes(lua_State *L, client_t *c)
|
|||
* (by raising an error, the function will be stopped and nothing will be
|
||||
* returned to the caller).
|
||||
*
|
||||
* @tparam interger index The index in the list of icons to get.
|
||||
* @tparam integer index The index in the list of icons to get.
|
||||
* @treturn surface A lightuserdata for a cairo surface. This reference must be
|
||||
* destroyed!
|
||||
* @method get_icon
|
||||
|
|
|
|||
|
|
@ -167,18 +167,17 @@
|
|||
/**
|
||||
* The screen coordinates.
|
||||
*
|
||||
* **Signal:**
|
||||
*
|
||||
* * *property::geometry*
|
||||
* The returned table contains the `x`, `y`, `width` and `height` keys.
|
||||
*
|
||||
* @DOC_screen_geometry_EXAMPLE@
|
||||
*
|
||||
* @property geometry
|
||||
* @param table
|
||||
* @tfield integer table.x The horizontal position
|
||||
* @tfield integer table.y The vertical position
|
||||
* @tfield integer table.width The width
|
||||
* @tfield integer table.height The height
|
||||
* @tparam table geometry
|
||||
* @tfield integer table.x The horizontal position.
|
||||
* @tfield integer table.y The vertical position.
|
||||
* @tfield integer table.width The width.
|
||||
* @tfield integer table.height The height.
|
||||
* @propemits false false
|
||||
* @readonly
|
||||
*/
|
||||
|
||||
|
|
@ -208,7 +207,7 @@
|
|||
* screen[1].answer = 42
|
||||
*
|
||||
* @property index
|
||||
* @param integer
|
||||
* @tparam integer index
|
||||
* @see screen
|
||||
* @readonly
|
||||
*/
|
||||
|
|
@ -222,26 +221,23 @@
|
|||
*
|
||||
* It can be modified be altering the `wibox` or `client` struts.
|
||||
*
|
||||
* **Signal:**
|
||||
*
|
||||
* * *property::workarea*
|
||||
*
|
||||
* @DOC_screen_workarea_EXAMPLE@
|
||||
*
|
||||
* @property workarea
|
||||
* @see client.struts
|
||||
* @param table
|
||||
* @tparam table workarea
|
||||
* @tfield integer table.x The horizontal position
|
||||
* @tfield integer table.y The vertical position
|
||||
* @tfield integer table.width The width
|
||||
* @tfield integer table.height The height
|
||||
* @propemits false false
|
||||
* @see client.struts
|
||||
* @readonly
|
||||
*/
|
||||
|
||||
|
||||
/** Get the number of instances.
|
||||
*
|
||||
* @return The number of screen objects alive.
|
||||
* @treturn table The number of screen objects alive.
|
||||
* @staticfct instances
|
||||
*/
|
||||
|
||||
|
|
@ -1657,7 +1653,7 @@ luaA_screen_get_name(lua_State *L, screen_t *s)
|
|||
|
||||
/** Get the number of screens.
|
||||
*
|
||||
* @return The screen count, at least 1.
|
||||
* @treturn number The screen count.
|
||||
* @staticfct count
|
||||
*/
|
||||
static int
|
||||
|
|
@ -1683,7 +1679,7 @@ luaA_screen_count(lua_State *L)
|
|||
* @tparam integer y Y-coordinate for screen.
|
||||
* @tparam integer width width for screen.
|
||||
* @tparam integer height height for screen.
|
||||
* @return The new screen.
|
||||
* @treturn screen The new screen.
|
||||
* @constructorfct fake_add
|
||||
*/
|
||||
static int
|
||||
|
|
|
|||
|
|
@ -286,7 +286,7 @@ lua_class_t tag_class;
|
|||
|
||||
/** Get the number of instances.
|
||||
*
|
||||
* @return The number of tag objects alive.
|
||||
* @treturn table The number of tag objects alive.
|
||||
* @staticfct instances
|
||||
*/
|
||||
|
||||
|
|
@ -457,7 +457,7 @@ luaA_tag_new(lua_State *L)
|
|||
*
|
||||
* @tparam[opt=nil] table clients_table None or a table of clients to set as being tagged with
|
||||
* this tag.
|
||||
* @return A table with the clients attached to this tags.
|
||||
* @treturn table A table with the clients attached to this tags.
|
||||
* @method clients
|
||||
*/
|
||||
static int
|
||||
|
|
|
|||
19
root.c
19
root.c
|
|
@ -427,7 +427,7 @@ luaA_root_buttons(lua_State *L)
|
|||
*
|
||||
*@DOC_cursor_c_COMMON@
|
||||
*
|
||||
* @param cursor_name A X cursor name.
|
||||
* @tparam string cursor_name A X cursor name.
|
||||
* @staticfct cursor
|
||||
*/
|
||||
static int
|
||||
|
|
@ -453,7 +453,7 @@ luaA_root_cursor(lua_State *L)
|
|||
|
||||
/** Get the drawins attached to a screen.
|
||||
*
|
||||
* @return A table with all drawins.
|
||||
* @treturn table A table with all drawins.
|
||||
* @staticfct drawins
|
||||
*/
|
||||
static int
|
||||
|
|
@ -474,7 +474,8 @@ luaA_root_drawins(lua_State *L)
|
|||
*
|
||||
* @param pattern A cairo pattern as light userdata
|
||||
* @return A cairo surface or nothing.
|
||||
* @staticfct wallpaper
|
||||
* @deprecated wallpaper
|
||||
* @see awful.wallpaper
|
||||
*/
|
||||
static int
|
||||
luaA_root_wallpaper(lua_State *L)
|
||||
|
|
@ -515,7 +516,7 @@ luaA_root_get_content(lua_State *L)
|
|||
surface = cairo_xcb_surface_create(globalconf.connection,
|
||||
globalconf.screen->root,
|
||||
globalconf.default_visual,
|
||||
globalconf.screen->width_in_pixels,
|
||||
globalconf.screen->width_in_pixels,
|
||||
globalconf.screen->height_in_pixels);
|
||||
|
||||
lua_pushlightuserdata(L, surface);
|
||||
|
|
@ -525,8 +526,8 @@ luaA_root_get_content(lua_State *L)
|
|||
|
||||
/** Get the size of the root window.
|
||||
*
|
||||
* @return Width of the root window.
|
||||
* @return height of the root window.
|
||||
* @treturn integer Width of the root window.
|
||||
* @treturn integer height of the root window.
|
||||
* @staticfct size
|
||||
*/
|
||||
static int
|
||||
|
|
@ -539,8 +540,8 @@ luaA_root_size(lua_State *L)
|
|||
|
||||
/** Get the physical size of the root window, in millimeter.
|
||||
*
|
||||
* @return Width of the root window, in millimeters.
|
||||
* @return height of the root window, in millimeters.
|
||||
* @treturn integer Width of the root window, in millimeters.
|
||||
* @treturn integer height of the root window, in millimeters.
|
||||
* @staticfct size_mm
|
||||
*/
|
||||
static int
|
||||
|
|
@ -552,7 +553,7 @@ luaA_root_size_mm(lua_State *L)
|
|||
}
|
||||
|
||||
/** Get the attached tags.
|
||||
* @return A table with all tags.
|
||||
* @treturn table A table with all tags.
|
||||
* @staticfct tags
|
||||
*/
|
||||
static int
|
||||
|
|
|
|||
Loading…
Reference in New Issue