diff --git a/classes/awful.screenshot.html b/classes/awful.screenshot.html index fa4cf6322..31054b53a 100644 --- a/classes/awful.screenshot.html +++ b/classes/awful.screenshot.html @@ -424,7 +424,7 @@
directory | +directory | string |
Get screenshot directory property.
@@ -433,7 +433,7 @@ Object properties |
||||||||||||
prefix | +prefix | string |
Get screenshot prefix property.
@@ -442,7 +442,7 @@ Object properties |
||||||||||||
file_path | +file_path | string |
Get screenshot file path.
@@ -451,7 +451,7 @@ Object properties |
||||||||||||
file_name | +file_name | string |
Get screenshot file name.
@@ -460,7 +460,7 @@ Object properties |
||||||||||||
date_format | +date_format | string |
The date format used in the default suffix.
@@ -469,7 +469,7 @@ Object properties |
||||||||||||
cursor | +cursor | string |
The cursor used in interactive mode.
@@ -478,7 +478,7 @@ Object properties |
||||||||||||
interactive | +interactive | boolean |
Use the mouse to select an area (snipping tool).
@@ -487,7 +487,7 @@ Object properties |
||||||||||||
screen | +screen | screen or nil |
Get screenshot screen.
@@ -496,7 +496,7 @@ Object properties |
||||||||||||
client | +client | client or nil |
Get screenshot client.
@@ -505,7 +505,7 @@ Object properties |
||||||||||||
geometry | +geometry | table |
Get screenshot geometry.
@@ -514,7 +514,7 @@ Object properties |
||||||||||||
surface | +surface | nil or image |
Get screenshot surface.
@@ -524,7 +524,7 @@ Object properties |
||||||||||||
surfaces | +surfaces | table |
Get screenshot surfaces.
@@ -534,7 +534,7 @@ Object properties |
||||||||||||
minimum_size | +minimum_size | nil or integer or table |
Set a minimum size to save a screenshot.
@@ -543,7 +543,7 @@ Object properties |
||||||||||||
frame_color | +frame_color | color or nil |
The interactive frame color.
@@ -552,7 +552,7 @@ Object properties |
||||||||||||
frame_shape | +frame_shape | shape or nil |
The interactive frame shape.
@@ -561,7 +561,7 @@ Object properties |
||||||||||||
reject_buttons | +reject_buttons | table |
Define which mouse button exit the interactive snipping mode.
@@ -570,7 +570,7 @@ Object properties |
||||||||||||
accept_buttons | +accept_buttons | table |
Mouse buttons used to save the screenshot when using the interactive snipping mode.
@@ -579,7 +579,7 @@ Object properties |
||||||||||||
keygrabber | +keygrabber | awful.keygrabber |
The awful.keygrabber object used for the accept and reject keys.
@@ -589,7 +589,7 @@ Object properties |
||||||||||||
selected_geometry | +selected_geometry | nil or table |
The current interactive snipping mode seletion.
@@ -599,7 +599,7 @@ Object properties |
||||||||||||
auto_save_delay | +auto_save_delay | integer or nil |
Number of seconds before auto-saving (or entering the interactive snipper).
@@ -608,16 +608,16 @@ Object properties |
||||||||||||
auto_save_tick_duration | +auto_save_tick_duration | number |
- Duration between the "timer::tick" signals when using auto_save_delay.
+ Duration between the "timer::tick" signals when using auto_save_delay.
|
||||||||||||
content_widget | +content_widget | wibox.widget.imagebox |
Export this screenshot as an wibox.widget.imagebox instead of a file.
@@ -711,7 +711,7 @@ Signalstimer::started |
- Emitted when the auto_save_delay timer starts. + Emitted when the auto_save_delay timer starts. | @@ -721,7 +721,7 @@ | - Emitted after each elapsed second when auto_save_delay is set. + Emitted after each elapsed second when auto_save_delay is set. | @@ -731,7 +731,7 @@ | - Emitted when the auto_save_delay timer stops. + Emitted when the auto_save_delay timer stops. | @@ -837,7 +837,7 @@ | ||||||
screen | Optional | -awful.screenshot.screen | +awful.screenshot.screen | Get screenshot screen. | |||||||||||
client | Optional | -awful.screenshot.client | +awful.screenshot.client | Get screenshot client. | |||||||||||
awful.screenshot.file_name | -Get screenshot file name. | +- object properties | |
property::awful.screenshot.file_path
When the awful.screenshot.file_path value changes.property::file_path
When the file_path value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
file_path The new value affected to the property.new_value
file_path The new value affected to the property.awful.screenshot.file_path | -Get screenshot file path. | +- object properties | |
property::awful.screenshot.file_name
When the awful.screenshot.file_name value changes.property::file_name
When the file_name value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
file_name The new value affected to the property.new_value
file_name The new value affected to the property.property::awful.screenshot.date_format
When the awful.screenshot.date_format value changes.property::date_format
When the date_format value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
date_format The new value affected to the property.new_value
date_format The new value affected to the property.property::awful.screenshot.cursor
When the awful.screenshot.cursor value changes.property::cursor
When the cursor value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
cursor The new value affected to the property.new_value
cursor The new value affected to the property.property::awful.screenshot.interactive
When the awful.screenshot.interactive value changes.property::interactive
When the interactive value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
interactive The new value affected to the property.new_value
interactive The new value affected to the property.property::awful.screenshot.screen
When the awful.screenshot.screen value changes.property::screen
When the screen value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
screen The new value affected to the property.nil
mouse.current_client | +Get the client currently under the mouse cursor. (mouse) | ++ object properties + | +||||||||||||||||||
client.focus | Emitted when a client gains focus. (client) | @@ -1419,7 +1439,7 @@
+ + Table keys: + + | +
+ + x + + (number) + | +
+ + y + + (number) + | +
+ + width + + (number) + | +
+ + height + + (number) + | +
property::awful.screenshot.geometry
When the awful.screenshot.geometry value changes.property::geometry
When the geometry value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
geometry The new value affected to the property.new_value
geometry The new value affected to the property.If none, or only one of: screen, client or geometry is provided, then +
If none, or only one of: screen, client or geometry is provided, then this screenshot object will have a single target image. While specifying - multiple target isn't recommended, you can use the surfaces properties + multiple target isn't recommended, you can use the surfaces properties to access them.
Note that this is empty until either save or refresh is called. @@ -1551,9 +1615,8 @@
awful.screenshot.surfaces | -Get screenshot surfaces. | +- object properties | |
{}
or
geometry` have been set.geometry
property.awful.screenshot.surface | -Get screenshot surface. | +- object properties | |
property::awful.screenshot.minimum_size
When the awful.screenshot.minimum_size value changes.property::minimum_size
When the minimum_size value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
minimum_size The new value affected to the property.new_value
minimum_size The new value affected to the property.beautiful.awful_screenshot_awful_screenshot_frame_color
beautiful.awful_screenshot_frame_color
beautiful.screenshot_awful_screenshot_frame_color
.beautiful.screenshot_frame_color
.property::awful.screenshot.frame_color
When the awful.screenshot.frame_color value changes.property::frame_color
When the frame_color value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
frame_color The new value affected to the property.new_value
frame_color The new value affected to the property.beautiful.screenshot_awful_screenshot_frame_color
beautiful.awful_screenshot_awful_screenshot_frame_shape
beautiful.awful_screenshot_frame_shape
beautiful.screenshot_awful_screenshot_frame_shape
.beautiful.screenshot_frame_shape
.property::awful.screenshot.frame_shape
When the awful.screenshot.frame_shape value changes.property::frame_shape
When the frame_shape value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
frame_shape The new value affected to the property.new_value
frame_shape The new value affected to the property.beautiful.screenshot_awful_screenshot_frame_shape
awful.screenshot.accept_buttons | -Mouse buttons used to save the screenshot when using the interactive snipping mode. | +- object properties | |
property::awful.screenshot.reject_buttons
When the awful.screenshot.reject_buttons value changes.property::reject_buttons
When the reject_buttons value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
reject_buttons The new value affected to the property.new_value
reject_buttons The new value affected to the property.awful.screenshot.reject_buttons | -Define which mouse button exit the interactive snipping mode. | +- object properties | |
property::awful.screenshot.accept_buttons
When the awful.screenshot.accept_buttons value changes.property::accept_buttons
When the accept_buttons value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
accept_buttons The new value affected to the property.new_value
accept_buttons The new value affected to the property.+ + Table keys: + + | +|
+ + x + + (integer) + | +|
+ + y + + (integer) + | +|
+ + width + + (integer) + | +|
+ + height + + (integer) + | +|
+ + surface + + (image) + | +|
+ + method + + (string) + | +: Either "root" , "client" ,
+ "screen" or "geometry" . |
+
property::awful.screenshot.selected_geometry
When the awful.screenshot.selected_geometry value changes.property::selected_geometry
When the selected_geometry value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
selected_geometry The new value affected to the property.new_value
selected_geometry The new value affected to the property.property::awful.screenshot.auto_save_delay
When the awful.screenshot.auto_save_delay value changes.property::auto_save_delay
When the auto_save_delay value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
auto_save_delay The new value affected to the property.new_value
auto_save_delay The new value affected to the property."timer::tick"
signals when using auto_save_delay.
+ Duration between the "timer::tick"
signals when using auto_save_delay.
property::awful.screenshot.auto_save_tick_duration
When the awful.screenshot.auto_save_tick_duration value changes.property::auto_save_tick_duration
When the auto_save_tick_duration value changes.self
awful.screenshot The object which changed (useful when connecting many object to the same callback).new_value
auto_save_tick_duration The new value affected to the property.new_value
auto_save_tick_duration The new value affected to the property.true
if the screenshot were save, false
otherwise. It
- can be false
because the selection is below minimum_size or because
+ can be false
because the selection is below minimum_size or because
there is nothing to save (so selection).
@@ -2674,7 +2856,7 @@ Optional | string or nil | The method associated with the file_path. This - can be root, geometry, client or screen. | + can be root, geometry, client or screen.
children | +children | table |
Get or set the children elements.
@@ -409,7 +409,7 @@ Object properties |
||||||||||||||||||||||||
all_children | +all_children | table |
Get all direct and indirect children widgets.
@@ -418,7 +418,7 @@ Object properties |
||||||||||||||||||||||||
forced_height | +forced_height | number or nil |
Force a widget height.
@@ -427,7 +427,7 @@ Object properties |
||||||||||||||||||||||||
forced_width | +forced_width | number or nil |
Force a widget width.
@@ -436,7 +436,7 @@ Object properties |
||||||||||||||||||||||||
opacity | +opacity | number |
The widget opacity (transparency).
@@ -445,7 +445,7 @@ Object properties |
||||||||||||||||||||||||
visible | +visible | boolean |
The widget visibility.
@@ -454,7 +454,7 @@ Object properties |
||||||||||||||||||||||||
buttons | +buttons | table |
The widget buttons.
@@ -1234,7 +1234,7 @@ Object properties
See also:
See also:See also:
See also:See also:
See also:See also:
See also:See also:
See also:See also:
See also:FieldsAPIs. Testing your patches with mode and the default config is recommended before submitting a patch. - You can use the -l command line option or You can use the -l command line option or Deprecated functionsThose functions have been renamed or converted to methods:
|