/****************************************************************************
 File: readme.txt

 (C) Copyright 1992 by GO Corporation, All Rights Reserved.

 $Revision:   1.7  $
   $Author:   pstahl  $
     $Date:   13 Mar 1992 16:03:02  $

 Clock is an application that serves two purposes: a digital alarm
 clock distributed as a part of PenPoint, and a sample application.
 
 The end-user can configure the clock's display by changing the placement
 of the time and date and by specifying things like whether the time
 should include seconds. The end-user can also set up an alarm. Depending
 on how the user configures an alarm, it might beep at a certain time on
 a certain day or display a note every day at the same time.
****************************************************************************/

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *								Objectives					  			   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
 This sample application shows how to:
	-:	observe the system preferences for changes to date/time formats
	-:	observe the power switch to refresh on power-up
	-:	provide option cards for an application
	-:	destroy unneeded controls on a default application option card
	-:	disable inappropriate controls on a default application option card
	-:	respond to msgGWinForwardedGesture (including handling,
		forwarding, and ignoring gestures)
	-:	provide quick help
	-:	make use of clsTimer
	-:	use StdError to display application-level error messages.
*/

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *								Class Overview	  						   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
 Clock defines four classes: clsClockLabel, clsClockApp, clsClockWin, and
 clsNoteCorkBoardWin.
 It makes use of the following classes:

	clsApp
 	clsAppMgr
	clsAppWin
	clsClass
	clsCommandBar
	clsDateField
	clsGotoButton
	clsIconWin
	clsIntegerField
	clsLabel
	clsNote
	clsOptionTable
	clsPopupChoice
	clsPreferences
	clsString
	clsTableLayout
	clsTextField
	clsTimer
	clsTkTable
	clsToggleTable

 clsNoteCorkBoardWin appears as a corkboard on the pop-up note that Clock 
 displays when an alarm goes off. The note needs to be dismissed when 
 the user opens one of the icons in the window. To provide this functionality,
 clsNoteCorkBoardWin observes objects inserted into its window.

 Clock uses a table layout of several windows. There can be up to four
 child windows (time digits, am/pm indicator, alarm indicator, and the date).
 All of these are labels. clsLabel only repaints the right-most characters 
 that change. So, to minimize flashing as time ticks away, Clock 
 displays the time digits in a separate window from the am/pm indicator.

 clsClockApp does not file its labels or client window. It does, however, 
 file most of the settings of the controls in its Display and Alarm option 
 cards. It also files its clsNoteCorkBoardWin corkboard window.
*/

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *									Files Used	  						   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* 
 The code for Clock is in \PENPOINT\SDK\SAMPLE\CLOCK. The files are:

	BITMAP.RES:	    Resource file (compiled) for the clock accessory icon.
	CLABEL.C:	    Source code for clsClockLabel.
	CLABEL.H:	    Header file for clsClockLabel.
	CLOCK.RC:	    Resource file (uncompiled) for the clock's quick help
				    and error message strings.
	CLOCKAPP.C:	    Source for clsClockApp, the application class.
	CLOCKAPP.H:	    Header file for the application class.
	CWIN.C:		    Source code for clsClockWin.
	CWIN.H:		    Header file for clsClockWin.
	METHODS.TBL:	The method tables for the four classes.
	NCBWIN.C:	    Source code for clsNoteCorkBoardWin.
	NCBWIN.H:	    Header file for clsNoteCorkBoardWin.
*/ 

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *								Compiling	  							   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* 
 To compile Clock, just 
	cd \penpoint\sdk\sample\clock
	wmake
 This compiles the application and creates CLOCK.EXE and APP.RES in 
 \PENPOINT\APP\CLOCK.
*/

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *								Running	  								   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
 After compiling Clock, you can run it by
	1) Adding \\boot\penpoint\app\clock to \PENPOINT\BOOT\APP.INI
    2) Booting PenPoint
	3) Tapping on the Accessories icon to open it, and then tapping on "Clock".

 Note: Most PenPoint configurations list the Clock application in 
 \PENPOINT\BOOT\APP.INI. If this is done in your configuration, then 
 you can skip step 1 above.
*/

