Workspace 6.21.5
Public Attributes | List of all members
PackageItem::ApplicationIconDetails Struct Reference

Data structure describing a single packaged application icon. More...

#include <Package/packageitem.h>

Public Attributes

QString fileName
 File name of the icon relative to the install prefix.
 
int iconSize
 
QString iconTheme
 
QString symbolicName
 

Detailed Description

The entries in this class describe an icon that can be used in things like desktop menus or other system-wide situations. Not all icons used by a package need to have their own ApplicationIconDetails item, only those icons that are referred to by executables (typically as provided by a PackageExecutableItem operation).

Also note that different platforms require different icon formats for things like desktop integration. Linux needs PNG or XPM format, whereas Windows requires ICO. Mac OSX appears to be more flexible, handling all three of those formats. For best platform support, it is recommended that both PNG and ICO formats be supplied for each icon.

Member Data Documentation

◆ fileName

QString fileName

◆ iconSize

int iconSize

An indicator of the size of the icon. This is used to help the target system choose the best icon for a given situation where multiple IconDetails entries are provided with the same symbolic name. It is strongly encouraged that only one of the common sizes be used: 16, 22, 32, 48, 64 and 128. Icons are always assumed to be square. Note that some platforms installers don't support multi-size icons, in which case only one icon will be used (the size chosen will be determined via some internal algorithm).

◆ iconTheme

QString iconTheme

The desktop theme for this icon. If left blank, it will be assigned to the default theme. Unless you intend to provide icons for multiple themes for the same symbolic name, it is advisable to leave the theme blank.

◆ symbolicName

QString symbolicName

The symbolic name that can be used to refer to this icon. It is used in a package-wide way on the target system and is also the name that ExecutableDetails::appIcon would refer to. If this is left blank, it will be as though the file name part of fileName (ie without any path component) was used. Normally, the symbolic name would be the same as fileName with the path and file name extension removed, but this is not a requirement.