The app descriptor file must specify the app ID, build ID, version number, a Qt binary file for the entry point, and the physical size of the display area. The file can also define fields such as an icon image file, author name, app name and description, and more.
| Name | Required | Description | Attributes | Example |
|---|---|---|---|---|
| <arg> | No | Defines the arguments for configuring the application when started. The order of the arguments is important because they're presented in the application's command line in the same order listed in the app descriptor file. | <arg>-b -v</arg> | |
| <asset> | Yes |
Specifies an asset to package in the BAR file. For Qt apps, you must include an <asset> tag that names the Qt binary that's the app entry point. Any assets listed on the command line override those specified with this tag. The text of the tag is a path relative to the BAR package root directory. You can also use the dest attribute to specify the asset—this is recommended when using nested <exclude> and <include> elements. Unless otherwise noted, the attributes are optional. |
defaultexcludes When yes, apply the exclusion patterns to the directory tree. For the list of exclusion patterns, see the <asset> element in the application descriptor file DTD. dest The asset's destination path. Typically, the value is the last part of path (i.e., the filename). entry When true, use the asset to start the application. The default setting is false. path (Required) The location of the asset relative to the working directory of the packager. public When true, store the asset in the public directory of the BAR file, so it's readable to other applications. Icon assets should be public. The default setting is false. type The asset type. For Qt binaries, use Qnx/Elf. |
<asset type="Qnx/Elf" path="QtApp" entry="true">QtApp</asset> |
| <author> | No | Specifies the author name (typically the company or developer name). | <author>My Company Inc.</author> | |
| <buildId> | Yes, if not using <buildIdFile> | Specifies the build identifier, which is an integer between 0 and 65535. You modify the value when you want the identifier to change. | <buildId>1</buildId> | |
| <buildIdFile> | No |
Names the file that stores the build identifier. This file is located in your application root folder and it stores the build identifier as an integer. The packager tool increments this value each time you build the BAR package. If you use this element, don't include the <buildId> element. The default file created by the Momentics IDE is buildnum. |
<buildIdFile>buildnum</buildIdFile> | |
| <category> | No | Indicates the category to which the application belongs. | <category>media</category> | |
| <description> | No | Defines the text to display when the application is installed. You can use nested <text> elements to define text for different languages and locales. | <description>The Hello World Qt demo app.</description> | |
| <entryPointType> | Not if the entry point is defined in an <asset> tag; otherwise, yes. | Defines the entry point type, which can be either Qnx/Elf (for native applications, including Qt applications) or Qnx/WebKit (for applications based on HTML5 and Cordova). | <entryPointType>Qnx/WebKit</entryPointType> | |
| <env> | No | Defines environment variable settings. For Qt apps, we recommend defining the QQNX_PHYSICAL_SCREEN_SIZE variable, but you can define others as well, as explained in "Environment variables". |
var (Required) Name of the environment variable. value (Required) Value of the environment variable. |
<env var="QQNX_PHYSICAL_SCREEN_SIZE" value="150,90"/> |
| <icon> | No | Defines an icon for the app. The path of the icon file is defined in the nested <image> tag. If no file is specified, the app doesn't have any default icon but is represented by an empty spot in the viewing area showing the installed apps. | See the <image> element. | |
| <id> | Yes | Provides an identifier (50 characters or less) for your app. We recommend using a reverse DNS-style naming convention for the value. The value is the package name in the BAR file. | <id>com.mycompany.QtApp</id> | |
| <image> | No | Specifies the location of the icon image to use for the app. The value is the path to the image asset (PNG or JPG file) from the application root path. The recommended image size is 86 x 86 or 90 x 90 pixels. This element is nested within the <icon> element. |
<icon> <image>icon.png</image> </icon> |
|
| <name> | Yes | Defines the string value to display when the app is installed. This UTF-8 value can be at most 25 characters. | <name>Qt App</name> | |
| <permission> | No | Specifies the privileges (also known as capabilities, user actions, or actions) that the application requests from the OS. The permission settings relevant to Qt apps are listed in "App permissions". |
system (Required) Specifies whether the action is a system (not a user) action. For Qt apps, this attribute must be set to true. |
<permission system="true"> access_internet</permission> |
| <platformArchitecture> | No | Specifies the processor type that the application is compiled for. If you don't specify a value, the Momentics IDE inspects the binary to determine the value. You can use the following values:
|
<platformArchitecture>x86</platformArchitecture> | |
| <platformVersion> | No | Lists the locales supported by the application. The values given must be defined in the IETF Best Current Practice (BCP) 47 specification. You can use a comma-delimited list of locales to list more than one. | <platformVersion>10.2.0.155</platformVersion> | |
| <qnx> | Yes | Defines the top-level element of the schema used for the app descriptor file. |
xmlns (Optional) URL referencing the XML namespace. |
See the example of the app descriptor file in "Writing the app descriptor file". |
| <text> | No | Specifies text for the parent <name> and <description> elements, to support different languages and locales. You can also use this element to specify multiple image files for the <image> and <splashscreen> elements. |
xml:lang (Required) The language or locale code. These hyphenated strings are based on the IETF Best Current Practice (BCP) 47 specification (e.g., en-US for U.S. English, de-DE for German, or fr-CA for Canadian French). |
<description>The Hello World Qt demo app. <text xml:lang="de-DE"> The German description for the Hello World Qt demo app.</text> </description> |
| <versionNumber> | Yes | Specifies the app version as a string in the format <0-999>.<0-999>.<0-999>. The version is useful for determining whether an upgrade is required. The value can be a one-, two-, or three-part value, such as 1, 1.0, or 1.0.0. | <versionNumber>1.0.0</versionNumber> |