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

Data structure describing a single packaged executable. More...

#include <Package/packageitem.h>

Public Attributes

QString appIcon
 
QStringList associatedExtensions
 Associated file extensions.
 
QString commandArguments
 
QString description
 
QString desktopFile
 
QString executableToRun
 
QStringList freedesktopCategories
 
QString nameInDesktopMenu
 This will be the text shown in a desktop menu.
 
QString subMenuPath
 

Detailed Description

The entries in this class describe an executable that must be defined by a PackageItem subclass and added to the same package where the ExecutableDetails instance is used. These details will ultimately be used by CreateInstaller to provide a platform-specific menu entry and any other associated installable items needed to implement the menu entry. This class exists mostly for the benefit of PackageExecutableItem so that certain steps can be delayed until after the whole list of packaged items has been processed.

Member Data Documentation

◆ appIcon

QString appIcon

This should be the generic name of an icon, not a file name or path. See ApplicationIconDetails::symbolicName for more information.

◆ associatedExtensions

QStringList associatedExtensions

◆ commandArguments

QString commandArguments

List of arguments to add after the executable. If no executable has been specified, then the default application for opening the first command argument will be used. This is primarily used to create a desktop menu item that needs to run a command from outside of what the package itself provides, such as a web browser or image viewer.

◆ description

QString description

Used on some platforms to provide additional text or tool tips in desktop menus.

◆ desktopFile

QString desktopFile

If non-empty, this will be used as the contents of a .desktop file on platforms that support such files (typically linux systems) and all other entries in this data structure will be ignored.

◆ executableToRun

QString executableToRun

File name of the executable relative to the install prefix. This is what the target machine will be asked to run when this executable is launched. The packaging system will convert this to an absolute path at install time. If this is an empty string, it will be assumed that the default application for the first item in the commandArguments should be used. Note that this implies that commandArguments cannot be empty if executableToRun is empty.

◆ freedesktopCategories

QStringList freedesktopCategories

List of relevant categories for the application. The categories are more or less standardized and should be chosen from the list available at http://standards.freedesktop.org/menu-spec/1.1/apa.html

◆ nameInDesktopMenu

QString nameInDesktopMenu

◆ subMenuPath

QString subMenuPath

If non-empty, defines the sub-menu for the item. Use forward slashes to nest sub-sub-menus, etc.