home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The Fred Fish Collection 1.5
/
ffcollection-1-5-1992-11.iso
/
ff_disks
/
600-699
/
ff621.lha
/
IE
/
IE.Doc
< prev
next >
Wrap
Text File
|
1992-03-21
|
28KB
|
679 lines
IE - The Complete Icon Editor by Peter Kiem
6 Romeo Crt
Sunnybank Hills
Brisbane 4109
Australia
ABOUT IE
IE is a shareware program which allows the creation and editing of icons
on the Amiga personal computer. Using IE you can make icons much larger and
easier than using the supplied icon editor on your system disks.
IE requires at least 1 Meg of memory (preferably 1 Meg CHIP memory).
DEMONSTRATION VERSION CHANGES
The demonstration version of IE is fully functional so you can test all
the functions of IE and determine if you wish to register or not. To
encourage you to register IE, the demonstration version also has a few
changes:
- After starting the demonstration version of IE two requesters will
be displayed giving information about the demonstration version and
about obtaining a registered copy of IE. These requesters will
disappear after 30 seconds each and you can then continue with IE.
- The demonstration version will also exit after any "save" operation
is performed. This is done so you can see the effects of changing an
icon with IE rather than totally disabling the save functions as some
demonstration programs do.
When you register your copy of IE you receive a registration number and
your name is coded into the title bar of IE as proof of your registration.
You will also be entitled to free upgrades if I create new versions of IE.
The source code is only available to registered users.
I am not making a living from writing IE so I have not charged as much
as I could had I marketed it commercially. A fully registered version of IE
will only cost you AUD$20 and source code another AUD$30 (if you want both -
AUD$50). Please respect the amount of time and effort I have put into IE
and consider the small fee asked if you continue to use this program.
DISTRIBUTION OF IE
You can freely distribute the DEMONSTRATION version of IE as long as the
following is observed:
- The program and documentation must be distributed together and are
not modified in any way. The only exception is that the program and
documentation may be compressed into an archive for uploading to
Bulletin Boards or for other electronic transmission.
- The program is not used commercially or included in a commercial
package for profit unless written authorisation from me is obtained
first. The demonstration version of IE may be freely included on public
domain library disks or compilation disks provided only a small fee is
charged for the service.
A REGISTERED version must NEVER be distributed in ANY way (after all,
you paid for it so why shouldn't others?).
WHAT ARE ICONS?
Icons are the pictures on Workbench that allow you to start a program,
select a document or examine the contents of a disk. These icons can also
have a second picture which is displayed when the icon is selected giving
the appearance of motion etc.
Icons can also pass information to the tool called through the use of
"Tool Types". IE will also allow you to edit these and more.
There are five different types of icons representing the different types
of files on the Amiga:
DISK ICON - To represent disks or harddrive partitions. (NOTE: A disk
icon will only be displayed when it is named "disk.info" and is in the
top directory of a disk or HardDrive partition).
DRAWER ICON - To represent a drawer (directory) on a disk.
GARBAGE ICON - To represent the special drawer known as the Trashcan.
TOOL ICON - To represent an executable program.
PROJECT ICON - To represent a document, drawing, picture etc that is
passed to the tool for being edited.
STARTING IE
The simplest method of starting IE is by double-clicking on the IE icon
from Workbench. This will start IE ready to create an icon.
Another method of starting IE from Workbench is to single-click on a
project icon, hold down the "shift" key and double-click on the IE icon.
This will start IE and automatically load the project icon for editing.
IE can also be started from the CLI by typing "IE" optionally followed
by the name of the icon to load. This icon can be of any type and the
".info" suffix needed not be included in the name.
NOTE: The WINDOW tooltype on the IE icon is required to run IE from
WorkBench under DOS1.2. On later versions of DOS this tooltype can be
removed safely.
THE ICON DISPLAY WINDOW
On the main IE window there is a large square region on the left hand
side. In this window the icon being edited is displayed 8 times normal
size.
To see different parts of the icon simply click, or slide, the
horizontal and vertical scroll bars next to the display window. This allows
you to move quickly around the full 640x200 image. Alternatively you can
click on the four arrow gadgets next to the scroll bars to shift the display
one pixel at a time in the direction of the arrow.
The "H" gadget in the top-right corner of the display window returns the
horizontal and vertical scroll bars quickly to the "Home" position (that is,
with the top-left corner of the icon being displayed).
Underneath the display window are the current coordinates of the pointer
within the icon (up to 640,200) and the name of the icon currently being
edited.
SELECTING THE NUMBER OF BITPLANES
Down the right hand side of the main IE window are the 16 colour
gadgets. Some of these will probably be disabled due to the number of
bitplanes in use. To change the number of bitplanes in use, select 1 of the
4 bitplane gadgets next to these colour gadgets. The colour gadgets will
enable/disable according to how many bitplanes you select.
For those who don't understand bitplanes the following table may help.
#Planes #Colours Available
----------------------------------------------
1 2
2 4 (Standard Workbench configuration)
3 8
4 16
The number of colours that can be used in an image on the Amiga is
determined by how many bitplanes are used (the more bitplanes - the more
colours).
Workbench versions up to 1.3 are standard 2 bitplanes giving 4 colours.
This may be increased by programs from the public domain.
Workbench 2.0 can be configured to use up to 4 bitplanes giving 16
colours.
IE will automatically select the number of bitplanes for you, from the
Workbench screen, so you would normally leave it up to IE to choose. You
can however change it manually if you wish.
Using less bitplanes (and hence less colours) will mean the icons will
use less disk space as less data is needed to create the icon. Using more
bitplanes (and hence more colours) will mean the icons will use more disk
space as more data is required to create the icon.
Using icons with more bitplanes than the Workbench configuration will
cause unpredictable results. Workbench will "cut down" the icon bitplanes
and the image may not be displayed correctly.
SELECTING A DRAWING COLOUR
To select a colour to draw in, click on one of the 16 colour gadgets
down the right-hand side of the main IE window. The brush pointer's tip
will change to the selected colour to remind which colour you are using.
CHANGING THE ICON'S IMAGE
To change the colour of a pixel in the icon's image simply position the
pointer in the display window over the pixel you want to change and click
the left mouse button. The pixel will then change to the currently selected
colour as denoted by the pointer's brush tip.
By holding down the left mouse button and moving the pointer within the
display window the pointer will continuously draw into the bitmap changing
the pixels moved over into the currently selected colour.
SELECTING WHICH ICON IMAGE TO EDIT/DISPLAY
Icons can be made of one or two images. The first image is the image
displayed on the Workbench screen before any selection is made and is called
the "Non-Select Image". The second (optional) image is displayed when the
icon is selected and is called the "Select Image".
To the right of the Home gadget is the Image Select gadget that looks
like a pair of disks with numbers in them. This gadget allows you to select
which image you are displaying/editing. Click on this gadget to switch
between the two images.
The disk containing the 1 represents the Non-Select Image and the disk
containing the 2 represents the Select Image. The half of the gadget with
the highlighted background shows which image is the current one.
THE UNDO EDIT GADGET
Just underneath the Select Image gadget is the Undo Edit gadget. As the
name suggests, this gadget will "undo" the last editing operation. This
enables you to reverse the effects where the edit you performed was
incorrect (e.g. If your Flood-Fill leaked and destroyed your image, then
click on the Undo Edit gadget and the image will be restored to before the
Flood-Fill).
The Undo Edit gadget will only undo the changes of the LAST edit and not
previous ones. Certain operations likewise will not be able to be undone
and the gadget will be disabled to inform you of this fact.
THE COPY IMAGE GADGET
This gadget will enable you to copy the Non-Select to the Select image
or vice versa. This gadget will also enable you to swap the images around.
A requester will be displayed for you to choose your options.
THE FLOOD FILL GADGET
This gadget will turn on or off when selected. When the gadget is on,
a click within the display window will initiate a "flood" paint instead of
changing the selected pixel's colour.
The pixel under the pointer is changed to the currently selected colour
and this continues for all pixels of the same colour "connected" to the
selected one. Only horizontal and vertical "connections" are checked for
flood fill, diagonals are ignored. This can be used to quickly fill in an
area instead of painting all of it by hand.
Remember that the Undo-Edit gadget will restore your image if the flood
fill "leaks" and destroys your image but it must be done straight away.
THE WRITE TEXT GADGET
This gadget also turns on or off when selected. When the gadget is on,
a click within the display window will initiate a text write instead of
changing the selected pixel's colour. The text will be written in the
currently selected colour as denoted by the pointer's brush tip.
A requester is displayed asking for the text to write into the image.
The string gadget is automatically activated for you so you can just start
typing and press the return key when finished.
If you wish to use a different font than the default (Topaz/8) then you
can click on the Select Font gadget which will then bring up a Font
Requester. This requester allows you to scroll through the list of
available fonts, select one and apply any combination of the style changes
bold, italic and underline. The highlighted font name represents the
current font. A sample text in the selected font and styles can be seen in
the requester to enable you to make your decision before leaving the
requester. The selected font and style then becomes the default for further
text writes.
THE MOVE IMAGE ARROW GADGETS
These gadgets move the whole icon image in the direction of the gadget.
These are not to be confused with the arrow gadgets next to the scroll bars
as those gadgets are only for fine-tuning the scroll bars.
These gadgets are most useful when you wish to create extra room on top
of, or to the left of, your image in order to do more drawing. They can
also be used to eliminate "blank" space to the left of your image.
IE will automatically strip the image to the smallest possible size when
saving the icon so it may be faster to save the icon temporarily and reload
it and only use these gadgets to remove the "blank" space that IE could not
remove automatically.
The "PROJECT/NEW" menu item (Right-Amiga N)
This menu item resets IE to it's defaults for creating a new icon. It
clears the data in both images and resets the InfoEdit window parameters.
The "PROJECT/LOAD" menu item (Right-Amiga L)
This menu item will display the file requester to allow you to select
which icon you wish to load. See the section on the File Requester for
details.
The "PROJECT/SAVE" menu item (Right-Amiga S)
This menu item will save the current icon, or if you haven't selected
an icon name it will display the file requester for you to select one. See
the section on the File Requester for details.
IE will automatically strip the imagery you designed for the icon to the
smallest possible size, eliminating as much "blank" space as possible,
before saving.
The "PROJECT/SAVE AS" menu item
This menu item will display the file requester to allow you to select a
different name to save the icon under. See the section on the File
Requester for details.
The "PROJECT/SAVE & QUIT" menu item (Right-Amiga F)
This menu item will save the current icon, or if you haven't selected
an icon name it will display the file requester for you to select one. See
the section on the File Requester for details.
After saving the icon IE will then automatically quit. It is a shortcut
to using the Right-Amiga S and Right-Amiga Q menu items.
The "PROJECT/ABOUT" menu item (Right-Amiga A)
This menu item will display information about the program and show you
where you can contact the author. Press the "OK" gadget when finished
reading each requester.
The "PROJECT/QUIT" menu item (Right-Amiga Q)
This menu item allows you to quit IE (what else?).
The "ICON/PREVIEW" menu item (Right-Amiga P)
This menu item displays the icon preview window. This window displays
the icon image exactly as it will be displayed on Workbench. Clicking the
Left mouse button in this window will toggle the display from the Non-
Select to the Select Image and vice versa. NOTE - The preview window will
only display alternate renders, the Complement and Backfill select options
are NOT displayed in the preview window.
The preview window is updated with every change you make to the image.
If you resize the Preview window and move it to an area of the screen that
you won't be needing, you can immediately see the effect of any changes you
make to the image in realtime. Although this can drastically slow down the
continuous drawing function it can be very useful for checking that the
changes you are making look correct.
If the Preview window is left active and you perform other functions
that cause a requester to be displayed, that requester may be covered by the
Preview window. You may have to resize and/or move the Preview window to
get access to the requester.
The "ICON/EDIT INFO" menu item (Right-Amiga E)
This menu item displays the icon information editing window. This
window allows you to change the various "non-graphical" options of icons.
These are summarised below:
ICON TYPE - Simply select the gadget corresponding to type of icon you
wish to create (DISK, DRAWER, TOOL, PROJECT, GARBAGE).
HIGHLIGHTING - Select which type of highlighting the icon should have
when it is selected from Workbench. COMPLEMENT is to reverse all the
icon colours within it's select box. BACKFILL is to reverse all the
icon colours but only in the image not the background. ALT RENDER is
to use the second image (Select Image).
HORIZONTAL POSITION - Select the FIND BEST gadget if you wish Workbench
to automatically try to find a place to fit the icon in. If the FIND
BEST gadget is turned off then the number in the string gadget specifies
the exact horizontal placement of the icon.
VERTICAL POSITION - Select the FIND BEST gadget if you wish Workbench
to automatically try to find a place to fit the icon in. If the FIND
BEST gadget is turned off then the number in the string gadget specifies
the exact vertical placement of the icon.
DEFAULT TOOL - Type the name of the tool (executable program) which this
icon is associated with. The effect of double clicking on this icon
will be the tool is started and the file associated with this icon will
be passed to the tool. The file associated with this icon will only be
passed to the tool if the tool is set up to receive parameters from
Workbench otherwise the tool will start as if you selected it directly.
This gadget will only work with DISK or PROJECT icons. DISK icons
should specify a disk copy program for their default tool.
TOOL TYPES - Up to 40 tool types can be specified in this area with the
scrolling controlled by the scroll bar and arrow gadgets. Tool Types
are parameters which are passed to the tool such as "PRINTER=LPT". The
tool must be written to accept Tool Types and the tool documentation
should be able to inform you of the format to use.
OPENED WINDOW - This enables you to specify the position and size of
the window which is displayed when the DISK, DRAWER or GARBAGE icon is
selected. It also enables you to select what colours the opened window
will be displayed in if you are running under DOS1.3. The colour of the
opened window relies upon an undocumented "feature" of DOS1.3 and is
ignored by DOS2.0. Simply click on the colour gadget and it will cycle
through the available colours.
STACK SIZE - This enables you to specify the stack size for the tool
which is started by the TOOL or PROJECT icon. A stack size of 0 means
to use the default stack size (around 4000 bytes), otherwise the stack
size you specify will be used.
NAME OFFSET - This enables you to specify a +/- value with which to
offset the vertical positioning of the icon name. By specifying a
positive value the name is moved downwards. The more usual use is to
specify a negative value which moves the name upwards. This can be
used to centre the icon name within the image of the icon. NOTE that
if the name is moved into the icon image only the image portion ABOVE
the name can be selected with the mouse.
If any of these parameters are changed, and you are using DOS1.3, then
you must reload the icon to make the changes take effect. If you were
editing a DISK icon you must remove the disk and then reinsert it. To
reload an icon of the other types you must close the window containing the
icon and reopen the window.
DOS2.0 has the ability to detect when an icon has been changed and the
icons usually do not have to be reloaded for the change to take effect.
The only exception is that when the Opened Window parameters are changed
the icon has to be reloaded as above.
The "ICON/RECOLOUR" menu item (Right-Amiga R)
This menu item will cause the pixels in colours 1 and 2 (usually black
and white) to be reversed in both icon images. This is a shortcut to using
the "ICON/SWAP COLOURS" menu item for each image and is provided especially
for changing icons for DOS2.0 usage as DOS2.0 has the colours 1 and 2
reversed.
The "ICON/SWAP COLOURS" menu item (Right-Amiga W)
This menu item will display a requester where you can choose two
colours to be reversed in the CURRENT image being edited (e.g. you can swap
black with white).
The "MISCELLANEOUS/OUTPUT C CODE" menu item (Right-Amiga C)
This menu item will display the file requester to allow you to select
a filename to write the C language code for the icon. See the section on
the File Requester for details. One use of this is for your programs to
generate their own icons.
The following code example shows how to write an icon file. This
assumes you generated the C Code to a file called "c-code" and are
generating the icon "test.info":
#include <exec/types.h>
#include <intuition/intuition.h>
#include <workbench/workbench.h>
#include <functions.h>
#include "c-code"; /*ALTERNATIVELY COPY THE CODE HERE FIRST*/
extern struct IconBase *IconBase;
void main()
{
IconBase = (struct IconBase *) OpenLibrary("icon.library", 0);
PutDiskObject("test", &Icon);
CloseLibrary(IconBase);
exit();
}
Another use for the generated C code is for creating gadgets for your
programs. You can create the gadget image using IE, or load in an IFF
image into IE, and write the C code to a file. The image data and image
structure generated can then be copied into your program as the data for the
gadget. All of IE's gadgets were drawn in IE and the generated code used
in IE's own source code.
The "MISCELLANEOUS/IMPORT IFF" menu item (Right-Amiga I)
This menu item displays the file requester to allow you to choose an
IFF picture file to load into the CURRENT image being edited. This allows
you to use pictures (generated by packages such as DPaint) in your icon
images.
The "MISCELLANEOUS/EXPORT IFF" menu item (Right-Amiga X)
This menu item displays the file requester to allow you to choose the
name of the IFF picture to be created from the CURRENT image being edited.
This allows you to export your image to packages with more sophisicated
editing features (such as DPaint) to edit your image and then later import
the edited image back into your icon image.
I purposely avoided writing more complex drawing tools such as boxes,
circles, lines, sprays and different size pens. Everyone usually has access
to a painting package which are designed specifically for IMAGE editing
where IE is meant to be an ICON editor. The extra functions would mean
larger code size than is necessary. Instead the IFF import and export menu
items allow users to access the more complex functions in programs
specifically designed for that job.
The "MISCELLANEOUS/IMPORT FROM ICON" menu items
These menu items allow you to grab images directly from other icons.
"NON-SELECT IMAGE" (Right-Amiga 1) allows you to load the Non-Select
image of an icon into the CURRENT image being edited.
"SELECT IMAGE" (Right-Amiga 2) allows you to load the Select image of
an icon (if there is one) into the CURRENT image being edited.
"BOTH IMAGES" (Right-Amiga 3) is a shortcut that allows you to load
both images from an icon into the icon you are currently editing.
FILE REQUESTER
This requester displayed periodically by IE is used when a filename
and drawer are needed for various read/write activities. The parts of the
file requester are detailed below:
DRAWER STRING GADGET - This gadget is to display the current drawer of
which the file requester is displaying the names of files in. You may
type a new drawer name in here and press return to quickly move to
another drawer.
FILENAME GADGETS - There are 8 of these gadgets and these display the
names of the files in the current drawer. The highlighted gadgets
represent drawers and the rest are ordinary files. To select a new
drawer to examine just click on the gadget with the left mouse button.
Selecting a filename by clicking the left mouse button will copy the
filename into the filename string gadget. Selecting the gadget again
will act like the OK gadget has been pressed.
FILENAME GADGET SCROLL BAR - As only 8 filenames can be displayed at a
time this gadget is used to scroll through the list of files. The
scroll bar can be selected and dragged with the left mouse button to
dynamically scroll through the list.
FILENAME STRING GADGET - This gadget displays what the current file is.
You may type a filename directly in here to quickly select a file or to
specify the name of a new file. This gadget is always active and at
any time you can just start typing in the filename and press return
when finished.
OK GADGET - If the filename string gadget has a filename in it then the
OK gadget will end the file requester and pass the current drawer name
and filename to IE.
PARENT GADGET - This gadget will change the current drawer to it's
parent drawer (that is, the drawer that contains the current drawer).
Selecting this gadget when at the top most drawer of a disk will have
no effect.
VOLUMES GADGET - This gadget will clear the drawer string gadget and
will cause the file requester to display the list of volumes instead of
files. The highlighted gadgets then represent disks or harddrive
partitions available. The non-highlighted gadgets represent logical
volumes created by the use of "assign" statements. Selecting one of
these gadgets will set the current drawer to the assigned logical volume
or disk.
CANCEL GADGET - This gadget will end the file requester and send a
cancel message back to IE.
The file requester is asynchronous which means you do not have to wait
for it to finish reading the filenames from disk before selecting gadgets.
This makes it slower than in previous versions but for floppy users (or
harddrive users with lots of files in one drawer) you can skip the un-
necessary step of reading all the files when you just want to change drawers
or give a filename that you already know.
IE'S AUTOSAVE FUNCTION
To try to prevent you from losing your work (from power loss, guru, etc)
IE will automatically save your icon into the file "IE.AutoSave.info" five
minutes after a change has been made to an unsaved icon. This file will be
automatically deleted if IE is exited with the "PROJECT/QUIT" or
"PROJECT/SAVE & QUIT" menu items.
If IE finds the autosave file present when it starts it will ask if you
want to reload the icon from the autosave file restoring your work.
NOTE that the DEMONSTRATION version will automatically exit after an
autosave.
PROJECT ICON HINT
If you have some icons that you use regularly then you can create a
"library" of icons by saving them in a drawer as PROJECT icons. Then by
clicking on an icon, holding down the shift key and double-clicking on the
IE icon you can start IE and IE will automatically load the icon. You can
then change the icon type, and other characteristics, and use the
"PROJECT/SAVE AS" menu item to save the icon in the desired place and name.
A better method than click, shift, double-click is to change the PROJECT
icon's default tool string to be the full path and name of IE. Then you
just have to double-click on the desired icon and IE will start and
automatically load the icon as above.
REMEMBER
If you change an icon's characteristics and save it under DOS1.3 then
the icon HAS to be reloaded for those changes to take effect. If the icon
was a disk icon then close all windows from the disk, eject the disk and
reinsert the disk. If the icon is of the other types then close the window
containing the icon and reopen the window.
Under DOS2.0 you do not have to reload the icon except when changing the
Opened Window characteristics.
Also under DOS2.0 the Opened Window colours will NOT work. This relied
upon an undocumented "feature" of DOS1.3.
A FINAL WORD FROM THE AUTHOR
I designed IE to be as simple to use as possible but still possess all
the features required for the construction of icons. The Amiga has a far
better icon system than ANY of the other machines available and I hope you
use IE to utilise the Amiga's icon system to it's fullest. If I can be of
any help in your usage of IE or icons then drop me a line.
If you can think of extra functions that might be of benefit in IE or
some ways IE's interface can be enhanced then please contact me and I will
seriously consider your suggestions. The best thing about ShareWare
programs are that YOU can make input to them which might make your life,
and somebody elses, a little easier.
If you like IE, or even hate it, please contact me as well as I like to
hear what others think about my efforts.
I hope that this program is of use to you and if you like it give it to
all of your friends. Best wishes and happy Iconing...