home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d584 / wizardfiler.lha / WizardFiler / WizardFiler.doc < prev    next >
Text File  |  1992-01-04  |  9KB  |  231 lines
  1. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  2.  
  3.  
  4.                              WIZARD FILER 1.01
  5.  
  6.             A PUBLIC DOMAIN FILE REQUESTER BY ! WIZARD WORKS !
  7.  
  8.  
  9. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  10.  
  11.   Program:                 WizardFiler
  12.   Version:                 1.01
  13.   Authors:                 Anders Bjerin (Original FileWindow 1.20)
  14.                            Stefan Zeiger (WizardFiler)
  15.   Language:                C (100%)
  16.   Compiler:                SAS/C 5.10a
  17.   AmigaDOS:                Tested with 1.3
  18.  
  19. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  20.  
  21.  
  22.   PARTS OF ANDERS BJERIN'S DOCUMENTATION OF "FILEWINDOW 1.20"
  23.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24.   (Ref.nr. 3A-146-1) :
  25.   ~~~~~~~~~~~~~~~~~~~~
  26.  
  27.   FILE WINDOW v1.20 was created by Anders Bjerin, and is distributed as
  28.   public domain with NO RIGHTS RESERVED. That means that you can do
  29.   what ever you want with the program.
  30.   
  31.   You may use FILE WINDOW in your own programs, commercial or not, and 
  32.   do not even need to mention that you have used it. You may alter the
  33.   source code to fit your needs, and you may spread it to anyone.
  34.   
  35.   The reason why I created FILE WINDOW was that I never more wanted to
  36.   see that old stupid "Please type in filename:" prompt. It is a disgrace
  37.   for any program to use it, and VERY annoying for the user.
  38.   
  39.   REMEMBER, one of the first things the user will see of your program is
  40.   the file requester. If you want your program to make a good impression,
  41.   and look solid, I would recommend you to use a good file requester.
  42.   
  43.   FILE WINDOW is written to be as easy as possible to use, and is fully
  44.   amigaized. It is similar to other good file requesters, but has several
  45.   advantages:
  46.   
  47.    1. FILE WINDOW dynamically allocates memory for each file. That means
  48.       that there is no memory wasted as it would have been if you had
  49.       statically allocated the filenames in arrays. It also means that the 
  50.       memory is the only limitation on how many files the program can
  51.       display.
  52.  
  53.    2. While FILE WINDOW is reading the directories, it is still obeying
  54.       your commands. You may change directory, type in the file name
  55.       yourself etc etc while the program still is working. All of us know
  56.       how irritating it is to see the little Zzz pointer in a program
  57.       while the disk is examined. This is especially annoying when you know
  58.       the filename, and only want to type it in.
  59.  
  60.    3. FILE WINDOW was written for the Amiga. It uses boolean, string and
  61.       proportional gadgets, and is using them as recommended. For example,
  62.       the proportional gadget's knob changes size corresponding to how
  63.       many files/directories there are. (It is strange that there are
  64.       several file requesters using a static small knob instead. That
  65.       makes it much harder for the user to see how many files there are in
  66.       the directory.)
  67.  
  68.    4. FILE WINDOW has a boolean gadget "<" which steps back one directory
  69.       each time it is pressed. (Same as "/ Parent dir")
  70.  
  71.    5. You can specify a file-extension, and only the files with that
  72.       extension will be displayed. (Directories are always showed.)
  73.       The user can also change the extension since it is a string gadget.
  74.       (If there are any characters in the string gadget, the text "Ext:"
  75.       will be highlighted to tell the user that EXTENSION MODE is on.)
  76.  
  77.    6. The files/directories are automatically sorted alphabetically while
  78.       they are taken from the disk. Directories first, highlighted with the
  79.       ending (Dir), and then the files.
  80.  
  81.    7. FILE WINDOW deallocates all memory allocated, and is fool proof. If
  82.       something goes wrong (not enough memory, wrong directory name etc),
  83.       the program will open a requester and tell the user what the 
  84.       problem is.
  85.  
  86.    8. The source code is distributed with the program so you can alter it
  87.       to fit your needs.
  88.  
  89.    9. FILE WINDOW is not as a normal file requester, since it uses a
  90.       (surprise, surprise) window instead of a requester to display the
  91.       files on. That means that the calling program does not need to
  92.       have a window itself, to be able to use FILE WINDOW. (A normal
  93.       requester always needs a pointer to a window.)
  94.  
  95.   10. There are no Image structures in the code, so FILE WINDOW does not
  96.       need to be in the CHIP memory.
  97.  
  98.   11. When FILE WINDOW has examined all files in the directory, the
  99.       program is put to sleep. That will speed up other programs, and 
  100.       will not use unnecessary processing time.
  101.  
  102.   12. Fast updating of the display.
  103.  
  104.  
  105.   FILE WINDOW is very easy to install in your program, and I have even
  106.   done an example on how to use it. The source code is full of comments
  107.   to make it easier for you to change something in the program.
  108.  
  109.  
  110. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  111.                 NOW SOME CHANGED DOCS FOR WIZARD FILER 1.01
  112. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  113.  
  114.  
  115.   HOW TO USE WIZARD FILER:
  116.   ~~~~~~~~~~~~~~~~~~~~~~~~
  117.   operation=WizardFiler( title, ToShow, ToHide, x, y, screen, file );
  118.  
  119.   operation: a variable which will contain the "flags" WIZARD FILER returned.
  120.   title:     string containing the name of the WIZARD FILER.
  121.   ToShow:    string to be used as a file pattern.
  122.   ToHide:    string to be used as a file pattern.
  123.   x:         x position of the WIZARD FILER.
  124.   y:         y position of the WIZARD FILER.
  125.   screen:    pointer to a screen if there exist one.
  126.   file:      a string which will contain the file name together with
  127.              the entire path. (For example: "df0:letters/payments.doc".
  128.  
  129.  
  130.   Title is a string which will appear on the drag gadget. Write NULL if
  131.   you do not want any string there.
  132.  
  133.   ToShow is a 100 character long string. 99 letters and the NULL ('\0') sign.
  134.   If you give WIZARD FILER a string, the program will only display
  135.   the files which match with your pattern. (Directories will always be
  136.   displayed.) If you do not want to use a file extension you simply write
  137.   NULL.
  138.  
  139.   It's the same with ToHide, except that all files matching this pattern will
  140.   NOT be shown.
  141.   
  142.   On a NTSC screen (200 lines) y can be between 0 and 37. On a PAL screen
  143.   (256 lines) between 0 and 93.
  144.   
  145.   If your program is using a CUSTOM SCREEN you should give FILE WINDOW a
  146.   pointer to your screen. Otherwise, if you are using a WBENCH SCREEN you
  147.   simply write NULL.
  148.   
  149.   Name is a string which can already contain a file name with path if
  150.   you want. If the string is empty, WIZARD FILER will start to display the
  151.   current directory. When the user has selected the file to LOAD or SAVE it
  152.   is here you should look for the file name with path.
  153.   
  154.  
  155.   Examples:
  156.   ~~~~~~~~~    
  157.     1. operation=WizardFiler( NULL, NULL, NULL, 0, 0, NULL, file);
  158.  
  159.        operation has been declared as: USHORT operation;
  160.        file has been declared as     : UBYTE file[TOTAL_LENGTH];
  161.     
  162.  
  163.     2. operation=WizardFiler(title, toshow, tohide, x, y, my_screen, file);
  164.        
  165.        operation has been declared as: USHORT operation;
  166.        title           -"-           : UBYTE title[ANY_LENGTH];
  167.        toshow          -"-           : UBYTE toshow[100];
  168.        tohide          -"-           : UBYTE tohide[100];
  169.        x, y            -"-           : SHORT x, y;
  170.        my_screen       -"-           : struct Screen *my_screen;
  171.        file            -"-           : UBYTE file[TOTAL_LENGTH];
  172.  
  173.  
  174.   Remember to "include" the file "WizardFiler.h"!
  175.   ex: #include "WizardFiler.h"
  176.  
  177.  
  178. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  179.  
  180.  
  181.   ADDITIONAL REMARKS TO WIZARD FILER 1.01 BY STEFAN ZEIGER :
  182.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  183.  
  184.   Enhancements from FileWindow 1.20 to WizardFiler 1.00:
  185.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  186.   1. 21 device gadgets with your devices, assign and volumes (in that order).
  187.  
  188.   2. Display for 13 filenames instead of 8.
  189.  
  190.   3. "GET DIR" gadget added, so that you can re-scan the currently displayed
  191.      directory, if an other program has changed it.
  192.  
  193.   4. Proportional gadget calculations changed from "float" to "ULONG", so
  194.      that you don't need to link with a math library.
  195.  
  196.   5. A very nice WB2.0 design.
  197.  
  198.   6. "Hide" and "Show" gadgets with pattern matching.
  199.  
  200.   Enhancements in WizardFiler 1.01:
  201.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  202.   1. Bug fixed. The device gadget in column 3, line 2 is now working.
  203.  
  204. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  205.  
  206.   Amiga is a registered trademark of Commodore-Amiga Inc.
  207.   AmigaDOS is a registered trademark of Commodore-Amiga Inc.
  208.   Lattice is a registered trademark of Lattice Inc.
  209.   SAS/C is a registrated trademark of SAS Institute Inc.
  210.  
  211. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  212.  
  213.  
  214.           R.I.P.  (Remain in programming)
  215.  
  216.                 Stefan.
  217.  
  218.  
  219.  
  220. -----------------------------------------------------------------------------
  221.  
  222.   STANDARD MAIL : ! WIZARD WORKS !
  223.                   Stefan Zeiger
  224.                   Seligenstaedter Weg 24
  225.                   D-W-8756 Kahl
  226.                   West Germany
  227.  
  228.   VOICE :         (49)-6188-2525
  229.  
  230. -----------------------------------------------------------------------------
  231.