|  | Home · All Classes · Modules

# QIcon Class Reference
[QtGui module]

The QIcon class provides scalable icons in different modes and states. More...

### Types

- enum Mode { Normal, Disabled, Active, Selected }
- enum State { On, Off }

### Methods

- __init__ (self)
- __init__ (self, QPixmap pixmap)
- __init__ (self, QIcon other)
- __init__ (self, QString fileName)
- __init__ (self, QIconEngine engine)
- __init__ (self, QIconEngineV2 engine)
- __init__ (self, QVariant variant)
- QSize actualSize (self, QSize size, Mode mode = QIcon.Normal, State state = QIcon.Off)
- addFile (self, QString fileName, QSize size = QSize(), Mode mode = QIcon.Normal, State state = QIcon.Off)
- addPixmap (self, QPixmap pixmap, Mode mode = QIcon.Normal, State state = QIcon.Off)
- unknown-type availableSizes (self, Mode mode = QIcon.Normal, State state = QIcon.Off)
- int cacheKey (self)
- bool isDetached (self)
- bool isNull (self)
- QString name (self)
- paint (self, QPainter painter, QRect rect, Qt.Alignment alignment = Qt.AlignCenter, Mode mode = QIcon.Normal, State state = QIcon.Off)
- paint (self, QPainter painter, int x, int y, int w, int h, Qt.Alignment alignment = Qt.AlignCenter, Mode mode = QIcon.Normal, State state = QIcon.Off)
- QPixmap pixmap (self, QSize size, Mode mode = QIcon.Normal, State state = QIcon.Off)
- QPixmap pixmap (self, int w, int h, Mode mode = QIcon.Normal, State state = QIcon.Off)
- QPixmap pixmap (self, int extent, Mode mode = QIcon.Normal, State state = QIcon.Off)
- int serialNumber (self)
- swap (self, QIcon other)

### Static Methods

- QIcon fromTheme (QString name, QIcon fallback = QIcon())
- bool hasThemeIcon (QString name)
- setThemeName (QString path)
- setThemeSearchPaths (QStringList searchpath)
- QString themeName ()
- QStringList themeSearchPaths ()

## Detailed Description

The QIcon class provides scalable icons in different modes and states.

A QIcon can generate smaller, larger, active, and disabled pixmaps from the set of pixmaps it is given. Such pixmaps are used by Qt widgets to show an icon representing a particular action.

The simplest use of QIcon is to create one from a QPixmap file or resource, and then use it, allowing Qt to work out all the required icon styles and sizes. For example:

     QToolButton *button = new QToolButton;
     button->setIcon(QIcon("open.xpm"));

To undo a QIcon, simply set a null icon in its place:

     button->setIcon(QIcon());

Use the QImageReader.supportedImageFormats() and QImageWriter.supportedImageFormats() functions to retrieve a complete list of the supported file formats.

When you retrieve a pixmap using pixmap(QSize, Mode, State), and no pixmap for this given size, mode and state has been added with addFile() or addPixmap(), then QIcon will generate one on the fly. This pixmap generation happens in a QIconEngineV2. The default engine scales pixmaps down if required, but never up, and it uses the current style to calculate a disabled appearance. By using custom icon engines, you can customize every aspect of generated icons. With QIconEnginePluginV2 it is possible to register different icon engines for different file suffixes, making it possible for third parties to provide additional icon engines to those included with Qt.

Note: Since Qt 4.2, an icon engine that supports SVG is included.

### Making Classes that Use QIcon

If you write your own widgets that have an option to set a small pixmap, consider allowing a QIcon to be set for that pixmap. The Qt class QToolButton is an example of such a widget.

Provide a method to set a QIcon, and when you draw the icon, choose whichever pixmap is appropriate for the current state of your widget. For example:

     void MyWidget.drawIcon(QPainter *painter, QPoint pos)
     {
         QPixmap pixmap = icon.pixmap(QSize(22, 22),
                                        isEnabled() ? QIcon.Normal
                                                    : QIcon.Disabled,
                                        isChecked() ? QIcon.On
                                                    : QIcon.Off);
         painter->drawPixmap(pos, pixmap);
     }

You might also make use of the `Active` mode, perhaps making your widget `Active` when the mouse is over the widget (see QWidget.enterEvent()), while the mouse is pressed pending the release that will activate the function, or when it is the currently selected item. If the widget can be toggled, the "On" mode might be used to draw a different icon.

## Type Documentation

### QIcon.Mode

This enum type describes the mode for which a pixmap is intended to be used. The currently defined modes are:

Constant | Value | Description
--- | --- | ---
`QIcon.Normal` | `0` | Display the pixmap when the user is not interacting with the icon, but the functionality represented by the icon is available.
`QIcon.Disabled` | `1` | Display the pixmap when the functionality represented by the icon is not available.
`QIcon.Active` | `2` | Display the pixmap when the functionality represented by the icon is available and the user is interacting with the icon, for example, moving the mouse over it or clicking it.
`QIcon.Selected` | `3` | Display the pixmap when the item represented by the icon is selected.

### QIcon.State

This enum describes the state for which a pixmap is intended to be used. The state can be:

Constant | Value | Description
--- | --- | ---
`QIcon.Off` | `1` | Display the pixmap when the widget is in an "off" state
`QIcon.On` | `0` | Display the pixmap when the widget is in an "on" state

## Method Documentation

### QIcon.__init__ (self)

Constructs a null icon.

### QIcon.__init__ (self, QPixmap pixmap)

Constructs an icon from a pixmap.

### QIcon.__init__ (self, QIcon other)

Constructs a copy of other. This is very fast.

### QIcon.__init__ (self, QString fileName)

Constructs an icon from the file with the given fileName. The file will be loaded on demand.

If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.

The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.

Use the QImageReader.supportedImageFormats() and QImageWriter.supportedImageFormats() functions to retrieve a complete list of the supported file formats.

### QIcon.__init__ (self, QIconEngine engine)

The engine argument has it's ownership transferred to Qt.

Creates an icon with a specific icon engine. The icon takes ownership of the engine.

### QIcon.__init__ (self, QIconEngineV2 engine)

The engine argument has it's ownership transferred to Qt.

Creates an icon with a specific icon engine. The icon takes ownership of the engine.

### QIcon.__init__ (self, QVariant variant)

### QSize QIcon.actualSize (self, QSize size, Mode mode = QIcon.Normal, State state = QIcon.Off)

Returns the actual size of the icon for the requested size, mode, and state. The result might be smaller than requested, but never larger.

See also pixmap() and paint().

### QIcon.addFile (self, QString fileName, QSize size = QSize(), Mode mode = QIcon.Normal, State state = QIcon.Off)

Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state. The file will be loaded on demand. Note: custom icon engines are free to ignore additionally added pixmaps.

If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.

The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.

Use the QImageReader.supportedImageFormats() and QImageWriter.supportedImageFormats() functions to retrieve a complete list of the supported file formats.

Note: When you add a non-empty filename to a QIcon, the icon becomes non-null, even if the file doesn't exist or points to a corrupt file.

See also addPixmap().

### QIcon.addPixmap (self, QPixmap pixmap, Mode mode = QIcon.Normal, State state = QIcon.Off)

Adds pixmap to the icon, as a specialization for mode and state.

Custom icon engines are free to ignore additionally added pixmaps.

See also addFile().

### unknown-type QIcon.availableSizes (self, Mode mode = QIcon.Normal, State state = QIcon.Off)

Returns a list of available icon sizes for the specified mode and state.

This function was introduced in Qt 4.5.

### int QIcon.cacheKey (self)

Returns a number that identifies the contents of this QIcon object. Distinct QIcon objects can have the same key if they refer to the same contents.

The cacheKey() will change when the icon is altered via addPixmap() or addFile().

Cache keys are mostly useful in conjunction with caching.

This function was introduced in Qt 4.3.

See also QPixmap.cacheKey().

### QIcon QIcon.fromTheme (QString name, QIcon fallback = QIcon())

Returns the QIcon corresponding to name in the current icon theme. If no such icon is found in the current theme fallback is returned instead.

The latest version of the freedesktop icon specification and naming specification can be obtained here:

- http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
- http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html

To fetch an icon from the current icon theme:

         QIcon undoicon = QIcon.fromTheme("edit-undo");

Or if you want to provide a guaranteed fallback for platforms that do not support theme icons, you can use the second argument:

         QIcon undoicon = QIcon.fromTheme("edit-undo", QIcon(":/undo.png"));

Note: By default, only X11 will support themed icons. In order to use themed icons on Mac and Windows, you will have to bundle a compliant theme in one of your themeSearchPaths() and set the appropriate themeName().

This function was introduced in Qt 4.6.

See also themeName(), setThemeName(), and themeSearchPaths().

### bool QIcon.hasThemeIcon (QString name)

Returns true if there is an icon available for name in the current icon theme, otherwise returns false.

This function was introduced in Qt 4.6.

See also themeSearchPaths(), fromTheme(), and setThemeName().

### bool QIcon.isDetached (self)

### bool QIcon.isNull (self)

Returns true if the icon is empty; otherwise returns false.

An icon is empty if it has neither a pixmap nor a filename.

Note: Even a non-null icon might not be able to create valid pixmaps, eg. if the file does not exist or cannot be read.

### QString QIcon.name (self)

Returns the name used to create the icon, if available.

Depending on the way the icon was created, it may have an associated name. This is the case for icons created with fromTheme() or icons using a QIconEngine which supports the QIconEngineV2.IconNameHook.

This function was introduced in Qt 4.7.

See also fromTheme() and QIconEngine.

### QIcon.paint (self, QPainter painter, QRect rect, Qt.Alignment alignment = Qt.AlignCenter, Mode mode = QIcon.Normal, State state = QIcon.Off)

Uses the painter to paint the icon with specified alignment, required mode, and state into the rectangle rect.

See also actualSize() and pixmap().

### QIcon.paint (self, QPainter painter, int x, int y, int w, int h, Qt.Alignment alignment = Qt.AlignCenter, Mode mode = QIcon.Normal, State state = QIcon.Off)

This is an overloaded function.

Paints the icon into the rectangle QRect(x, y, w, h).

### QPixmap QIcon.pixmap (self, QSize size, Mode mode = QIcon.Normal, State state = QIcon.Off)

Returns a pixmap with the requested size, mode, and state, generating one if necessary. The pixmap might be smaller than requested, but never larger.

See also setPixmap(), actualSize(), and paint().

### QPixmap QIcon.pixmap (self, int w, int h, Mode mode = QIcon.Normal, State state = QIcon.Off)

### QPixmap QIcon.pixmap (self, int extent, Mode mode = QIcon.Normal, State state = QIcon.Off)

### int QIcon.serialNumber (self)

### QIcon.setThemeName (QString path)

Sets the current icon theme to name.

The name should correspond to a directory name in the themeSearchPath() containing an index.theme file describing it's contents.

This function was introduced in Qt 4.6.

See also themeSearchPaths() and themeName().

### QIcon.setThemeSearchPaths (QStringList searchpath)

Sets the search paths for icon themes to paths.

This function was introduced in Qt 4.6.

See also themeSearchPaths(), fromTheme(), and setThemeName().

### QIcon.swap (self, QIcon other)

Swaps icon other with this icon. This operation is very fast and never fails.

This function was introduced in Qt 4.8.

### QString QIcon.themeName ()

Returns the name of the current icon theme.

On X11, the current icon theme depends on your desktop settings. On other platforms it is not set by default.

This function was introduced in Qt 4.6.

See also setThemeName(), themeSearchPaths(), fromTheme(), and hasThemeIcon().

### QStringList QIcon.themeSearchPaths ()

Returns the search paths for icon themes.

The default value will depend on the platform:

On X11, the search path will use the XDG_DATA_DIRS environment variable if available.

By default all platforms will have the resource directory `:\icons` as a fallback. You can use "rcc -project" to generate a resource file from your icon theme.

This function was introduced in Qt 4.6.

See also setThemeSearchPaths(), fromTheme(), and setThemeName().