home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 371.lha / IE_v1.0 / IE.doc < prev    next >
Encoding:
Text File  |  1990-05-05  |  7.6 KB  |  209 lines
  1.          ***********************************************************
  2.          * IE - THE COMPLETE ICON EDITOR             (version 1.0) *
  3.          ***********************************************************
  4.  
  5.                          by Peter Kiem
  6.                             8 Southern Close,
  7.                         Chisholm A.C.T. 2905
  8.  
  9.  
  10.  
  11.   DISCLAIMER:
  12.  
  13.     You have the right to freely use, copy and distribute this program
  14.   as long as the following conditions are met:
  15.  
  16.     1.  The program and documentation are not modified in any way;
  17.     2.  The program is not used or included in any package for  profit
  18.       unless written consent from the author is obtained.
  19.  
  20.     NOTE: The author does not accept any responsibility for any damage
  21.     that might result from the use of this program.
  22.  
  23.     For a A$20 donation, the source code is available from the  author
  24.   at  the  listed address.  This source code is made available  for  other
  25.   programmers  as  a guide to Amiga programming and is not to be  used  to
  26.   distribute  modified  copies.  If you have  modifications  (improvements 
  27.   etc)  please  send  them to the  author.  These  modifications  will  be
  28.   included  in the  next  version  at  the  author's  discretion  with  an
  29.   appropriate recognition of the programmer in the program messages.
  30.  
  31.  
  32.  
  33.   FROM THE AUTHOR:
  34.  
  35.     Now we have dispensed with all the boring legal stuff, we can  now
  36.   get down to the interesting stuff:
  37.     I  am a CSO2 programmer with the Commonwealth  Public  Service.  I
  38.   own  an  Amiga 500 with 1 Meg memory, A590 Hard Drive  and  an  external 
  39.   floppy drive.  The compiler I own is Manx Aztec C version 3.6a.
  40.     I  wrote  IE  mainly as an exercise in learning Amiga  C,  but  it
  41.   started  out  with  a dissatisfaction with the  supplied  icon  programs
  42.   (ICONED and ICONMERGE).  I was disgusted with the fact that  dual-render
  43.   icons (icons that change picture when selected) could only be created by
  44.   using ICONED to make two icons and ICONMERGE to join the icons together.
  45.   ICONED also did not allow you to edit the dual-render icons so  created.
  46.   I  also have some large icons from off the public domain which were  too
  47.   large to be edited with ICONED.
  48.     I  then  resolved to create an icon editor with  all  conceiveable
  49.   icon functions with the capability of creating REALLY LARGE  dual-render
  50.   icons.
  51.     I  hope  that you find this program useful and you include  it  on
  52.   your system as a replacement to ICONED.
  53.  
  54.  
  55.  
  56.   FEATURES OF IE:
  57.  
  58.     IE has the following abilities:
  59.  
  60.     - Can create icons up to 640x200 pixels.
  61.     - Handles creation and editing of dual-rendered icons.
  62.     - Uses scroll bars for ease of moving around icon bitmap.
  63.     - Icon preview function allows you to see what your icon will look
  64.       like without leaving the program.  Any changes made to the  icon
  65.       bitmap can be seen immediately in the preview.
  66.         - Detaches from CLI for background running.
  67.     - Able  to  edit miscellaneous aspects of the icon  including  the
  68.       aspects edited by the WorkBench menu item "INFO"
  69.         - Icon Type (DISK/DRAWER/PROJECT/TOOL/GARBAGE)
  70.         - Icon Select Highlight (COMPLEMENT/BACKFILL/ALTERNATE PIC)
  71.         - Position of Icon (including FIND BEST POSITION)
  72.         - Stack Size (for project and tool icons)
  73.         - Default Tool (for disk and project icons)
  74.         - Definitions of up to 10 Tool Type strings
  75.         - Size  and  placement of opened window (for  disk,  drawer
  76.                   and garbage icons).
  77.     - Flood fill colouring.
  78.     - Iconify to shrink windows.
  79.     - Write Icon as C Code so your programs can write their own icons.
  80.       (Can also be used to generate C Code for 2 bitplane images so you
  81.        can use IE to create gadget images and save them as C Code for
  82.        inclusion in your programs).
  83.  
  84.  
  85.  
  86.   FEATURES YET TO BE IMPLEMENTED:
  87.  
  88.     Version 2.0 is in the pipeline for completion when I find the  time
  89.   to finish it.  The proposed features are as follows:
  90.  
  91.     - A better file requester.
  92.     - Read IFF picture as an icon bitmap.
  93.     - Write icon as IFF picture.  To allow the use of more sophisicated
  94.           packages' editing.
  95.         - Miscellaneous ideas too numerous to mention...
  96.  
  97.  
  98.  
  99.   CALLING IE:
  100.  
  101.     IE  can  be run from either the workbench or from the CLI.  To  run
  102.   IE from the CLI the following call is used:
  103.  
  104.     IE [filename]
  105.  
  106.   where filename is an optional parameter which is the icon to load.
  107.   NOTE:  IT  IS  NOT NECESSARY TO HAVE THE .INFO IN THE FILENAME.  THIS  IS
  108.   REMOVED BEFORE LOADING THE ICON AS THE SYSTEM ROUTINES DON'T LIKE IT.
  109.  
  110.  
  111.  
  112.   ICONIFY FUNCTION:
  113.  
  114.     By  selecting ICONIFY from the IE menus, all IE windows are  closed
  115.   and  a small window is opened.  This allows you to get IE totally out  of
  116.   the  way temporarily.  This small window can then be dragged to  anywhere
  117.   on  the screen.  To un-iconify IE simply activate the window by  clicking
  118.   the  left  mouse  button  in the window and then click  the  right  mouse
  119.   button.  All IE windows will the be opened in the same place and size  as
  120.   before.
  121.  
  122.  
  123.  
  124.   PREVIEW WINDOW:
  125.  
  126.     By selecting PREVIEW from the IE menus, a preview window is opened.
  127.   This window displays the icon as it will appear on the workbench  screen.
  128.   By clicking the left mouse button in this window, the icon render  images
  129.   change simulating the action of selecting the icon.
  130.  
  131.  
  132.  
  133.   INFO EDIT WINDOW:
  134.  
  135.     By selecting EDIT INFO from the IE menus, a info-editing window  is
  136.   opened.  This  window  allows you to change the icon type,  icon  render,
  137.   tool types, default tool and size of opened window amongst other things.
  138.  
  139.  
  140.  
  141.   CHANGING THE BITMAP:
  142.  
  143.     By clicking the left mouse button in the bitmap display on the left
  144.   side  of the main window, the selected pixel is changed to  the  selected
  145.   colour.  By  holding down the left mouse button and dragging the  pointer
  146.   you  can continuously draw in the bitmap.
  147.     When  the Flood Fill gadget is on, the action of clicking the  left
  148.   mouse  button  will  change  the area colour under  the  pointer  to  the
  149.   selected  colour.  It  probably is a good idea to save your  icon  BEFORE
  150.   doing a flood fill in case the area you selected wasn't properly  bounded
  151.   and  the  flood  fill  does more than  you  think.  Only  horizontal  and
  152.   vertical connections are checked for flood fill (diagonals are  ignored).
  153.     DON'T FORGET TO TURN OFF THE FLOOD FILL GADGET WHEN FINISHED!!!
  154.  
  155.  
  156.  
  157.   MOVING THE ICON BITMAP:
  158.  
  159.     By  selecting  the arrow gadgets, the icon  image  currently  being
  160.   displayed  is  moved 1 pixel within the bitmap editing display  to  allow
  161.   for expanding the size of the icon.
  162.  
  163.   
  164.  
  165.  
  166.   GENERATING C CODE:
  167.  
  168.     By  selecting  OUTPUT C CODE from the IE menus, the  icon  data  is
  169.   written to a file of your choice in the C language.
  170.     One use of this is for your programs to generate their own icons.
  171.  
  172.  
  173.   The following example shows how to write an icon to a file.  This assumes
  174.   you generated the C Code to a file called "c-code" and are generating the
  175.   icon "test.info":
  176.  
  177.     #include <exec/types.h>
  178.     #include <intuition/intuition.h>
  179.     #include <workbench/workbench.h>
  180.  
  181.     #include <functions.h>
  182.     #include "c-code";
  183.     extern struct IconBase *IconBase;
  184.  
  185.     void main()
  186.  
  187.     {
  188.       IconBase = (struct IconBase *)
  189.                      OpenLibrary("icon.library", LIBRARY_VERSION);
  190.       PutDiskObject("test", &Icon);
  191.       CloseLibrary(IconBase);
  192.       exit();
  193.     }
  194.  
  195.   You  can also use the generated C Code for any-size, 2  bit-plane  image.
  196.   For  example: you can draw the desired gadget pictures for  your  program
  197.   using  the  IE editor, generate the C Code to a file and  use  the  Image
  198.   definitions that were generated for use in your program.  
  199.  
  200.  
  201.  
  202.   FINAL NOTE:
  203.  
  204.     The  rest of the program I think is quite self explanatory  but  if
  205.   you require any help just contact me and I will help as much as I can.
  206.     I really hope that this program is of use to you and if you like it
  207.   give it to all of your friends.
  208.     Best wishes and happy Iconing...
  209.