Qbs Manual

Qbs 1.16.0

# ico

Provides support for building ICO (.ico) and CUR (.cur) files. More...

Since: | Qbs 1.11

- List of all members, including inherited members

## Properties

- cursorHotspotX : int
- cursorHotspotY : int
- icotoolFilePath : string
- raw : bool

## Detailed Description

The `ico` module contains properties and rules for building Microsoft Windows Icon (.ico) and Microsoft Windows Cursor (.cur) files.

Note: This module relies on the `icotool` command-line tool from the `icotools` package, which must be installed separately and found in the `PATH` or an appropriate system binaries directory for your system (for example, `/usr/bin` or `/usr/local/bin`).

### Relevant File Tags

Tag | Auto-tagged File Names | Since | Description
--- | --- | --- | ---
`"cur"` | n/a | 1.11 | The rule that creates cursor (.cur) files attaches this tag to its output artifact.
`"ico"` | n/a | 1.11 | The rule that creates icon (.ico) files attaches this tag to its output artifact.
`"png"` | `"*.png"` | 1.11 | Source files with this tag indicate PNG files which are used as inputs to create icon or cursor files.

## Property Documentation

cursorHotspotX : int

The cursor hotspot x coordinate. Only relevant when building .cur files.

This property must be set individually for each input PNG file.

Note: `icoutils` version 0.32 or greater is required to set the hotspot in cursor files with multiple images.

Default: Undefined

cursorHotspotY : int

The cursor hotspot y coordinate. Only relevant when building .cur files.

This property must be set individually for each input PNG file.

Note: `icoutils` version 0.32 or greater is required to set the hotspot in cursor files with multiple images.

Default: Undefined

icotoolFilePath : string

The full path of the `icotool` binary.

This property should not normally need to be changed if Qbs was able to automatically detect it.

Default: Determined automatically.

raw : bool

Whether to store the input file as a raw PNG, as supported in Windows Vista.

Only relevant when building .ico files.

This property must be set individually for each input PNG file.

It is recommended to set this value only for icon sizes larger than or equal to 256x256.

Default: `false`