Workspace 6.21.5
Public Member Functions | Public Attributes | List of all members
PackageExecutableItemData Class Reference

#include <Package/packageexecutableitem.h>

Inheritance diagram for PackageExecutableItemData:
[legend]

Public Member Functions

 PackageExecutableItemData ()
 
bool addToCMakePackScript (QStringList &cmakeScript) const override
 
PackageItemclone () const override
 
void ensureHasData ()
 
QList< ExecutableDetailsgetExecutables () const override
 
- Public Member Functions inherited from PackageItem
virtual bool addToCMakePackScript (QStringList &cmakeScript) const =0
 
PackageItemclone () const override=0
 
virtual QList< ApplicationIconDetailsgetApplicationIcons () const
 
virtual QList< EnvironmentVariableDetailsgetEnvironmentVariables () const
 
virtual QList< ExecutableDetailsgetExecutables () const
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()=default
 
virtual Clonableclone () const =0
 

Public Attributes

QList< StartMenuItemadditionalStartMenuItems_
 
QStringList categories_
 
CSIRO::DataExecution::TypedObject< bool > dataAddLaunchScript_
 
CSIRO::DataExecution::TypedObject< bool > dataAddToDesktopMenu_
 
CSIRO::DataExecution::TypedObject< QString > dataAppIcon_
 
CSIRO::DataExecution::TypedObject< QString > dataDescription_
 
CSIRO::DataExecution::TypedObject< QString > dataDestDir_
 
CSIRO::DataExecution::TypedObject< QString > dataDestFileName_
 
CSIRO::DataExecution::TypedObject< bool > dataGroupExecutePermission_
 
CSIRO::DataExecution::TypedObject< bool > dataGroupReadPermission_
 
CSIRO::DataExecution::TypedObject< bool > dataIncludeInPackage_
 
CSIRO::DataExecution::TypedObject< QString > dataNameInMenu_
 
CSIRO::DataExecution::TypedObject< QString > dataParameters_
 
CSIRO::DataExecution::TypedObject< bool > dataSetGID_
 
CSIRO::DataExecution::TypedObject< bool > dataSetUID_
 
CSIRO::DataExecution::TypedObject< QString > dataSourceDir_
 
CSIRO::DataExecution::TypedObject< QString > dataSourceExecutable_
 
CSIRO::DataExecution::TypedObject< QString > dataSubmenuPath_
 
CSIRO::DataExecution::TypedObject< bool > dataWorldExecutePermission_
 
CSIRO::DataExecution::TypedObject< bool > dataWorldReadPermission_
 
QStringList fileExtensions_
 

Detailed Description

\ Package a single executable item

Constructor & Destructor Documentation

◆ PackageExecutableItemData()

Member Function Documentation

◆ addToCMakePackScript()

bool addToCMakePackScript ( QStringList cmakeScript) const
overridevirtual
Parameters
cmakeScriptUpon entry, this will hold the contents of the CMake script that have been assembled so far. These contents would normally not be modified, but this is permitted if required. Normally, the subclass implementation would simply append to cmakeScript and in some circumstances, it may search for things in cmakeScript to customize entries that will be appended.
Returns
True upon success, or false if an error was encountered that results in the CMake script incomplete or invalid.

Implements PackageItem.

◆ clone()

PackageItem * clone ( ) const
inlineoverridevirtual
Returns
A clone of this object.
Note
Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

We redeclare this function only so that the more derived return type is available without casting.

Implements PackageItem.

◆ ensureHasData()

void ensureHasData ( )
inline

◆ getExecutables()

QList< PackageItem::ExecutableDetails > getExecutables ( ) const
overridevirtual
Returns
A list of ExecutableDetails objects describing the set of executables provided by this package item. Only those executables for which a desktop menu entry is required need to be present in this list. Executables used by the package internally do not need to be included in the list.

The default implementation returns an empty list.

Reimplemented from PackageItem.

Member Data Documentation

◆ additionalStartMenuItems_

QList<StartMenuItem> additionalStartMenuItems_

◆ categories_

QStringList categories_

◆ dataAddLaunchScript_

CSIRO::DataExecution::TypedObject<bool> dataAddLaunchScript_

◆ dataAddToDesktopMenu_

CSIRO::DataExecution::TypedObject<bool> dataAddToDesktopMenu_

◆ dataAppIcon_

CSIRO::DataExecution::TypedObject<QString> dataAppIcon_

◆ dataDescription_

CSIRO::DataExecution::TypedObject<QString> dataDescription_

◆ dataDestDir_

CSIRO::DataExecution::TypedObject<QString> dataDestDir_

◆ dataDestFileName_

CSIRO::DataExecution::TypedObject<QString> dataDestFileName_

◆ dataGroupExecutePermission_

CSIRO::DataExecution::TypedObject<bool> dataGroupExecutePermission_

◆ dataGroupReadPermission_

CSIRO::DataExecution::TypedObject<bool> dataGroupReadPermission_

◆ dataIncludeInPackage_

CSIRO::DataExecution::TypedObject<bool> dataIncludeInPackage_

◆ dataNameInMenu_

CSIRO::DataExecution::TypedObject<QString> dataNameInMenu_

◆ dataParameters_

CSIRO::DataExecution::TypedObject<QString> dataParameters_

◆ dataSetGID_

◆ dataSetUID_

◆ dataSourceDir_

CSIRO::DataExecution::TypedObject<QString> dataSourceDir_

◆ dataSourceExecutable_

CSIRO::DataExecution::TypedObject<QString> dataSourceExecutable_

◆ dataSubmenuPath_

CSIRO::DataExecution::TypedObject<QString> dataSubmenuPath_

◆ dataWorldExecutePermission_

CSIRO::DataExecution::TypedObject<bool> dataWorldExecutePermission_

◆ dataWorldReadPermission_

CSIRO::DataExecution::TypedObject<bool> dataWorldReadPermission_

◆ fileExtensions_

QStringList fileExtensions_