CClock.dll – A configurable clock dll for WindowBlinds™

Date: 10 May 2000

Version: 1.1.1

This file must be distributed unchanged with the CClock.dll file (including in all personalities).

There are no restrictions on the use or redistribution of this dll, except that this help file must accompany it. (This is just to make sure that anyone that gets a personality with this dll included can modify it.)

There is no warranty or guarantee on this dll either. That said, if you find a problem with it, please notify me at swarner@frii.com and I will do everything I can to resolve it. If you like it, let me know also.

There is a small chance that the timer used in this dll will conflict with the timer in another program. There is no way (that I know of) in Windows to dynamically get a timer that is not in use. If skins using this dll do conflict with another program using a timer, let me know about it at the above email address and I will change the timer in the dll.

To use Cclock.dll, the following information must be added to the UIS2 personality definition:

[CClock]

This section contains all the same settings and the default clock.dll with several additions.

Mode = <1, 2, 3>

• Mode 1 is the default. It allows you to define a single format for the clock.
• Mode 2 allows you to define up to 10 formats for the clock. It will change format when the user clicks on the clock.
• Mode 3 allows you to define 2 formats. The first is the default, and the 2^nd will be displayed as long as the user has the mouse button pressed over the clock.
• Required

NumFormats = <the number of defined formats>

• This must be set to the number of defined formats when using Mode 2. (It can be set to less than the number of formats to exclude formats at the end of the list, but must not be set to a number less than 1 or greater than 10).
• Required for Mode 2; optional for Modes 1 & 3.

Format = <the format string>

• This is the default clock format.
• If the Mode = 1, this format will be displayed at all times.
• If the Mode = 2, this will be displayed when a window is first opened. (There is an interesting feature (bug?) in WB. Each window will keep track of its time format setting separately. This means that 1 window will show the time, and another can show the date.)
• If the Mode = 3, this format will be displayed unless the mouse button is held down on the clock.
• See the Format String Elements section below for information about creating a format string.
• Maximim size - 50 characters
• Required

Format2 = <the format string>

• If the Mode = 1, this format is not used.
• If the Mode = 2, this format will be displayed when the clock is clicked.
• If the Mode = 3, this format will be displayed while the mouse button is pressed on the clock.
• Maximim size - 50 characters
• Required if Mode = 2 or 3

Format3 = <the format string>

Format4 = <the format string>

Format5 = <the format string>

Format6 = <the format string>

Format7 = <the format string>

Format8 = <the format string>

Format9 = <the format string>

Format10 = <the format string>

• If the Mode = 1 or 3, these format are not used.
• If the Mode = 2, these formats will be displayed when the clock is clicked (Up to the number defined in NumFormats).
• Maximim size - 50 characters
• Optional

FormatColorR = <the clock text color RED component>

FormatColorG = <the clock text color GREEN component>

FormatColorB = <the clock text color BLUE component>

• This is the default format clock text color.
• If these are not present, the color will default to the system caption text color.
• Must be between 0 and 255 (inclusive)
• Optional

Format2Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format3Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format4Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format5Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format6Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format7Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format8Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format9Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

Format10Color[R,G,B] = <the clock text color RED, GREEN, and BLUE components>

• This is the clock text color for each of the numbered formats.
• If these are not present, the color will default to the default format clock text color (see FormatColor above).
• Must be between 0 and 255 (inclusive)
• Optional

The following information is taken from BuilderBlinds.

FontName = <font name>

• The typeface for the primary clock format.
• Required

FontSize = <font size>

• The size (in pixels) of the typeface for the primary clock format.
• Required

TextJustify = <1,2,3>

• The text justification within the button
• 1 - Left justified
• 2 - Center justified (the default)
• 3 - Right justified
• Optional

FontWeight = <font weight>

• The weight of the font.
  • 100 - Thin
  • 200 - Extra Light
  • 300 - Light
  • 400 - Normal
  • 500 - Medium
  • 600 - Semi-Bold
  • 700 - Bold
  • 800 - Extra Bold
  • 900 - Heavy
• Required

Background = <background bitmap image name>

• An optional background image for the clock.
• If not present it will have a transparent background.
• Optional

UpdateTimer = <update interval in milliseconds>

• The clock update interval, specified in milliseconds.
• Must be between 1 and 32767.
• Optional

The next 4 attributes can be used to make the clock fade in and out. The amount of fading will oscillate between the min and max values, changing by the increment value each time.

ButtonNo = <button number>

• Special feature. If you specify the button then WB will fade it in & out. Normally you would specify the button which is the timer, but in theory you could use any other defined button and it will fade in & out.
• Optional

AlphaInc = <increment value>

• The increment amount to alter the alpha value.
• Must be between 1 and 255.
• Default is 1
• Optional

MinAlpha = <minimum alpha value>

• Set the minimum level for the alpha transparency.
• Must be between 1 and 255.
• Default is 5
• Optional

MaxAlpha = <maximum alpha value>

• Set the maxmum level for the alpha transparency.
• Must be between 1 and 255.
• Default is 255
• Optional

Format String Elements

The modifier is the "#" sign

NOTE: You can mix normal text in with these elements except there is a bug in Windows where the '#' character will not show up. See below for some examples.

Examples

• "@ %T" prints "@ 602"
• "@ %#T" prints "@ 12"
• "%b %#d, %Y" prints "Nov 5, 1999"
• "%#I:%M:%S %q" prints "3:07:09 pm"

Sample UIS Entry

This sets up a clock that will show an alternate format when clicked. The primary format will be displayed in black, the alternate in white.

[CClock]
Mode = 3
NumFormats = 2

Format = %#I:%M:%S %q
FontName = Tahoma
FontSize = 16
FontWeight = 600
FormatColorR = 0
FormatColorG = 0
FormatColorB = 0

Format2 = %b %d, %Y
Format2ColorR = 255
Format2ColorG = 255
Format2ColorB = 255

Change Log

• 29 October 1999
  • Changed the timer to be less problematic; changes suggested by Neil Banfield.
• 5 November 1999
  • Fixed a bug where the clock always used Arial for the clock font. Found by 'd'.
  • Added color settings for each format. Suggested by Brad Wardell
  • Added examples and sample entry to the documentation

Version 1.1

• 19 February 2000
  • Added left and right justification to the text. Suggested by 'd'.
  • Added two new String Elements ('X' and 'x') for Local Date and local Time representation

Version 1.1.1

• 10 May 2000
  • Fixed problem where am/pm indicator didn't change over until 1:00. Found by Alobar Greywalker.