Home Page The Club Computers News Links Glossary EYAWTK
Before Amiga Background ICS OCS ECS AGA ??? PPC
U-Boot SLB Linux Amiga OS Dual Boot Motherboards Peripherals Other
Initialisation Installation OS4 Updates About OS4 File Systems Networking Printing Other
Introduction File System Workbench Preferences Commands Error Msgs Miscellaneous

AmigaOS 4.0 - About OS4 - Commands

ICONEDIT Utility
Purpose: To create or modify icon images.
Format: ICONEDIT [ALTDRAWER=<drawer for alternate images>] [CLIPDRAWER=<drawer of clips>] [CLIPUNIT=<clipboard unit number>] [HEIGHT=<height of window>] [HSB] [ICONDRAWER=<drawer for icons>] [ILBMDRAWER=<drawer for ILBMs>] [LEFTEDGE=<coordinate of window>] [NOGRID] [NOICONS] [NOOPTIMIZE] [PUBSCREEN=<public screen name>] [SHOWCLIP=<filename of clipboard content show program>] [TEMPLATE=<drawer for templates>] [TOPEDGE=<coordinate of window>] [WIDTH=<width of window>] [XMAG=<horizontal magnification factor>] [YMAG=<vertical magnification factor>]
Template: FROM, PUBSCREEN/K
Path: SYS:Utilities/IconEdit
ICONEDIT enables you to change the appearance of existing icons and create new ones.

IconEdit Tool Types
IconEdit supports the following Tool Types:

ALTDRAWER=<path> Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
CLIPDRAWER=<path> Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
CLIPUNIT=<n> Specifies the Clipboard unit to use. The default is 0.
HEIGHT=<n> Specifies the height of the editor window.
HSB Use the HSB color model for the color sliders.
ICONDRAWER=<path> Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
ILBMDRAWER=<path> Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
LEFTEDGE=<n> Specifies where to place the left edge of the editor window.
NOGRID Disables the use of the grid in the magnified view box.
NOICONS Disables the ability to create icons when saving support files, such as when saving a file as an IFF brush.
NOOPTIMIZE Disables optimizing the icon palette when saving icons.
PUBSCREEN Names the public screen on which IconEdit is supposed to open its window.
SHOWCLIP=<path> Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
TEMPLATE Path to the icons to be loaded when calling the 'Use Template' menu item.
TOPEDGE=<n> Specifies where to place the top edge of the editor window.
WIDTH=<n> Specifies the width of the editor window.
XMAG=<n> Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4..
YMAG=<n> Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.

Using IconEdit
When you open ICONEDIT the following window will appear:

There are several subwindows in the IconEdit display window. On the left-hand side there is the Magnified View Box, in the middle at the top are the Drawing Tools and below them are the Normal and Selected view boxes, and on the right-hand side are the Colour Selection tools.

Magnified View Box
This is where you manipulate the icon image using the various drawing tools that are available.

At the top right-hand corner of the box are two gadgets to 'zoom in' (+) and 'zoom out' (-) for easier editing. By default the image is displayed with an editing grid, but this can be turned off if desired from the Settings Menu.

To load an existing icon, you can use Open from the Project Menu, or because the Magnified View Box is an AppWindow, you can simply drag an icon to load it, rather than using menus.

Normal and Selected View Boxes
These show the Normal and Selected icons in normal size as they would appear on the Workbench window. The Normal and Selected radio buttons switch between unselected and selected images for an icon that appears in the Magnified View Box. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the Magnified View Box appears in the normal view box at the top of the window. When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

You can load an existing image into either or both of the windows using Load from the Images menu depending on the option selected, or because both the Normal and Selected view boxes are AppWindows, you can drag an icon to load it, rather than using menus.

Colour Selection Gadgets
The colour selection gadgets let you customise your drawing palette. At the top are 32 colour blocks that can be customised to your personal taste by clicking on the particular colour block, and the using a combination of colour wheel, the intensity slider and the RGB or HSB (selected from Settings menu) to configure the correct colour. Clicking on the 'Restore Colors' button will return all colours to their original setting.

The Transparent button can be used to set the background colour that you want to be transparent when diplayed on the Workbench. To set the colour, first click on the appropriate colour block, then click on the Transparent button. The default is for the top left hand colour block to be set. The selected colour shows in the center of the Transparent button. Clicking on the Transparent button when a colour has already been selected will unselect it.

Fill Pattern Gadgets
As well as colour selection, a number of fill patterns are available for use with the Filled Box Gadget, the Filled Circle Gadget and the Fill Gadget. They are not applicable to any of other gadgets even when selected. The default is solid colour as represented by the left most gadget.

Freehand Gadget
The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the Magnified View Box by holding done the left mouse button, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill the details in later.

Continuous Freehand Gadget
The Continuous Freehand gadget is similar to the Freehand gadget except that it produces a continuous line. If you select this gadget and then draw in the Magnified View Box by holding done the left mouse button, the pixels fill in as the mouse passes over them. Use this gadget to sketch an icon that you intend to fill the details in later.

Outlined Box Gadget
To draw a outlined box, select the Outlined Box gadget, then using the Magnified View Box, position the cursor at the point where you want a corner of the box, hold down the left mouse button and drag the box in any direction until it is the correct size and shape, before releasing the button.

Filled Box Gadget
To draw a filled box, select the Filled Box gadget, then using the Magnified View Box, position the cursor at the point where you want a corner of the box, hold down the left mouse button and drag the box in any direction until it is the correct size and shape, before releasing the button.

Outlined Circle Gadget
To draw a outlined circle or oval, select the Outlined Circle gadget, then using the Magnified View Box, position the cursor at the point where you want the center of the circle or oval, hold down the left mouse button and drag the circle or oval in any direction until it is the correct size and shape, before releasing the button.

Filled Circle Gadget
To draw a filled circle or oval, select the Filled Circle gadget, then using the Magnified View Box, position the cursor at the point where you want the center of the circle or oval, hold down the left mouse button and drag the circle or oval in any direction until it is the correct size and shape, before releasing the button.

Straight Line Gadget
To draw a straight line, select the Straight Line gadget, then using the Magnified View Box, position the cursor at the point where you want the line to begin, hold down the left mouse button and drag the line in any direction until it is in the correct position, before releasing the button.

Fill Gadget
The Fill gadget is used to fill an area of the Magnified View Box with the selected colour. Select the gadget, then click within the area you want to change which is determined by the colour of the pixel that you click on, such that all pixels of the same colour adjacent to it and all other similar pixels are also changed.

Undo Gadget
The Undo gadget can be used to cancel the last action performed in the Magnified View Box. The Undo gadget acts as a toggle switch and once used will become ghosted until another action is performed. You can only undo a single action.

Redo Gadget
The Redo gadget can be used to reapply the last action performed in the Magnified View Box after the Undo gadget has been used. The Redo gadget acts as a toggle switch and once used will become ghosted until another Undo is performed. You can only redo a single action.

Clear Gadget
The Clear gadget can be used to erase the entire contents of the Magnified View Box, which will be filled with the currently selected colour.

Dropper Gadget
The Dropper gadget can be used to select the current colour from a single pixel in the Magnified View Box. This can be very useful when you have several colours very similar and you need to select the correct one.

Arrows
The arrows let you shift your image within the frame. Clicking on an arrow moves the image in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon. Alternatively you can use the keyboard shortcuts by pressing the corresponding arrow keys.

NOTE: Any part of the image that is moved off the edge of the frame is lost, but if this is done accidentally it can be recovered using the Undo button.

Menu Commands
IconEdit has the following menus:
Project Lets you to open and save icon files.
Edit Lets you to use the Amiga`s Clipboard to import IFF ILBM clips.
Type Lets you specify the type of icon changed or created.
Highlight Lets you determine how an icon appears when it is selected.
Images Lets you manipulate the images and import IFF images.
Extras Lets you control additional convenience features of IconEdit.
Settings Lets you save various IconEdit options.

The following sections describe each of the menus in detail and show the keyboard shortcut key combinations for each menu item, e.g.  G which is interpreted as pressing the Right Amiga key and 'G' together.

Project Menu
The items in the Project menu let you open and save icon files.

New  N Loads the default icon for the currently chosen type of icon as 'Untitled'. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
Open  O Opens an existing icon file. A requester appears for selecting the name. Only the names of drawers and .info files appear in the IconEdit Open file requester.
Revert Enables you to revert back to a previously save icon file. Any changes in the window that have not been saved produce a requester asking if you want to save them. If no icon file has previously been saved or if an open file has not been modified, this menu item will remain ghosted out.
Save  S Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
Save As  A Allows you to specify a file name for saving the current image. A requester lets you enter destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
Save As Default Icon  D Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo icon of that type created, including those made with the New menu item of this menu.
Quit  Q Exits IconEdit. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.

Edit Menu
The items in the Edit menu allow you to use the Amiga's Clipboard to import IFF ILBM clips that were created with other programs.

Cut  X Deletes the image in the magnified view box and copies it to the Clipboard.
Copy  C Copies the image in the magnified view box to the Clipboard.
Paste  V Copies any image in the Clipboard to the magnified view box, replacing the current contents.
Erase Erases any image in the magnified view box. You can erase everything or save before erasing.
Undo  Z Has the same function as the corresponding gadget.
Redo Has the same function as the corresponding gadget.
Open Clip Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
Save Clip As Saves the current contents in the Clipboard to a specified file.
Show Clip Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.

Type Menu
The items in the Type menu let you specify the type of icon changed or created.

Disk  1 Represents the disk icons appearing in the Workbench window.
Drawer  2 Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
Tool  3 Represents a tool, such as the Calculator, Clock, or IconEdit program.
Project  4 Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
Garbage  5 Represents the Trashcan drawer.

Highlight Menu
The items in the Highlight menu let you determine how an icon appears when it is selected.

Complement  7 Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in 'old icon' mode.
Backfill  8 Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in 'old icon' mode.
Image  9 Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
Darken  0 With this option only a single image is required, and when selected, the icon`s colors will be darkened.

Images Menu
The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

Exchange  E Swaps the images that appear in the normal view and the selected view.
Copy The operation of Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
Use Template Loads a template icon into the Magnified View Box on which you can use as the foundation for creating a new icon.
Load Loads previously saved images, without changing the name of the icon being edited, as per the following sub-options:
  • Image  J Enables you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
  • Normal Image  Y Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
  • Selected Image  U Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
  • Both Images  I Loads both the normal and selected images of the specified icon into the appropriate view boxes.
Save Image  K Saves an image as a standard IFF ILBM brush, rather than an icon.
Restore  R Returns the IconEdit window to its state prior to opening the window or selecting New or Open.

Extras Menu
The items in the Extras Menu control additional convenience features of IconEdit.

Larger Sketchboard Increases the size of the Sketchboard in the Magnified View box by 50%.
Smaller Sketchboard Decreases the size of the Sketchboard in the Magnified View box by 50%.
Minimize Sketchboard Reduces the size of the Sketchboard in the Magnified View box to the minimum.
Auto TopLeft  T Moves the image to the upper left corner of the Magnified View box.
Add Glow Adds a glow effect around the icon image just like the standard OS4.0 icons have. This will not work properly if the image is too close to the edges of the Magnified View box.
Borderless If this menu item is selected, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.

Settings Menu
The items in the Settings Menu, enable you to set or save various IconEdit options.

Use Grid? Use Grid? displays each pixel in the Magnified View box distinctly, with the background colour surrounding it. When Use Grid? is not selected, the pixels blend together smoothly. The default is for the grid to be on.
Save Optimized Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
Create Icons? Create Icons? saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? is not selected, no icon is saved. The default is for icons to be saved.
Slider Color Model Configures the Slider Color Model, as per the following sub-options:
  • RGB Displays the Colour Selection sliders for Red, Green and Blue.
  • HSB Displays the Colour Selection sliders for Hue, Saturation and Brightness.
Save Settings Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.

Example:

3.OS4:> ICONEDIT Example loads the Example.info file from the current directory.


Return to Commands Selection

Disclaimer: Amiga Auckland have prepared the above information for the use of its members based on our experiences and as such is subject to revision at any time. Amiga Auckland cannot guarantee any of the information and cannot be held accountable for any issues that may result from using it.


Copyright 2006 Amiga Auckland Inc. All rights reserved.
Revised: December 24, 2006.