Skip to content

Latest commit

 

History

History
123 lines (87 loc) · 7.97 KB

WhatWatch-Doc.md

File metadata and controls

123 lines (87 loc) · 7.97 KB
Raw

WhatWatch Documentation

WhatWatch

About

This is a gnome-shell-extension. It displays an analog clock on the desktop and exposes a great variety of customisation options.

Screenshot showing WhatWatch clock on desktop with browser window opened behind it...

General Usage

The clock is non interactive. If you set it up to be non opaque you'll be able to see any controls hidden behind it. The clock acts as if it was not there in case you click on something behind it.

Since V.5 it has some configurational settings that let the clock hide if overlapped by application windows.

Configuration

Use the extensions app of gnome-shell to activate / deactivate the extension or to launch it's settings dialog. You might also use the gnome-extension cli or the browser plugin of ego.

The settings dialog will expose quite a bunch of parameters and attributes of the clock to be configured.

Screenshot showing WhatWatch settings dialog...

The settings are dived into different tabs for different parts of the clock:

  • Preferences - General settings affecting the clock as a whole.
  • Behaviour - If and when the clock will hide when overlapped by other windows.
  • Face - Settings that style the clock's face appearance.
  • Ticks - Settings that style the clock's interval markers.
  • Hands - Settings that style the clock's hands.
  • Shadow - Settings that style the shadow behaviour of the clock's elements.
  • Debug - Settings that configure the logging behaviour for troubleshooting.

Followed by an About tab with some general information on the extension.

Preferences

General settings affecting the clock as a whole.

  • Clock Style - Select a specific style flavour (currently one of):
    • OldSchool (also default) - The base style, clean and classic, I like it...
    • OldSchool Arabian - ...add Arabian numbers.
    • OldSchool Roman - ...add Roman numbers.
    • Deutsche Bahn - ...like seen everywhere in germany's public transportation.
    • Radar - The death star is in firing range...
  • Clock Position - Select the general orientation on primary screen...
  • Margin Top - Pixel Margin from top of screen (will not allways be used depending on clock position)
  • Margin Side - Pixel Margin from the relevant side of screen (will not allways be used depending on clock position)
  • Clock Size Width - Width of the clock
    • Width/Height should be the same but you might want to adjust to match your screen's aspect ratio...
  • Clock Size Height - Height of the clock
    • Width/Height should be the same but you might want to adjust to match your screen's aspect ratio...

Behaviour

Settings to configure if and when the clock will hide when overlapped by other windows.

  • Hide in fullscreen mode - When on, the clock will hide behind fullscreen windows (like fullscreen video etc.), otherwise it will even sit on top of those. Not affected by Blacklist WM_Class(es).
  • Hide when overlapped - When on, the clock will fade out until hidden when overlapped by an application window.
  • Hide only on focus - When on, the clock will fade out until hidden when overlapped by an application window having the focus.
  • Fade in interval - Percentage step of opacity fade in every 100 ms.
  • Fade out interval - Percentage step of opacity fade in every 100 ms.
  • Blacklist WM_Class(es) - Windows of these window manager classes will not be considdered overlapping (this is essential when using extensions like Desktop Icons NG by example). Several class names might be concatenated by semicolon (;). You might want to use the debug settings to get the class name information you need.

Face

Settings that style the clock's face appearance. Not all clock styles support all settings.

  • Face color (R/G/B/A) - R, G, B Color-Values are 0-1, with 0 no color and 1 full color of the certain channel. Same for A in Opacity. Values are given in their spin button value fields or via color picker control at the end of the config row.
  • Center Dial radius - Gives the size of the small dot in the center of the dial (You might think of it as the hands' axis).
  • Center Dial color (R/G/B/A) - See Face color..., but for center dial.
  • Dial Line (Width/Inset) - The dial can have a perimeter line, width and inset (from outer to inner) are given here.
  • Dial Line color (R/G/B/A) - See Face color..., but for dial line.

Ticks

Settings that style the clock's interval markers. Not all clock styles support all settings.

  • Tick Inset - General inset (Distance from outer rim to start of ticks towards center of dial).
  • Minute Tick (Width/Inset) - Width of the minute ticks and inset length of the minutes ticks.
  • Circle (Inner/Outer) - If on a circle will be drawn at end (inner) and start (outer) of tick having tick's width.
  • Minute Tick color (R/G/B/A) - R, G, B Color-Values are 0-1, with 0 no color and 1 full color of the certain channel. Same for A in Opacity. Values are given in their spin button value fields or via color picker control at the end of the config row.
  • 5/* Tick (Width/Inset) - Same as above but only for each five minute (hour) tick.
  • Circle (Inner/Outer) - Same as above but only for each five minute (hour) tick.
  • 5/* Tick color (R/G/B/A) - Same as above but only for each five minute (hour) tick.
  • 1/4 Tick (Width/Inset) - Same as above but only for each quarter of an hour tick.
  • Circle (Inner/Outer) - Same as above but only for each quarter of an hour tick.
  • 1/4 Tick color (R/G/B/A) - Same as above but only for each quarter of an hour tick.

Hands

Settings that style the clock's hands. Not all clock styles support all settings.

  • Hour Hand (Width/Length) - Width of the hour hand and length of it.
  • Filled/Eyed/Tailed/Finned - If on the hand will be filled, eyed, tailed, finned (if chosen style supports it).
  • Hour Hand color (R/G/B/A) - R, G, B Color-Values are 0-1, with 0 no color and 1 full color of the certain channel. Same for A in Opacity. Values are given in their spin button value fields or via color picker control at the end of the config row.
  • Minute Hand (Width/Length) - Same as above but for minute hand.
  • Filled/Eyed/Tailed/Finned - Same as above but for minute hand.
  • Minute Hand color (R/G/B/A) - Same as above but for minute hand.
  • Second Hand (Width/Length) - Same as above but for second hand. Set width to 0.0 to hide the second hand.
  • Filled/Eyed/Tailed/Finned - Same as above but for second hand.
  • Second Hand color (R/G/B/A) - Same as above but for second hand.

Shadow

Settings that style the shadow behaviour of the clock's elements. Not all clock styles support all settings.

  • Shadow Hands - Hands cast shadows, when on.
  • Shadow Ticks - Ticks cast shadows, when on.
  • Shadow Numbers - Numbers cast shadows, when on.
  • Shadow offset (X/Y) - X and Y shadow offset values are given in their spin button value fields.
  • Shadow color (R/G/B/A) - R, G, B Color-Values are 0-1, with 0 no color and 1 full color of the certain channel. Same for A in Opacity. Values are given in their spin button value fields or via color picker control at the end of the config row.

Debug

  • Debug Logging - Enable / disable general logging to the system's log.
  • Timerdebug - Enable / disable timer trigger logging to the system's log.
  • Timedebug - Enable / disable time value logging to the system's log.
  • Configdebug - Enable / disable configurational settings logging to the system's log.
  • Windowdebug - Enable / disable window overlapping analysis logging to the system's log. You might want to use this to gather window manager class name information for blacklisting to prevent unexpected or unwanted hiding behaviour. See Blacklist WM_Class(es) in Behaviour.