@database "Done V 1.02 Guide"
@author "Stuart Kelly"
@(c) "Copyright 1996 © of Stuart Kelly"
@$VER: "Done Guide V 1.01"

@Index in

@node Main "Done V 1.02 Guide"

 @{fg shine}Done V 1.02 Guide By Stuart Kelly Copyright 1996 ©@{fg text}

 @{" About Done             " link about}
 @{" Copyright              " link copy}
 @{" Usage                  " link use}
 @{" My Address             " link address}
 @{" Programs That Use Done " link progs}
 @{" My Other Programs      " link prog}

@endnode

@node about "About Done"

 Done is by Stuart Kelly Copyright 1996 ©

 I wrote Done because I needed a way of showing the progress of my
 programs.  Later I decided to give Done away so they can use it in there
 programs.  It has an Abort button so you can detect if a user wants to
 abort during a task.

 Done is not that hard to use, and looks ok.

 @{" Contents " link Main}
 
@endnode

@node copy "Copyright"

 Done Copyright of Stuart Kelly 1995 - 1996 ©

 Done V 1.02 is CARDWARE  - This means you can use it as long as you
 send me a card/e-mail.

 You may use Done with any program you want as long as you follow these
 simple rules:-

 1.  You may not edit done.h or done.o or this guide without written
     permission from the author.
 2.  You may not disassemble/decompile done.o.
 3.  You may not sell done for profit.
 4.  By Using Done you agree to the above points.
 
 You don't have to give me any credit for using DoneV1.02 in your program
 but I hope you do.

 Contents of this Archive:-

 done/done.o
 done/done.h
 done/test.c
 done/test1
 done/test2.c
 done/test2
 done/Programs
 done/Form
 done/compile.test
 done/compile.test2
 done/DoneV1.02-Guide
 
 @{" Contents " link Main}

@endnode
;
;
;
@node use "Usage"
@toc main

 This part of the guide is the best part, because it tells you how to use
 Done's Working Requester.

 @{" Introduction    " link use1}
 @{" Main Functions  " link use2}
 @{" Other Functions " link use3}
 @{" Exmaple Code    " link use4}

 @{" Contents " link main}

@endnode

@node use1 "Introduction"
@toc use

 Done V 1.02 is not that use.  It has an Abort button so you can detect
 if somebody wants to abort and supports the following @{fg shine}IDCMP@{fg text} flags:-
 
 @{fg shine}IDCMP_GADGETUP@{fg text} -------- For detecting When prople press Abort.
 @{fg shine}IDCMP_INTUITICKS@{fg text} ------ For doing something.
 @{fg shine}IDCMP_INACTIVEWINDOW@{fg text} -- For telling if the window is inactive.  This is
                         needed because @{fg shine}IDCMP_INTUITICKS@{fg text} doesn't work when
                         a window is incative.

 If you would like Done to support other IDCMP flags in the future then
 write_to/e-mail me at these @{" addresses " link address}.

 @{" Contents " link use}

@endnode

@node use2 "Main Functions"
@toc use

 There are 3 main functions that you will need to use:-
 @{fg shine}
 BOOL ST_WorkReq(struct Screen *ST_WaitScr);
 void ST_FreeWorkReq(void);
 BOOL ST_SetDone(int value); @{fg text}
 struct Window *ST_GetWindow(void);
@{fg fill} ---------------------------------------------------------------------------@{fg text}

 @{fg shine}BOOL ST_WorkReq(struct Screen *ST_WaitScr);@{fg text}

 Inputs:-
         ST_WaitScr - Pointer to a Screen.  If don't have an open screen
                      you can set to NULL.

 Retunrs:-
           Will return TRUE if the Work Requester could be opened.
           Returns FALSE if not.

 What it does:-  Opens the Working Requester Window.

@{fg fill} ---------------------------------------------------------------------------@{fg text}

 @{fg shine}void ST_FreeWorkReq(void);@{fg text}

 What it does:-  Closes the Working Requester Window.

@{fg fill} ---------------------------------------------------------------------------@{fg text}

 @{fg shine}BOOL ST_SetDone(int value);@{fg text}

 Input:-
        value - Value to set Working Requester. Range @{fg shine}0 - 248@{fg text}.
                @{fg shine}
                248 = 100 %
                124 =  50 %
                  2 = about  1 %
                @{fg text}

 What it does:-  Set Working Requester To a Value.  Can be done at any time
                 when the Working Requester is open.

@{fg fill} --------------------------------------------------------------------------@{fg text}

 @{fg shine}struct Window *ST_GetWindow(void);@{fg text}

 What it does:-  Get the pointer to the Woring Requester Window.  So that
                you can use @{fg shine}IntuiMessages@{fg text} in your programs.
 Returns:- Pointer to the window.

@{fg fill} ------------------------------------------------------------------------- @{fg text}

 @{" Contents " link use}

@endnode

@node use3 "Other Functions"
@toc use

 Other Functions of DoneV1.02:-
 @{fg shine}
 BOOL ST_SetTitles(UBYTE *screentitle, UBYTE *windowtitle);
 BOOL ST_ClearWR(void);
 BOOL ST_SetTopAndLeft(UWORD top, UWORD left);@{fg text}
@{fg fill} ---------------------------------------------------------------------------@{fg text}

  @{fg shine}BOOL ST_SetTitles(UBYTE *screentitle, UBYTE *windowtitle);@{fg text}

  Inputs:-
           screentitle - Title of the screen.
           windowtitle - Title of Window.

 What it does:-  Sets the title of the screen and window.  This can be done
                 at any time while the Working Requester is open.

@{fg fill} ---------------------------------------------------------------------------@{fg text}

 @{fg shine}BOOL ST_ClearWR(void);@{fg text}

 This function clears the Working Requester Totally.  This can be done
 at any time while the Working Requester is open.

@{fg fill} ---------------------------------------------------------------------------@{fg text}

 @{fg shine}BOOL ST_SetTopAndLeft(UWORD top, UWORD left);@{fg text}

 Inputs:-
          top -- how far from the top of the screen you want the window to
                 be.
          left - how far from the left of the screen you want the window to
                 be.

 NOTE: This can only be done @{fg shine}BEFORE@{fg text} ST_WorkReq(...);
       If you do it while the requester is open it will have no effect.
          

@{fg fill} ---------------------------------------------------------------------------@{fg text}
 @{" Contents " link use}

@endnode

@node use4 "Example Code"
@toc use

 There are two examples that come with Done V 1.02, test1.c and test2.c.

 View @{" test.c  " link "test.c/MAIN"}
 View @{" test2.c " link "test2.c/MAIN"}

 To compile test.c using Dice just execute the @{" compile.test " link "compile.test/MAIN"} script.
 To compile test2.c using Dice just execute the @{" compile.test2 " link "compile.test2/MAIN"} script.

 To use DoneV1.02 you must include the @{" done.h " link "done.h/MAIN"} with your program.
 And @{fg shine}done.o@{fg text} be linked with your program.

 Example using Dice By Matthew Dillion:-

 @{fg shine}dcc:bin/dcc my_prog.c done/done.o -o my_prog.exe@{fg text}

 This would link @{fg shine}done.o@{fg text} with @{fg shine}my_prog.exe@{fg text}.

 @{" Contents " link use}

@endnode
;
;
;
@node address "My Address"

 My Postal Address:@{fg shine}
                  Stuart Kelly
                  8 Squires Wood
                    Fulwood
                    Preston
                    Lancashire
                    PR2 5QA
                    ENGLAND UK@{fg text}

 My E-Mail Address: @{fg shine}stuart@dkelly1.demon.co.uk@{fg text}

 @{" Contents " link main}

@endnode

@node progs "Programs That Use Done"

 @{" List of Programs That Use Done " link "Programs/MAIN"}

 To add your program to the list fill in this @{" Form " link "Form/MAIN"}
 and send it to either of these @{" addresses " link address}.

 @{" Contents " link Main}

@endnode

@node prog "My Other Programs"

 Done Versions:-

 V 1.01 -- Private Version, not very easy to use.
 V 1.02 -- First Public Version.  Made easy to use fixed a few bugs.

 Ubdates can be found on the Aminet in the dev/misc/ drawer.

 Telephone Book V 3.3 -- Stores your friend's telephone numbers and
                         addresses.  Easy To use, new version soon.
                         Available from the Aminet - biz/dbase/

 Lockup V 4.2 -- Lock up Hard drive on boot up, not finished yet, but
                 will be availble soon.

 @{" Contents " link main}

@endnode

@node in "Index"

 @{" About Done                     " link about}
 @{" Copyright                      " link copy}
 @{" How To Use Done                " link use}
  ** @{" Introduction               " link use1}
  ** @{" Main Functions             " link use2}
  ** @{" Other Function             " link use3}
  ** @{" Example Code               " link use4}
 @{" My Addresses                   " link address}
 @{" List of Programs That Use Done " link progs}
 @{" Other Programs                 " link prog}
 @{"                                " link in}

@{fg fill}-----------------------------------------------------------------------------@{fg text}

 @{" Main Contents " link main}
 
@endnode