Built-in Widgets¶
Applications¶
Canto¶
<missing doc string>
| key | default | description |
|---|---|---|
| font | "Arial" | Font |
| fontsize | None | Pixel size. Calculated if None. |
| padding | None | Padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
| fetch | False | Whether to fetch new items on update |
| feeds | [] | List of feeds to display, empty for all |
| one_format | "{name}: {number}" | One feed display format |
| all_format | "{number}" | All feeds display format |
| update_delay | 600 | The delay in seconds between updates |
Maildir¶
A simple widget showing the number of new mails in maildir mailboxes.
| key | default | description |
|---|---|---|
| font | "Arial" | Font |
| fontsize | None | Maildir widget font size. Calculated if None. |
| padding | None | Maildir widget padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
Mpris¶
A widget which displays the current track/artist of your favorite MPRIS player. It should work with all players which implement a reasonably correct version of MPRIS, though I have only tested it with clementine.
| key | default | description |
|---|---|---|
| font | "Arial" | Mpd widget font |
| fontsize | None | Mpd widget pixel size. Calculated if None. |
| padding | None | Mpd widget padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
YahooWeather¶
A weather widget, data provided by the Yahoo! Weather API
Format options:
- astronomy_sunrise
- astronomy_sunset
- atmosphere_humidity
- atmosphere_visibility
- atmosphere_pressure
- atmosphere_rising
- condition_text
- condition_code
- condition_temp
- condition_date
- location_city
- location_region
- location_country
- units_temperature
- units_distance
- units_pressure
- units_speed
- wind_chill
- wind_direction
- wind_speed
| key | default | description |
|---|---|---|
| font | "Arial" | Font |
| fontsize | None | Pixel size, calculated if None. |
| padding | None | Padding, calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
| location | None | Location to fetch weather for. Ignored if woeid is set. |
| woeid | None | Where On Earth ID. Auto-calculated if location is set. |
| format | "{location_city}: {condition_temp} °{units_temperature}" | Display format |
| metric | True | True to use metric/C, False to use imperial/F |
| update_interval | 600 | Update interval in seconds |
Graphs¶
CPUGraph¶
<missing doc string>
| key | default | description |
|---|---|---|
| graph_color | "18BAEB" | Graph color |
| fill_color | "1667EB.3" | Fill color for linefill graph |
| background | "000000" | Widget background |
| border_color | "215578" | Widget border color |
| border_width | 2 | Widget background |
| margin_x | 3 | Margin X |
| margin_y | 3 | Margin Y |
| samples | 100 | Count of graph samples. |
| frequency | 1 | Update frequency in seconds |
| type | "linefill" | ‘box’, ‘line’, ‘linefill’ |
| line_width | 3 | Line width |
| start_pos | "bottom" | Drawer starting position (‘bottom’/’top’) |
HDDGraph¶
<missing doc string>
| key | default | description |
|---|---|---|
| graph_color | "18BAEB" | Graph color |
| fill_color | "1667EB.3" | Fill color for linefill graph |
| background | "000000" | Widget background |
| border_color | "215578" | Widget border color |
| border_width | 2 | Widget background |
| margin_x | 3 | Margin X |
| margin_y | 3 | Margin Y |
| samples | 100 | Count of graph samples. |
| frequency | 60 | Update frequency in seconds |
| type | "linefill" | ‘box’, ‘line’, ‘linefill’ |
| line_width | 3 | Line width |
| start_pos | "bottom" | Drawer starting position (‘bottom’/’top’) |
| path | "sda1" | Path at which parition is MOUNTED. |
| space_type | "used" | free/used |
MemoryGraph¶
<missing doc string>
| key | default | description |
|---|---|---|
| graph_color | "18BAEB" | Graph color |
| fill_color | "1667EB.3" | Fill color for linefill graph |
| background | "000000" | Widget background |
| border_color | "215578" | Widget border color |
| border_width | 2 | Widget background |
| margin_x | 3 | Margin X |
| margin_y | 3 | Margin Y |
| samples | 100 | Count of graph samples. |
| frequency | 1 | Update frequency in seconds |
| type | "linefill" | ‘box’, ‘line’, ‘linefill’ |
| line_width | 3 | Line width |
| start_pos | "bottom" | Drawer starting position (‘bottom’/’top’) |
NetGraph¶
<missing doc string>
| key | default | description |
|---|---|---|
| graph_color | "18BAEB" | Graph color |
| fill_color | "1667EB.3" | Fill color for linefill graph |
| background | "000000" | Widget background |
| border_color | "215578" | Widget border color |
| border_width | 2 | Widget background |
| margin_x | 3 | Margin X |
| margin_y | 3 | Margin Y |
| samples | 100 | Count of graph samples. |
| frequency | 1 | Update frequency in seconds |
| type | "linefill" | ‘box’, ‘line’, ‘linefill’ |
| line_width | 3 | Line width |
| interface | "eth0" | Interface to display info for |
| bandwidth_type | "down" | down(load)/up(load) |
| start_pos | "bottom" | Drawer starting position (‘bottom’/’top’) |
SwapGraph¶
<missing doc string>
| key | default | description |
|---|---|---|
| graph_color | "18BAEB" | Graph color |
| fill_color | "1667EB.3" | Fill color for linefill graph |
| background | "000000" | Widget background |
| border_color | "215578" | Widget border color |
| border_width | 2 | Widget background |
| margin_x | 3 | Margin X |
| margin_y | 3 | Margin Y |
| samples | 100 | Count of graph samples. |
| frequency | 1 | Update frequency in seconds |
| type | "linefill" | ‘box’, ‘line’, ‘linefill’ |
| line_width | 3 | Line width |
| start_pos | "bottom" | Drawer starting position (‘bottom’/’top’) |
Misc¶
Notify¶
An notify widget
| key | default | description |
|---|---|---|
| font | "Arial" | Mpd widget font |
| fontsize | None | Mpd widget pixel size. Calculated if None. |
| padding | None | Mpd widget padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground normal priority colour |
| foreground_urgent | "ff0000" | Foreground urgent priority colour |
| foreground_low | "dddddd" | Foreground low priority colour |
Prompt¶
A widget that prompts for user input. Input should be started using the .startInput method on this class.
| key | default | description |
|---|---|---|
| font | "Arial" | Font |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | None | Padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
| cursorblink | 0.5 | Cursor blink rate. 0 to disable. |
Sep¶
A visible widget separator.
| key | default | description |
|---|---|---|
| padding | 2 | Padding on either side of separator. |
| linewidth | 1 | Width of separator line. |
| foreground | "888888" | Separator line colour. |
| background | "000000" | Background colour. |
| height_percent | 80 | Height as a percentage of bar height (0-100). |
Spacer¶
Just an empty space on the bar. Often used with width equal to bar.STRETCH to push bar widgets to the right edge of the screen.
System¶
Battery¶
A simple but flexible text-based battery widget.
| key | default | description |
|---|---|---|
| low_foreground | "FF0000" | font color when battery is low |
| format | "{char} {percent:2.0%} {hour:d}:{min:02d}" | Display format |
| charge_char | "^" | Character to indicate the battery is charging |
| discharge_char | "V" | Character to indicate the battery is discharging |
| font | "Arial" | Text font |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | 3 | Padding left and right. Calculated if None. |
| background | None | Background colour. |
| foreground | "#ffffff" | Foreground colour. |
| battery_name | "BAT0" | ACPI name of a battery, usually BAT0 |
| status_file | "status" | Name of status file in /sys/class/power_supply/battery_name |
| energy_now_file | "energy_now" | Name of file with the current energy in /sys/class/power_supply/battery_name |
| energy_full_file | "energy_full" | Name of file with the maximum energy in /sys/class/power_supply/battery_name |
| power_now_file | "power_now" | Name of file with the current power draw in /sys/class/power_supply/battery_name |
| update_delay | 1 | The delay in seconds between updates |
BatteryIcon¶
Battery life indicator widget
| key | default | description |
|---|---|---|
| theme_path | "libqtile/resources/battery-icons" | Path of the icons |
| custom_icons | {} | dict containing key->filename icon map |
| font | "Arial" | Text font |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | 3 | Padding left and right. Calculated if None. |
| background | None | Background colour. |
| foreground | "#ffffff" | Foreground colour. |
| battery_name | "BAT0" | ACPI name of a battery, usually BAT0 |
| status_file | "status" | Name of status file in /sys/class/power_supply/battery_name |
| energy_now_file | "energy_now" | Name of file with the current energy in /sys/class/power_supply/battery_name |
| energy_full_file | "energy_full" | Name of file with the maximum energy in /sys/class/power_supply/battery_name |
| power_now_file | "power_now" | Name of file with the current power draw in /sys/class/power_supply/battery_name |
| update_delay | 1 | The delay in seconds between updates |
Clock¶
A simple but flexible text-based clock.
| key | default | description |
|---|---|---|
| font | "Arial" | Clock font |
| fontsize | None | Clock pixel size. Calculated if None. |
| padding | None | Clock padding. Calculated if None. |
| background | "000000" | Background colour |
| foreground | "ffffff" | Foreground colour |
Systray¶
A widget that manage system tray
| key | default | description |
|---|---|---|
| icon_size | 20 | Icon width |
| padding | 5 | Padding between icons |
| background | None | Background colour |
Volume¶
Widget that display and change volume if theme_path is set it draw widget as icons
| key | default | description |
|---|---|---|
| cardid | 0 | Card Id |
| channel | 'Master" | Channel |
| font | "Arial" | Text font |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | 3 | Padding left and right. Calculated if None. |
| background | None | Background colour. |
| foreground | "#ffffff" | Foreground colour. |
| theme_path | None | Path of the icons |
| update_interval | 0.2 | Update time in seconds. |
Window Management¶
CurrentLayout¶
<missing doc string>
| key | default | description |
|---|---|---|
| font | "Arial" | Text font |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | None | Padding left and right. Calculated if None. |
| background | None | Background colour. |
| foreground | "#ffffff" | Foreground colour. |
GroupBox¶
A widget that graphically displays the current group.
| key | default | description |
|---|---|---|
| active | "ffffff" | Active group font colour |
| inactive | "404040" | Inactive group font colour |
| urgent_text | "FF0000" | Urgent group font color |
| margin_y | 3 | Y margin outside the box |
| margin_x | 3 | X margin outside the box |
| borderwidth | 3 | Current group border width |
| font | "Arial" | Font face |
| fontsize | None | Font pixel size - calculated if None |
| background | "000000" | Widget background |
| highlight_method | "border" | Method of highlighting (one of ‘border’ or ‘block’) Uses *_border color settings |
| rounded | True | To round or not to round borders |
| this_current_screen_border | "215578" | Border colour for group on this screen when focused. |
| this_screen_border | "113358" | Border colour for group on this screen. |
| other_screen_border | "404040" | Border colour for group on other screen. |
| padding | 5 | Padding inside the box |
| urgent_border | "FF0000" | Urgent border color |
| urgent_alert_method | "border" | Method for alerting you of WM urgent hints (one of ‘border’ or ‘text’) |
WindowName¶
Displays the name of the window that currently has focus.
| key | default | description |
|---|---|---|
| font | "Arial" | Font face. |
| fontsize | None | Font pixel size. Calculated if None. |
| padding | None | Padding left and right. |
| background | "000000" | Background colour. |
| foreground | "ffffff" | Foreground colour. |