Mac OS X Reference Library Apple Developer
Search

Mac OS X Keys

The keys in this chapter define assorted functionality related to Mac OS X bundles.

Key Summary

Table 1 contains an alphabetical listing of Mac OS X–specific keys, the corresponding name for that key in the Xcode property list editor, a high-level description of each key, and the platforms on which you use it. Detailed information about each key is available in later sections.

Table 1  Summary of Mac OS X keys

Key

Xcode name

Summary

Availability

APInstallerURL

"Installation directory base file URL”

A URL-based path to the files you want to install. See “APInstallerURL” for details.

Mac OS X

APFiles

"Installation files”

An array of dictionaries describing the files or directories that can be installed. See “APFiles” for details.

Mac OS X

ATSApplicationFontsPath

"Application fonts resource path”

The path to a single font file or directory of font files in the bundle’s Resources directory. See “ATSApplicationFontsPath” for details.

Mac OS X

CSResourcesFileMapped

"Resources should be file-mapped”

If true, Core Services routines map the bundle’s resource files into memory instead of reading them. See “CSResourcesFileMapped” for details.

Mac OS X

QuartzGLEnable

None

Specifies whether the application uses Quartz GL. See “QuartzGLEnable” for details.

Mac OS X 10.5 and later

APInstallerURL

APInstallerURL (String - Mac OS X) identifies the base path to the files you want to install. You must specify this path using the form file://localhost/path/. All installed files must reside within this directory.

APFiles

APFiles (Array - Mac OS X) specifies a file or directory you want to install. You specify this key as a dictionary, the contents of which contains information about the file or directory you want to install. To specify multiple items, nest the APFiles key inside itself to specify files inside of a directory. Table 2 lists the keys for specifying information about a single file or directory.

Table 2  Keys for APFiles dictionary

Key

Xcode name

Type

Description

Platform

APFileDescriptionKey

"Install file description text”

String

A short description of the item to display in the Finder’s Info window

Mac OS X

APDisplayedAsContainer

"Display with folder icon”

String

If “Yes” the item is shown with a folder icon in the Info panel; otherwise, it is shown with a document icon

Mac OS X

APFileDestinationPath

"File destination path”

String

Where to install the component as a path relative to the application bundle

Mac OS X

APFileName

"Install file name”

String

The name of the file or directory

Mac OS X

APFileSourcePath

"Install file source path”

String

The path to the component in the application package relative to the APInstallerURL path.

Mac OS X

APInstallAction

"File install action”

String

The action to take with the component: “Copy” or “Open”

Mac OS X

ATSApplicationFontsPath

ATSApplicationFontsPath (String - Mac OS X) identifies the location of a font file or directory of fonts in the bundle’s Resources directory. If present, Mac OS X activates the fonts at the specified path for use by the bundled application. The fonts are activated only for the bundled application and not for the system as a whole. The path itself should be specified as a relative directory of the bundle’s Resources directory. For example, if a directory of fonts was at the path /Applications/MyApp.app/Contents/Resources/Stuff/MyFonts/, you should specify the string Stuff/MyFonts/ for the value of this key.

CSResourcesFileMapped

CSResourcesFileMappedBoolean - Mac OS X) specifies whether to map this application’s resource files into memory. Otherwise, they are read into memory normally. File mapping can improve performance in situations where you are frequently accessing a small number of resources. However, resources are mapped into memory read-only and cannot be modified.

QuartzGLEnable

QuartzGLEnable (Boolean - Mac OS X) specifies whether this application uses Quartz GL.

Value

Description

true

Turn on Quartz GL for the application's windows. (This works only when the computer has at least 1GM of RAM).

false

Disable Quartz GL. Quartz GL will not be available, even after using [<NSWindow> setPreferredBackingLocation:].

Quartz GL is not supported on computers with more than one video card installed.

To turn on Quartz QL for testing use the Quartz Debug application, located in <Xcode>/Applications.

This key is available in Mac OS X v10.5 and later.




Last updated: 2010-07-08

Did this document help you? Yes It's good, but... Not helpful...