Class wibox.widget.imagebox

Usage:

    wibox.widget {
        image  = beautiful.awesome_icon,
        resize = false,
        widget = wibox.widget.imagebox
    }

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Functions

imagebox:set_clip_shape (clip_shape) Set a clip shape for this imagebox A clip shape define an area where the content is displayed and one where it is trimmed.
wibox.widget.imagebox (image, resize_allowed, clip_shape) Returns a new imagebox.

Object properties

wibox.widget.imagebox.image Set an imagebox' image
wibox.widget.imagebox.clip_shape Set a clip shape for this imagebox A clip shape define an area where the content is displayed and one where it is trimmed.
wibox.widget.imagebox.resize Should the image be resized to fit into the available space?


Functions

imagebox:set_clip_shape (clip_shape)
Set a clip shape for this imagebox A clip shape define an area where the content is displayed and one where it is trimmed.

Any other parameters will be passed to the clip shape function

  • clip_shape A gears_shape compatible shape function

See also:

wibox.widget.imagebox (image, resize_allowed, clip_shape)
Returns a new imagebox. Any other arguments will be passed to the clip shape function
  • image the image to display, may be nil
  • resize_allowed If false, the image will be clipped, else it will be resized to fit into the available space.
  • clip_shape A gears.shape compatible function

Returns:

    table A new imagebox

Object properties

wibox.widget.imagebox.image
Set an imagebox' image

Type:

  • image Either a string or a cairo image surface. A string is interpreted as the path to a png image file.
wibox.widget.imagebox.clip_shape
Set a clip shape for this imagebox A clip shape define an area where the content is displayed and one where it is trimmed.

Type:

  • clip_shape A gears_shape compatible shape function

See also:

wibox.widget.imagebox.resize
Should the image be resized to fit into the available space?

Type:

  • allowed If false, the image will be clipped, else it will be resized to fit into the available space.
generated by LDoc 1.4.2