Module: awful.widget.prompt

The widget version of awful.prompt.

local myprompt = awful.widget.prompt {
    prompt = "Execute: "
}
myprompt:run()

Class Hierarchy

Info:

Constructors

awful.widget.prompt {[args]} Create a prompt widget which will launch a command.

Object properties

with_shell boolean Always spawn using a shell.
widget widget or nil The widget displayed in the background widget. Inherited from wibox.container.background
bg color The background color/pattern/gradient to use. Inherited from wibox.container.background
fg color The foreground (text) color/pattern/gradient to use. Inherited from wibox.container.background
shape shape The background shape. Inherited from wibox.container.background
border_width number Add a border of a specific width. Inherited from wibox.container.background
border_color color Set the color for the border. Inherited from wibox.container.background
border_strategy string How the border width affects the contained widget. Inherited from wibox.container.background
bgimage image or nil The background image to use. Inherited from wibox.container.background
children table Get or set the children elements. Inherited from wibox.widget.base
all_children table Get all direct and indirect children widgets. Inherited from wibox.widget.base
forced_height number or nil Force a widget height. Inherited from wibox.widget.base
forced_width number or nil Force a widget width. Inherited from wibox.widget.base
opacity number The widget opacity (transparency). Inherited from wibox.widget.base
visible boolean The widget visibility. Inherited from wibox.widget.base
buttons table The widget buttons. Inherited from wibox.widget.base

Theme variables

beautiful.prompt_fg color The prompt foreground color.
beautiful.prompt_bg color The prompt background color.

Deprecated object properties

shape_border_width number When a shape is set, also draw a border. Deprecated Inherited from wibox.container.background
shape_border_color color When a shape is set, also draw a border. Deprecated Inherited from wibox.container.background

Object methods

:set_shape (shape) Set the background shape. Inherited from wibox.container.background
:add_button (button) Add a new awful.button to this widget. Inherited from wibox.widget.base
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. Inherited from wibox.widget.base
:index (widget, recursive, ...) -> (number, widget, table) Get the index of a widget. Inherited from wibox.widget.base
:connect_signal (name, func) Connect to a signal. Inherited from gears.object
:weak_connect_signal (name, func) Connect to a signal weakly. Inherited from gears.object
:disconnect_signal (name, func) Disonnect from a signal. Inherited from gears.object
:emit_signal (name, ...) Emit a signal. Inherited from gears.object

Signals

widget::layout_changed When the layout (size) change. Inherited from wibox.widget.base
widget::redraw_needed When the widget content changed. Inherited from wibox.widget.base
button::press When a mouse button is pressed over the widget. Inherited from wibox.widget.base
button::release When a mouse button is released over the widget. Inherited from wibox.widget.base
mouse::enter When the mouse enter a widget. Inherited from wibox.widget.base
mouse::leave When the mouse leave a widget. Inherited from wibox.widget.base


Constructors

🔗 awful.widget.prompt {[args]} · 4 theme variables
Create a prompt widget which will launch a command. For additional documentation about args parameter, please refer to awful.prompt and awful.prompt.run.

Parameters:

Note: This constructors uses named parameters calling convention. It means you call it with {} and omit the parantheses. For example, calling this will all default argument would be awful.widget.prompt{}. This is a Lua shortcut syntax equivalent to awful.widget.prompt({}). args is only a placeholder name for the "lone table argument" used in named parameters calls.
Name Type(s) Description Default value
args table Prompt arguments. Not applicable
prompt Optional string Prompt text. "Run: "
bg Optional color Prompt background color. `beautiful.prompt_bg` or `beautiful.bg_normal`
fg Optional color Prompt foreground color. `beautiful.prompt_fg` or `beautiful.fg_normal`
fg_cursor Optional gears.color beautiful.prompt_fg_cursor
bg_cursor Optional gears.color beautiful.prompt_bg_cursor
ul_cursor Optional gears.color Undefined
font Optional string beautiful.prompt_font
autoexec Optional boolean Undefined
highlighter Optional function A function to add syntax highlighting to the command. Undefined
exe_callback Optional function The callback function to call with command as argument when finished. Undefined
with_shell Optional boolean Use a (terminal) shell to execute this. false
completion_callback Optional function The callback function to call to get completion. See awful.prompt.run for details. `awful.completion.shell`
history_path Optional string File path where the history should be saved. `gears.filesystem.get_cache_dir() .. '/history'`
history_max Optional integer Set the maximum entries in history file. 50
done_callback Optional function The callback function to always call without arguments, regardless of whether the prompt was cancelled. See awful.prompt.run for details. Undefined
changed_callback Optional function The callback function to call with command as argument when a command was changed. Undefined
keypressed_callback Optional function The callback function to call with mod table, key and command as arguments when a key was pressed. Undefined
keyreleased_callback Optional function The callback function to call with mod table, key and command as arguments when a key was pressed. Undefined
hooks Optional table Similar to awful.key. It will call a function for the matching modifiers + key. See awful.prompt.run for details. Undefined

Returns:

    An instance of prompt widget, inherits from wibox.container.background.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.prompt_fg
beautiful.prompt_bg
beautiful.fg_normalWhen beautiful.prompt_fg isn't set.
beautiful.bg_normalWhen beautiful.prompt_bg isn't set.
beautiful.prompt_bg
beautiful.bg_normal
beautiful.prompt_fg
beautiful.fg_normal
beautiful.prompt_fg_cursor
beautiful.prompt_bg_cursor
beautiful.prompt_font

Object properties

🔗 with_shell boolean
Always spawn using a shell.

When using the default exe_callback, use awful.spawn.with_shell instead of awful.spawn. Depending on the amount of customization to your shell environment, this can increase startup time.

Constraints:

Default value : false
Valid values : true or false.
🔗 widget widget or nil · Inherited from wibox.container.background
The widget displayed in the background widget.

Constraints:

Default value : nil
Valid values : The widget to be disaplayed inside of the background area.
🔗 bg color · Inherited from wibox.container.background · 1 signal
The background color/pattern/gradient to use.

Constraints:

Default value : When unspecified, it will inherit the value from an higher level wibox.container.background or directly from the wibox.bg property.
Type description:
string : An hexadecimal color code, such as "#ff0000" for red.
string : A color name, such as "red".
table : A gradient table.
cairo.pattern : Any valid Cairo pattern.
cairo.pattern : A texture build from an image by gears.color.create_png_pattern

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Usage:

    local text_widget = {
        text   = "Hello world!",
        widget = wibox.widget.textbox
    }
    parent : setup {
        {
            text_widget,
            bg     = '#ff0000',
            widget = wibox.container.background
        },
        {
            text_widget,
            bg     = '#00ff00',
            widget = wibox.container.background
        },
        {
            text_widget,
            bg     = '#0000ff',
            widget = wibox.container.background
        },
        spacing = 10,
        layout  = wibox.layout.fixed.vertical
    }

Click to display more

Emit signals:

  • property::bg When the bg value changes.
    • self wibox.container.background The object which changed (useful when connecting many object to the same callback).
    • new_value bg The new value affected to the property.
🔗 fg color · Inherited from wibox.container.background · 1 signal
The foreground (text) color/pattern/gradient to use.

Constraints:

Default value : When unspecified, it will inherit the value from an higher level wibox.container.background or directly from the wibox.fg property.
Type description:
string : An hexadecimal color code, such as "#ff0000" for red.
string : A color name, such as "red".
table : A gradient table.
cairo.pattern : Any valid Cairo pattern.
cairo.pattern : A texture build from an image by gears.color.create_png_pattern
Valid values : A color string, pattern or gradient

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Usage:

    local text_widget = {
        text   = "Hello world!",
        widget = wibox.widget.textbox
    }
    parent : setup {
        {
            text_widget,
            fg     = '#ff0000',
            widget = wibox.container.background
        },
        {
            text_widget,
            fg     = '#00ff00',
            widget = wibox.container.background
        },
        {
            text_widget,
            fg     = '#0000ff',
            widget = wibox.container.background
        },
        spacing = 10,
        layout  = wibox.layout.fixed.vertical
    }

Click to display more

Emit signals:

  • property::fg When the fg value changes.
    • self wibox.container.background The object which changed (useful when connecting many object to the same callback).
    • new_value fg The new value affected to the property.
🔗 shape shape · Inherited from wibox.container.background
The background shape.

Use set_shape to set additional shape paramaters.

Constraints:

Default value : gears.shape.rectangle
Type description:
gears.shape : Like gears.shape.circle
function: : This can be used for custom shapes or to set parameters of existing shapes.
Function prototype:
Parameters:
cr (cairo.context) : A Cairo context
width (number) : The area width.
height (number) : The area height.
Return : The function returns nothing.

See also:

gears.shape Module dedicated to gather common shape painters. module
set_shape Set the background shape. object methods

Usage:

    parent : setup {
        {
            -- Adding a shape without margin may result in cropped output
            {
                text   = "Hello world!",
                widget = wibox.widget.textbox
            },
            shape              = gears.shape.hexagon,
            bg                 = beautiful.bg_normal,
            shape_border_color = beautiful.border_color,
            shape_border_width = beautiful.border_width,
            widget             = wibox.container.background
        },
        {
            -- To solve this, use a margin
            {
                {
                    text   = "Hello world!",
                    widget = wibox.widget.textbox
                },
                left   = 10,
                right  = 10,
                top    = 3,
                bottom = 3,
                widget = wibox.container.margin
            },
            shape        = gears.shape.hexagon,
            bg           = beautiful.bg_normal,
            border_color = beautiful.border_color,
            border_width = beautiful.border_width,
            widget       = wibox.container.background
        },
        spacing = 10,
        layout  = wibox.layout.fixed.vertical
    }
🔗 border_width number · Inherited from wibox.container.background · 1 signal
Add a border of a specific width.

If the shape is set, the border will also be shaped.

See wibox.container.background.shape for an usage example.

Constraints:

Default value : 0
Unit : pixel
Negative allowed : false

See also:

border_color Set the color for the border. object properties

Click to display more

Emit signals:

  • property::border_width When the border_width value changes.
    • self wibox.container.background The object which changed (useful when connecting many object to the same callback).
    • new_value border_width The new value affected to the property.
🔗 border_color color · Inherited from wibox.container.background · 1 signal · 1 theme variable
Set the color for the border.

See wibox.container.background.shape for an usage example.

Constraints:

Default value : wibox.container.background.fg if set, otherwise beautiful.fg_normal.
Type description:
string : An hexadecimal color code, such as "#ff0000" for red.
string : A color name, such as "red".
table : A gradient table.
cairo.pattern : Any valid Cairo pattern.
cairo.pattern : A texture build from an image by gears.color.create_png_pattern

See also:

gears.color This module simplifies the creation of cairo pattern objects. module
border_width Add a border of a specific width. object properties

Click to display more

Emit signals:

  • property::border_color When the border_color value changes.
    • self wibox.container.background The object which changed (useful when connecting many object to the same callback).
    • new_value border_color The new value affected to the property.

Consumed theme variables:

Theme variable Usage
beautiful.fg_normalFallback when 'fg' and border_color aren't set.
🔗 border_strategy string · Inherited from wibox.container.background
How the border width affects the contained widget.

Constraints:

Default value : "none"
Valid values:
"none" : Just apply the border, do not affect the content size (default).
"inner" : Squeeze the size of the content by the border width.
🔗 bgimage image or nil · Inherited from wibox.container.background
The background image to use.

If image is a function, it will be called with (context, cr, width, height) as arguments. Any other arguments passed to this method will be appended.

Constraints:

Default value : nil
Type description:
string : Interpreted as a path to an image file.
string : A valid SVG content.
cairo : A cairo image surface: Directly used as-is.
librsvg : A librsvg handle object: Directly used as-is.
nil : Unset the image.

See also:

gears.surface Utilities to integrate and manipulate Cairo drawing surfaces. module
🔗 children table · Inherited from wibox.widget.base
Get or set the children elements.

Constraints:

Default value : {}
Table content : A list of wibox.widget.

See also:

all_children Get all direct and indirect children widgets. object properties
🔗 all_children table · Inherited from wibox.widget.base
Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a widget, or any of its children, contain (directly or indirectly) itself.

Constraints:

Default value : {}
Table content : A list of wibox.widget.

See also:

children Get or set the children elements. object properties
🔗 forced_height number or nil · Inherited from wibox.widget.base
Force a widget height.

Constraints:

Default value : nil
Type description:
nil : Let the layout decide the height. Usually using the widget native height.
number : Enforce a number of pixels.
Unit : pixel
Negative allowed : false

See also:

forced_width Force a widget width. object properties
🔗 forced_width number or nil · Inherited from wibox.widget.base
Force a widget width.

Constraints:

Default value : nil
Type description:
nil : Let the layout decide the width. Usually using the widget native width.
number : Enforce a number of pixels.
Unit : pixel
Negative allowed : false

See also:

forced_height Force a widget height. object properties
🔗 opacity number · Inherited from wibox.widget.base
The widget opacity (transparency).

Constraints:

Default value : 1.0
Unit : A gradient between transparent (0.0) and opaque (1.0).
Minimum value : 0.0
Maximum value : 1.0

See also:

visible The widget visibility. object properties
🔗 visible boolean · Inherited from wibox.widget.base
The widget visibility.

Constraints:

Default value : true
Valid values : true or false.

See also:

opacity The widget opacity (transparency). object properties
🔗 buttons table · Inherited from wibox.widget.base
The widget buttons.

The table contains a list of awful.button objects.

Constraints:

Default value : {}
Table content : A list of awful.button.

See also:

awful.button Create easily new buttons objects ignoring certain modifiers. module

Theme variables

🔗 beautiful.prompt_fg color
The prompt foreground color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:

🔗 beautiful.prompt_bg color
The prompt background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:

Deprecated object properties

🔗 shape_border_width number · Inherited from wibox.container.background
When a shape is set, also draw a border.

See wibox.container.background.shape for an usage example.

Type constraints:

Name Type(s) Description
width number The border width

See also:

border_width Add a border of a specific width. object properties
🔗 shape_border_color color · Inherited from wibox.container.background · 1 theme variable
When a shape is set, also draw a border.

See wibox.container.background.shape for an usage example.

Type constraints:

Name Type(s) Description
fg color The border color, pattern or gradient

See also:

gears.color This module simplifies the creation of cairo pattern objects. module
border_color Set the color for the border. object properties

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.fg_normalFallback when 'fg' and border_color aren't set.

Object methods

🔗 :set_shape (shape) · Inherited from wibox.container.background · 1 signal
Set the background shape.

Any other arguments will be passed to the shape function.

Parameters:

Name Type(s) Description
shape gears.shape or function A function taking a context, width and height as arguments

See also:

gears.shape Module dedicated to gather common shape painters. module
shape The background shape. object properties

Click to display more

Emit signals:

  • property::set_shape When the set_shape value changes.
    • self wibox.container.background The object which changed (useful when connecting many object to the same callback).
    • new_value shape The new value affected to the property.
🔗 :add_button (button) · Inherited from wibox.widget.base
Add a new awful.button to this widget.

Parameters:

Name Type(s) Description
button awful.button The button to add.
🔗 :emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget.base

Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.

This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Note that this function has some flaws:

  1. The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
  2. In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
  3. If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name Type(s) Description
signal_name string
... Other arguments
🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base
Get the index of a widget.

Parameters:

Name Type(s) Description
widget widget The widget to look for.
recursive Optional boolean Recursively check accross the sub-widgets hierarchy.
... Optional widget Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

  1. number The widget index.
  2. widget The parent widget.
  3. table The hierarchy path between "self" and "widget".
🔗 :connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback to call when the signal is emitted.

Usage:

    local o = gears.object{}
    -- Function can be attached to signals
    local function slot(obj, a, b, c)
        print("In slot", obj, a, b, c)
    end
    o:connect_signal("my_signal", slot)
    -- Emitting can be done without arguments. In that case, the object will be
    -- implicitly added as an argument.
    o:emit_signal "my_signal"
    -- It is also possible to add as many random arguments are required.
    o:emit_signal("my_signal", "foo", "bar", 42)
    -- Finally, to allow the object to be garbage collected (the memory freed), it
    -- is necessary to disconnect the signal or use weak_connect_signal
    o:disconnect_signal("my_signal", slot)
    -- This time, the slot wont be called as it is no longer connected.
    o:emit_signal "my_signal"
🔗 :weak_connect_signal (name, func) · Inherited from gears.object
Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens. Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback to call when the signal is emitted.
🔗 :disconnect_signal (name, func) · Inherited from gears.object
Disonnect from a signal.

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback that should be disconnected.
🔗 :emit_signal (name, ...) · Inherited from gears.object
Emit a signal.

Parameters:

Name Type(s) Description
name string The name of the signal
... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal()

Signals

🔗 widget::layout_changed · Inherited from wibox.widget.base
When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

See also:

widget::redraw_needed When the widget content changed. signals
🔗 widget::redraw_needed · Inherited from wibox.widget.base
When the widget content changed. This signal is emitted when the content of the widget changes. The widget will be redrawn, it is not re-layouted. Put differently, it is assumed that :layout() and :fit() would still return the same results as before.

See also:

widget::layout_changed When the layout (size) change. signals
🔗 button::press · Inherited from wibox.widget.base
When a mouse button is pressed over the widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 button::release · Inherited from wibox.widget.base
When a mouse button is released over the widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::enter · Inherited from wibox.widget.base
When the mouse enter a widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::leave · Inherited from wibox.widget.base
When the mouse leave a widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
generated by LDoc 1.4.6