-
Notifications
You must be signed in to change notification settings - Fork 1
Widget Reference
cybertron edited this page Aug 24, 2012
·
6 revisions
Here is a list of the available widgets for Whee. They are specified in the configuration files using the format described in Basic Format. See the sample configurations in the examples directory to see exactly how these are used.
The global parameters are specified by values in the root of the configuration file. They consist of the following:
- Position [x] [y] x and y specify the upper left corner of the whee window.
- Dimensions [width] [height] width and height specify the size of the whee window.
- Interval [interval] interval specifies how often the window updates in ms. Setting this lower than 1000 is not recommended as some widgets will not work properly.
- Strut [location] location can be one of top, bottom, left, or right. This can be used to inform the window manager that maximized windows should not cover the whee window. Set it to the edge of the screen where the whee window will be placed.
- Font [font] font specifies the default font for the window
- FontSize [size] size specifies the default font size for the window
- Bold [bold] If bold is 1 then the default font will be bold. If it is 0, then it will not.
- Italic [italic] Same as bold, except for italic font style.
All or most widgets have the following parameters:
- Position [x] [y] Sets the position of the widget relative to its parent widget. Note that whee allows nesting of essentially any widget inside of another widget.
- Dimensions [width] [height] Sets the dimensions of the widget
- Type [type] This must be one of the widget names listed below (Group, Text, CPU, etc.).
- Interval [interval] Allows overriding of the globally set interval. Note that this cannot be set lower than the global interval, and it will only allow intervals that are an even multiple of the global interval. Useful for things like disk usage widgets that don't need to update as frequently.
- SubType [subtype] Most widgets can also have a subtype. Where applicable, it may be text, image, or graph. Text uses the Format parameter (discussed below) to display the widget value as text, image reveals more of an image the closer the widget value gets to the specified maximum value (also discussed below), and graph provides a graph of the past and present values of the widget.
- Format [format] Used by text SubType widgets. This specifies how the widget will display its value in text format. The actual value will replace any instances of %s in the format string.
- Filename [filename] Used by image SubType widgets. This specifies which image will be used to represent the state of the widget.
- Max [maximum] For widgets and subtypes where it makes sense, this can be used to specify the maximum value of the widget. For example, you may want to specify that the maximum value for the temperature widget is 70 to ensure a useful graph or image representation.
- Orientation [orientation] Used by image SubType widgets. If orientation is horizontal, then the image will be revealed horizontally. Otherwise it will be done vertically.
- Font [font] Sets the font of the widget. Font parameters only need to be set if you wish to override the default set in the global parameters.
- FontSize [size] size specifies the font size for the widget
- Bold [bold] If bold is 1 then the default font will be bold. If it is 0, then it will not.
- Italic [italic] Same as bold, except for italic font style.
- FGColor [r] [g] [b] [a] Specifies the color of text and graphs in the widget. Defaults to black.
- BGColor [r] [g] [b] [a] Specifies the background color of the widget. Defaults to transparent.