specialFolders Class Reference

By using the SpecialFolders functions, you can retrieve information about the different folders (directories) used by the application. All of the functions are read-only. They return strings that represent folders in use by the various applications. Depending on the application (e.g. Toon Boom Harmony versus Toon Boom AnimatePro), the same content is stored in a different location. More...

#include <specialFolder.h>

Inheritance diagram for specialFolders:

Collaboration diagram for specialFolders:

Properties
String	root
	read-only property for the root installation folder
String	config
	read-only property that contains the folder where application configuration files are stored. Normally, this is the /etc folder.
String	resource
	read-only property that contains where the resources files are stored.
String	etc
	read-only property that indicates where the <install>/etc folder is.
String	lang
	read-only property that contains the folder where the language files are stored.
String	platform
	read-only property that contains the platform specific folder.
String	app
	A read-only property containing the folder where the platforms specific applications are stored. Application and Binary folders are different on OS X, but are identical on all other platforms.
String	bin
	This is a read-only property that contains the folder where the platforms specific binaries are stored. Application and Binary folders are different on OS X. They are identical on all other platforms.
String	bin32
	This is a read-only property that contains the folder where the platforms specific 32-bit binaries are stored.
String	library
	This is a read-only property that contains the folder where the platforms specific libraries are stored.
String	legacyPlugins
	Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property.
String	plugins
	Location where the plugins that comply with the current SDK are stored.
String	temp
	This is a read-only property that contains where the application will create its temporary files.
String	userConfig
	This is a read-only property that contains the folder where the user configuration is stored.
String	htmlHelp
	This is a read-only property that contains the folder where the html help folder is.

Detailed Description

By using the SpecialFolders functions, you can retrieve information about the different folders (directories) used by the application. All of the functions are read-only. They return strings that represent folders in use by the various applications. Depending on the application (e.g. Toon Boom Harmony versus Toon Boom AnimatePro), the same content is stored in a different location.

Property Documentation

String specialFolders::app

read

A read-only property containing the folder where the platforms specific applications are stored. Application and Binary folders are different on OS X, but are identical on all other platforms.

String specialFolders::bin

read

This is a read-only property that contains the folder where the platforms specific binaries are stored. Application and Binary folders are different on OS X. They are identical on all other platforms.

String specialFolders::bin32

read

This is a read-only property that contains the folder where the platforms specific 32-bit binaries are stored.

String specialFolders::config

read

read-only property that contains the folder where application configuration files are stored. Normally, this is the /etc folder.

String specialFolders::etc

read

read-only property that indicates where the <install>/etc folder is.

String specialFolders::htmlHelp

read

This is a read-only property that contains the folder where the html help folder is.

String specialFolders::lang

read

read-only property that contains the folder where the language files are stored.

String specialFolders::legacyPlugins

read

Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property.

String specialFolders::library

read

This is a read-only property that contains the folder where the platforms specific libraries are stored.

String specialFolders::platform

read

read-only property that contains the platform specific folder.

String specialFolders::plugins

read

Location where the plugins that comply with the current SDK are stored.

String specialFolders::resource

read

read-only property that contains where the resources files are stored.

String specialFolders::root

read

read-only property for the root installation folder

String specialFolders::temp

read

This is a read-only property that contains where the application will create its temporary files.

String specialFolders::userConfig

read

This is a read-only property that contains the folder where the user configuration is stored.

---

The documentation for this class was generated from the following file:

• dox_files/variableScript/specialFolder.h