Module: `wibox.widget.imagebox`

A widget to display an image.

The wibox.widget.imagebox is part of the Awesome WM's widget system (see 03-declarative-layout.md).

This widget displays an image. The image can be a file, a cairo image surface, or an rsvg handle object (see the image property).

Examples using a wibox.widget.imagebox:

Usage example

local my_imagebox = wibox.widget.imagebox(beautiful.awesome_icon, false)

Alternatively, you can declare the imagebox widget using the declarative pattern (both variants are strictly equivalent):

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.widget.imagebox

Info:

Copyright: 2010 Uli Schlachter
Originally authored by: Uli Schlachter
(Full contributors list available on our github project)

Constructors

wibox.widget.imagebox ([image[, resize_allowed[, clip_shape]]])

Returns a new wibox.widget.imagebox instance.

Object properties

image	image	The image rendered by the imagebox.
clip_shape	function or gears.shape	Set a clip shape for this imagebox.
resize	boolean	Should the image be resized to fit into the available space?
upscale	boolean	Allow the image to be upscaled (made bigger).
downscale	boolean	Allow the image to be downscaled (made smaller).
stylesheet	string	Set the SVG CSS stylesheet.
dpi	number or table	Set the SVG DPI (dot per inch).
auto_dpi	boolean	Use the object DPI when rendering the SVG.
horizontal_fit_policy	string	Set the horizontal fit policy.
vertical_fit_policy	string	Set the vertical fit policy.
valign	string	The vertical alignment.
halign	string	The horizontal alignment.
max_scaling_factor	number	The maximum scaling factor.
scaling_quality	string	Set the scaling aligorithm.
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

Object methods

: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

wibox.widget.imagebox ([image[, resize_allowed[, clip_shape]]])

Returns a new wibox.widget.imagebox instance.

This is the constructor of wibox.widget.imagebox. It creates a new instance of imagebox widget.

Alternatively, the declarative layout syntax can handle wibox.widget.imagebox instanciation.

The image can be a file, a cairo image surface, or an rsvg handle object (see the image property).

Any additional arguments will be passed to the clip shape function.

Parameters:

image image The image to display (may be nil). (optional)
resize_allowed boolean If false, the image will be clipped, else it will be resized to fit into the available space. (optional)
clip_shape function A gears.shape compatible function. (optional)

Returns:

wibox.widget.imagebox

Object properties

image image · 1 signal

The image rendered by the imagebox.

It can can be any of the following:

A string: Interpreted as a path to an image file
A cairo image surface: Directly used as-is
A librsvg handle object: Directly used as-is
nil: Unset the image.

Type constraints:

image image The image to render.

Click to display more

Emit signals:

property::image When the image value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).

clip_shape function or gears.shape · 1 signal

Set a clip shape for this imagebox.

A clip shape defines an area and dimension to which the content should be trimmed.

Usage example

Type constraints:

clip_shape function or gears.shape A gears.shape compatible shape function.

Usage:

for _, resize in ipairs {true, false} do
    for idx, shape in ipairs {gears.shape.circle, gears.shape.squircle, gears.shape.rounded_rect} do
        local w = wibox.widget {
            {
                {
                    image         = beautiful.awesome_icon,
                    forced_height = 32,
                    forced_width  = 32,
                    clip_shape    = shape,
                    resize        = resize,
                    widget        = wibox.widget.imagebox
                },
                widget = wibox.container.place
            },
            widget = wibox.container.background
        }
    end
end

Click to display more

Emit signals:

property::clip_shape When the clip_shape value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value clip_shape The new value affected to the property.

resize boolean · 1 signal

Should the image be resized to fit into the available space?

Note that upscale and downscale can affect the value of resize. If conflicting values are passed to the constructor, then the result is undefined.

Usage example

Click to display more

Emit signals:

property::resize When the resize value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value resize The new value affected to the property.

upscale boolean

Allow the image to be upscaled (made bigger).

Note that upscale and downscale can affect the value of resize. If conflicting values are passed to the constructor, then the result is undefined.

Usage example

Usage:

local image = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>'..
    '<svg width="190" height="60">'..
        '<rect x="10"  y="10" width="50" height="50" />'..
        '<rect x="70"  y="10" width="50" height="50" class="my_class" />'..
        '<rect x="130" y="10" width="50" height="50" id="my_id" />'..
    '</svg>'

local stylesheet = "" ..
     "rect { fill: #ffff00; } "..
     ".my_class { fill: #00ff00; } "..
     "#my_id { fill: #0000ff; }"

local w = wibox.widget {
    stylesheet = stylesheet,
    image      = image,
    widget     = wibox.widget.imagebox
}

Click to display more

Emit signals:

property::stylesheet When the stylesheet value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value stylesheet The new value affected to the property.

dpi number or table · 1 signal

Set the SVG DPI (dot per inch).

Force a specific DPI when rendering the .svg. For other file formats, this does nothing.

It can either be a number of a table containing the x and y keys.

Please note that DPI and resize can "fight" each other and end up making the image smaller instead of bigger.

Usage example

Usage:

local image = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>'..
    '<svg width="2in" height="1in">'..
        '<rect height="0.1in" width="0.1in" style="fill:red;" />'..
        '<text x="10" y="32" width="150" style="font-size: 0.1in;">Hello world!</text>'..
    '</svg>'

 for _, dpi in ipairs {100, 200, 300} do
     local w = wibox.widget {
        image         = image,
        dpi           = dpi,
        resize        = false,
        forced_height = 70,
        forced_width  = 150,
        widget        = wibox.widget.imagebox
    }
 end

Click to display more

Emit signals:

property::dpi When the dpi value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value dpi The new value affected to the property.

auto_dpi boolean · 1 signal

Use the object DPI when rendering the SVG.

By default, the SVG are interpreted as-is. When this property is set, the screen DPI will be passed to the SVG renderer. Depending on which tool was used to create the .svg, this may do nothing at all. However, for example, if the .svg uses <text> elements and doesn't have an hardcoded stylesheet, the result will differ.

Emit signals:

property::auto_dpi When the auto_dpi value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value auto_dpi The new value affected to the property.

horizontal_fit_policy string · 1 signal

Set the horizontal fit policy.

Valid values are:

"auto": Honor the resize variable and preserve the aspect ratio. This is the default behaviour.
"none": Do not resize at all.
"fit": Resize to the widget width.

Here is the result for a 22x32 image:

Usage example

Emit signals:

property::horizontal_fit_policy When the horizontal_fit_policy value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value horizontal_fit_policy The new value affected to the property.

vertical_fit_policy string · 1 signal

Set the vertical fit policy.

Valid values are:

"auto": Honor the resize varible and preserve the aspect ratio. This is the default behaviour.
"none": Do not resize at all.
"fit": Resize to the widget height.

Here is the result for a 32x22 image:

Usage example

Emit signals:

property::vertical_fit_policy When the vertical_fit_policy value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value horizontal_fit_policy The new value affected to the property.

valign string · 1 signal

The vertical alignment.

Possible values are:

"top"
"center" (default)
"bottom"

Usage example

Usage:

for _, resize in ipairs {true, false} do
    for _, valign in ipairs {"top", "center", "bottom"} do
        local w = wibox.widget {
            {
                {
                    image         = beautiful.awesome_icon,
                    forced_height = 32,
                    forced_width  = 32,
                    valign        = valign,
                    resize        = resize,
                    widget        = wibox.widget.imagebox
                },
                bg     = beautiful.bg_normal,
                widget = wibox.container.background
            },
            widget = wibox.container.place
        }
    end
end

Click to display more

Emit signals:

property::valign When the valign value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value valign The new value affected to the property.

halign string · 1 signal

The horizontal alignment.

Possible values are:

"left"
"center" (default)
"right"

Usage example

Usage:

for _, resize in ipairs {true, false} do
    for _, halign in ipairs {"left", "center", "right"} do
        local w = wibox.widget {
            {
                {
                    image         = beautiful.awesome_icon,
                    forced_height = 32,
                    forced_width  = 32,
                    halign        = halign,
                    resize        = resize,
                    widget        = wibox.widget.imagebox
                },
                bg     = beautiful.bg_normal,
                widget = wibox.container.background
            },
            widget = wibox.container.place
        }
    end
end

Click to display more

Emit signals:

property::halign When the halign value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value halign The new value affected to the property.

max_scaling_factor number · 1 signal

The maximum scaling factor.

If an image is scaled too much, it gets very blurry. This property allows to limit the scaling. Use the properties valign and halign to control how the image will be aligned.

In the example below, the original size is 22x22

Usage example

Emit signals:

property::max_scaling_factor When the max_scaling_factor value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value max_scaling_factor The new value affected to the property.

scaling_quality string · 1 signal

Set the scaling aligorithm.

Depending on how the image is used, what is the "correct" way to scale can change. For example, upscaling a pixel art image should not make it blurry. However, scaling up a photo should not make it blocky.

Value	Description
fast	A high-performance filter
good	A reasonable-performance filter
best	The highest-quality available
nearest	Nearest-neighbor filtering (blocky)
bilinear	Linear interpolation in two dimensions

The image used in the example below has a resolution of 32x22 and is intentionally blocky to highlight the difference. It is zoomed by a factor of 3.

Usage example

Type constraints:

scaling_quality string Either "fast", "good", "best", "nearest" or "bilinear".

Usage:

for _, quality in ipairs {"fast", "good", "best", "nearest", "bilinear"} do
   local w = wibox.widget {
       {
           {
               image           = img,
               forced_height   = 64,
               forced_width    = 96,
               scaling_quality = quality,
               widget          = wibox.widget.imagebox
           },
           widget = wibox.container.place
       },
       widget = wibox.container.background
   }
end

Click to display more

Emit signals:

property::scaling_quality When the scaling_quality value changes.

self wibox.widget.imagebox The object which changed (useful when connecting many object to the same callback).
new_value scaling_quality The new value affected to the property.

children table · Inherited from wibox.widget.base

Get or set the children elements.

Type constraints:

children table The children.

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.

Type constraints:

children table The children.

forced_height number or nil · Inherited from wibox.widget.base

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget.base

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget.base

The widget opacity (transparency).

Type constraints:

opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget.base

The widget visibility.

buttons table · Inherited from wibox.widget.base

The widget buttons.

The table contains a list of awful.button objects.

Object methods

:add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

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:

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.
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).
If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

signal_name string
... Other arguments

:index (widget[, recursive[, ...]]) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

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

Returns:

number The widget index.
widget The parent widget.
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 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 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 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 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.

Arguments:

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 The entry from the result of wibox.drawable: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.

Arguments:

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 The entry from the result of wibox.drawable: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.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable: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.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable: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.

awesome

Contents

Widgets

Core components

Input handling

Declarative rules

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Client tiling

Libraries

Sample files

Classes

Documentation

Module: wibox.widget.imagebox

Examples using a wibox.widget.imagebox:

Class Hierarchy

Info:

Constructors

Object properties

Object methods

Signals

Constructors

Parameters:

Returns:

Object properties

Type constraints:

Emit signals:

Type constraints:

See also:

Usage:

Emit signals:

Emit signals:

See also:

See also:

Usage:

Emit signals:

See also:

Usage:

Emit signals:

See also:

Emit signals:

See also:

Emit signals:

See also:

Emit signals:

See also:

Usage:

Emit signals:

See also:

Usage:

Emit signals:

See also:

Emit signals:

Type constraints:

See also:

Usage:

Emit signals:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

Module: `wibox.widget.imagebox`