# i3wm segments

`powerline.segments.i3wm.``mode`(names={u'default': None})

  Returns current i3 mode

  Parameters: | names (dict) – Specifies the string to show for various modes. Use `null` to hide a mode (`default` is hidden by default).

  Highligh groups used: `mode`

`powerline.segments.i3wm.``scratchpad`(icons={u'fresh': u'O', u'changed': u'X'})

  Returns the windows currently on the scratchpad

  Parameters: | icons (dict) – Specifies the strings to show for the different scratchpad window states. Must contain the keys `fresh` and `changed`.

  Highlight groups used: `scratchpad` or `scratchpad:visible`, `scratchpad` or `scratchpad:focused`, `scratchpad` or `scratchpad:urgent`.

`powerline.segments.i3wm.``workspace`(strip=False, workspace=None)

  Return the specified workspace name

  Parameters:

  - workspace (str) – Specifies which workspace to show. If unspecified, may be set by the `list_workspaces` lister if used, otherwise falls back to currently focused workspace.
  - strip (bool) – Specifies whether workspace numbers (in the `1: name` format) should be stripped from workspace names before being displayed. Defaults to false.

  Highlight groups used: `workspace` or `w_visible`, `workspace` or `w_focused`, `workspace` or `w_urgent`.

`powerline.segments.i3wm.``workspaces`(strip=0, output=None, only_show=None)

  Return list of used workspaces

  Parameters:

  - only_show (list) – Specifies which workspaces to show. Valid entries are `"visible"`, `"urgent"` and `"focused"`. If omitted or `null` all workspaces are shown.
  - output (str) – May be set to the name of an X output. If specified, only workspaces on that output are shown. Overrides automatic output detection by the lemonbar renderer and bindings.
  - strip (int) – Specifies how many characters from the front of each workspace name should be stripped (e.g. to remove workspace numbers). Defaults to zero.

  Highlight groups used: `workspace` or `w_visible`, `workspace` or `w_focused`, `workspace` or `w_urgent`.