# The &kiconedit; Manual

Thomas
Tanghus

    tanghus@earthling.net

1997
Thomas Tanghus
2001
2003
Lauri Watts
&FDLNotice;
2003-11-06
3.1.93

&kiconedit; is designed to help create icons for &kde; using the standard icon palette.

KDE
kdegraphics
KIconEdit
icon

## Introduction

> Thomas Tanghus tanghus@earthling.net

> &kiconedit; is designed to help create icons for &kde; using the standard icon palette.

> I hope you will find this program somehow useful and I would appreciate any suggestions and comments.

## Onscreen Fundamentals

In this section will be briefly described the Icon Editor user interface.

The Icon Editor window is separated in four areas: main toolbar, tools toolbar, the grid and statusbar.

### Main toolbar

New File

  Create a new icon. If the current file has been modified you will be asked if you want to save the changes. After that a dialog will open where you can choose to create the icon from scratch or from a template.

Open...

  Open an existing icon file.

Save

  Save the currently open icon.

Print

  Print the icon.

Undo

  Undo the last action

Redo

  Redo the last action undone. If no actions have been undone, this action is disabled.

Cut

  Cuts out the entire icon and put it onto the clipboard.

Copy

  Copies the entire icon to the clipboard.

Paste

  Paste the contents of the clipboard as a new image (if the clipboard contains a valid icon).

Zoom factor
Zoom in
Zoom out

  Zoom to predefined zoom factor.

Resize

  Resize icon to width X height.

Gray scale

  Gray scale the icon image. This may create colors not conformant to the &kde; icon palette.

Show grid

  Toggle grid on/off.

What's This

  Clicking this icon, then clicking anywhere else in the window, will show a short tooltip describing the item you clicked on.

### Tools toolbar

This toolbar contains the tools you can use to manipulate the icon.

Freehand

  Draw free hand.

Color picker

  Doesn't change the icon but changes the current drawcolor to the color clicked on.

Rectangle

  Draw a rectangle.

Filled rectangle

  Draw a filled rectangle.

Circle

  Draw a circle.

Filled circle

  Draw a filled circle.

Ellipse

  Draw an ellipse

Filled ellipse

  Draw a filled ellipse (almost the same thing as drawing a circle.)

Spray

  Draws a randow dotted pattern like a spraycan.

Flood fill

  Fill an area with the current color.

Line

  Draw a line.

Eraser

  Draw transparent (invisible).

Rectangular Selection
Circular Selection

  Select (mark) a part of the icon.

### Grid

The grid is where you manipulate the icon contents.

### Statusbar

The status bar keeps you informed of current operations. From left to right, it tells you the x,y coordinates of the pixel you are working on, the size of the current canvas, the zoom factor, and the current number of colors in the icon.

## The Menu Entries

### File

The following functions are available from the File menu:

&Ctrl;N File New

  Lets you create a new icon, either from a template or by specifying the size.

File New Window

  Open a new Icon Editor window.

&Ctrl;O File Open...

  Open an existing icon file.

File Open Recent

  Displays a list of recently opened icons to choose from.

&Ctrl;S File Save

  Save the currently open icon.

File Save As...

  Save the currently open icon under a new name.

&Ctrl;P File Print...

  Print the icon

&Ctrl;W File Close

  Close &kiconedit;.

### Edit

The Edit menu contains the following entries:

&Ctrl;Z Edit Undo

  Undo the last action

&Ctrl;&Shift;Z Edit Redo

  Redo the last action undone. If no actions have been undone, this action is disabled.

&Ctrl;X Edit Cut

  Cuts out the entire icon and put it onto the clipboard.

&Ctrl;C Edit Copy

  Copies the entire icon to the clipboard.

&Ctrl;V Edit Paste

  Paste the contents of the clipboard (if the clipboard contains a valid icon).

Edit Paste as New

  Paste the contents of the clipboard as a new image (if the clipboard contains a valid icon).

Edit Clear

  Clear the grid and fill it with transparent color.

&Ctrl;A Edit Select all

  Marks the entire icon as selected.

Edit Resize...

  Resize icon to width X height.

Edit Grayscale

  Gray scale the icon image. This may create colors not conformant to the &kde; icon palette.

### View

&Ctrl;+ View Zoom in

  Magnify the view of the icon.

&Ctrl;- View Zoom out

  Shrink the view icon to a smaller screen size

View Zoom

  Zoom to a predefined zoom factor

### Tools

Tools Freehand

  Draw free hand.

Tools Color Picker

  Select a color from the screen to use as the foreground color.

Tools Rectangle

  Draw a rectangle.

Tools Filled Rectangle

  Draw a filled rectangle.

Tools Circle

  Draw a circle.

Tools Filled Circle

  Draw a filled circle.

Tools Ellipse

  Draw an ellipse

Tools Filled Ellipse

  Draw a filled ellipse (almost the same thing as drawing a circle.)

Tools Spray

  Draws a random dotted pattern like a spraycan.

Tools Flood fill

  Fill an area with the current color.

Tools Line

  Draw a line.

Tools Eraser (Transparent)

  Draw transparent (invisible).

Tools Rectangular Selection
Tools Circular Selection

  Select (mark) a part of the icon.

### Settings

Settings Toolbars

  Toggle on and off the display of the toolbars.

Settings Show Statusbar

  Toggle on and off the display of the status bar.

Settings Show Grid

  Toggle on and off the grid.

Settings Configure Shortcuts...

  Opens a dialog where you can customize &kiconedit;'s keyboard shortcuts.

Settings Configure KIconEdit...

  Opens the &kiconedit; configuration dialog, described separately.

### Help

&help.menu.documentation;

## Credits and Licenses

&kiconedit;

Program copyright Thomas Tanghus tanghus@kde.org

### Contributors

- John Califf jcaliff@compuzone.net

- Laurent Montel lmontel@mandrakesoft.com

- Aaron Seigo aseigo@olympusproject.org

- Nadeem Hassan nhasan@nadmm.com - Rewrote UI to use XMLGUI, Lots of fixes and cleanup

- Adrian Page Adrian.Page@tesco.net - Bug Fixes and GUI tidy up.

&underFDL; &underGPL;

## Installation

### How to obtain &kiconedit;

&install.intro.documentation;

### Compilation and Installation

&install.compile.documentation;