home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / dirs / ie_377.lzh / IE / IE.doc < prev    next >
Text File  |  1990-10-10  |  11KB  |  270 lines
  1.                ***********************************************************
  2.                * IE - THE COMPLETE ICON EDITOR             (version 2.0) *
  3.                ***********************************************************
  4.  
  5.                                                    by Peter Kiem
  6.                                                       3 Beazley Crescent,
  7.                                                       Calwell 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.   Please note that this program is now released as SHAREWARE!!!
  24.  
  25.         If  you like this program and use it please send a small  donation
  26.   of  around A$10 to support my programming efforts.  You will then get  a
  27.   registered copy of the program and further updates for free.
  28.  
  29.         Registered users can get a copy of the Source Code for A$20.
  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 3 Meg memory, A590 Hard Drive  and  an  external
  39.   floppy drive.  The compiler I own is Manx Aztec C version 5.0b.
  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 images so you can use IE
  81.            to create gadget images and save them as C Code for inclusion in
  82.            your programs).
  83.  
  84.         ADDED IN VERSION 1.1
  85.  
  86.         - Key shortcuts to menus.
  87.         - Read IFF picture into current icon image.
  88.         - Set the colours of the window opened by the icon.
  89.  
  90.         ADDED IN VERSION 1.2
  91.  
  92.         - Write  icon as IFF picture to allow the use of more  sophisicated
  93.           packages' editing (e.g. DPaint).
  94.  
  95.         ADDED IN VERSION 2.0
  96.  
  97.         - Automatically detects how many colours your workbench is  running
  98.           with  and  allows  the   editing/conversion  of  icons  with  the
  99.           appropiate number of bitplanes (2-3 bitplanes).
  100.  
  101.  
  102.  
  103.   CALLING IE:
  104.  
  105.         IE  can  be run from either the workbench or from the CLI.  To  run
  106.   IE from the CLI the following call is used:
  107.  
  108.         IE [filename]
  109.  
  110.   where filename is an optional parameter which is the icon to load.
  111.   NOTE:  IT  IS  NOT NECESSARY TO HAVE THE .INFO IN THE FILENAME.  THIS  IS
  112.   REMOVED BEFORE LOADING THE ICON AS THE SYSTEM ROUTINES DON'T LIKE IT.
  113.  
  114.         When  calling IE from the workbench, if you select a  PROJECT  icon
  115.   before  activating  IE  (via SHIFT KEY-DOUBLE CLICK)  the  icon  will  be
  116.   automatically loaded into IE.
  117.  
  118.   **HINT**  To make a library of icons for use, save the icons as  PROJECTs
  119.   so  you can use the above method to automatically load IE with the  icon.
  120.   The icons can then be changed to the appropiate type and saved to its new
  121.   destination.  As  the  icons are projects you can also  set  the  DEFAULT
  122.   TOOL  to  IE (don't forget the path) and then by DOUBLE CLICKING  on  the
  123.   icon, IE will be loaded with the icon.
  124.  
  125.  
  126.  
  127.   ICONIFY FUNCTION:
  128.  
  129.         By  selecting ICONIFY from the IE menus, all IE windows are  closed
  130.   and  a small window is opened.  This allows you to get IE totally out  of
  131.   the  way temporarily.  This small window can then be dragged to  anywhere
  132.   on  the screen.  To un-iconify IE simply activate the window by  clicking
  133.   the  left  mouse  button  in the window and then click  the  right  mouse
  134.   button.  All IE windows will the be opened in the same place and size  as
  135.   before.
  136.  
  137.  
  138.  
  139.   PREVIEW WINDOW:
  140.  
  141.         By selecting PREVIEW from the IE menus, a preview window is opened.
  142.   This window displays the icon as it will appear on the workbench  screen.
  143.   By clicking the left mouse button in this window, the icon render  images
  144.   change simulating the action of selecting the icon.
  145.  
  146.  
  147.  
  148.   INFO EDIT WINDOW:
  149.  
  150.         By selecting EDIT INFO from the IE menus, a info-editing window  is
  151.   opened.  This  window  allows you to change the icon type,  icon  render,
  152.   tool types, default tool and size of opened window amongst other things.
  153.         In version 1.1 the ability to change the opened window colours  was
  154.   added.  By clicking in the coloured squares under Title Colour and Border
  155.   Colour you can select the colour to use.  Title colour is the colour used
  156.   to  render  the  text  in  the window title  and  Border  colour  is  the
  157.   background colour for the window borders.
  158.   NOTE:  You  must  reload the window containing the icon to  get  the  new
  159.   colours.
  160.  
  161.  
  162.  
  163.   CHANGING THE BITMAP:
  164.  
  165.         By clicking the left mouse button in the bitmap display on the left
  166.   side  of the main window, the selected pixel is changed to  the  selected
  167.   colour.  By  holding down the left mouse button and dragging the  pointer
  168.   you  can continuously draw in the bitmap.
  169.         When  the Flood Fill gadget is on, the action of clicking the  left
  170.   mouse  button  will  change  the area colour under  the  pointer  to  the
  171.   selected  colour.  It  probably is a good idea to save your  icon  BEFORE
  172.   doing a flood fill in case the area you selected wasn't properly  bounded
  173.   and  the  flood  fill  does more than  you  think.  Only  horizontal  and
  174.   vertical connections are checked for flood fill (diagonals are  ignored).
  175.         DON'T FORGET TO TURN OFF THE FLOOD FILL GADGET WHEN FINISHED!!!
  176.  
  177.  
  178.  
  179.   MOVING THE ICON BITMAP:
  180.  
  181.         By  selecting  the arrow gadgets, the icon  image  currently  being
  182.   displayed  is  moved 1 pixel within the bitmap editing display  to  allow
  183.   for expanding the size of the icon.
  184.  
  185.  
  186.  
  187.  
  188.   GENERATING C CODE:
  189.  
  190.         By  selecting  OUTPUT C CODE from the IE menus, the  icon  data  is
  191.   written to a file of your choice in the C language.
  192.         One use of this is for your programs to generate their own icons.
  193.  
  194.  
  195.   The following example shows how to write an icon to a file.  This assumes
  196.   you generated the C Code to a file called "c-code" and are generating the
  197.   icon "test.info":
  198.  
  199.         #include <exec/types.h>
  200.         #include <intuition/intuition.h>
  201.         #include <workbench/workbench.h>
  202.  
  203.         #include <functions.h>
  204.         #include "c-code";
  205.         extern struct IconBase *IconBase;
  206.  
  207.         void main()
  208.  
  209.         {
  210.           IconBase = (struct IconBase *)
  211.                      OpenLibrary("icon.library", LIBRARY_VERSION);
  212.           PutDiskObject("test", &Icon);
  213.           CloseLibrary(IconBase);
  214.           exit();
  215.         }
  216.  
  217.   You  can  also  use the generated C Code for any-size, 2 or  3  bit-plane
  218.   image.
  219.   For  example: you can draw the desired gadget pictures for  your  program
  220.   using  the  IE editor, generate the C Code to a file and  use  the  Image
  221.   definitions that were generated for use in your program.
  222.  
  223.  
  224.  
  225.   READ IFF PICTURE (version 1.1)
  226.  
  227.         By  selecting READ IFF from the IE menus, IFF pictures can then  be
  228.   read  into the icon image you are currently editing.  This can even  read
  229.   DPaint  brushes.  NOTE: If the picture (or brush) you load does not  have
  230.   colours that match the workbench colours, your picture will load with the
  231.   workbench colours and hence may not appear as it did in the IFF picture.
  232.  
  233.  
  234.  
  235.   WRITE IFF PICTURE (version 1.2)
  236.  
  237.         By  selecting WRITE IFF from the IE menus, the icon image  you  are
  238.   editing can be written out as an IFF picture.  You can then load this IFF
  239.   picture  into a package (like DPaint) for the more sophisticated  editing
  240.   controls  that those packages offer.  The IFF picture written  will  have
  241.   the same colours as did workbench.
  242.  
  243.  
  244.  
  245.   EIGHT COLOUR ICONS (version 2.0)
  246.  
  247.         When  IE is started it looks at the workbench to find out how  many
  248.   bitplanes  are  in  operation.  If  your  workbench  is  running  with  3
  249.   bitplanes then you will have up to 8 colours available for icons else you
  250.   will only have the standard 4 colours.
  251.         If  you  load a 2 bitplane icon while in 3 bitplane mode  the  icon
  252.   will be converted to allow the use of more colours.  A requester will  be
  253.   displayed to inform you if this happens.
  254.         If  you  load a 3 bitplane icon while in 2 bitplane mode  the  icon
  255.   will  be converted to use only the 4 standard colours.  A requester  will
  256.   be  displayed to inform you if this happens.  If the icon is  reduced  in
  257.   colours  there  may be a change in some of the icons colours due  to  the
  258.   loss  of the extra bitplane.  This function is useful to fix icons  which
  259.   look OK in 2 bitplanes but are corrupted in 3 bitplanes.
  260.  
  261.  
  262.  
  263.   FINAL NOTE:
  264.  
  265.         The  rest of the program I think is quite self explanatory  but  if
  266.   you require any help just contact me and I will help as much as I can.
  267.         I really hope that this program is of use to you and if you like it
  268.   give it to all of your friends.
  269.         Best wishes and happy Iconing...
  270.