Script
Properties | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for specialFolders:
Collaboration graph
[legend]

Properties

QString root
 read-only property for the root installation folder
 
QString config
 read-only property that contains the folder where application configuration files are stored. Normally, this is the /etc folder.
 
QString resource
 read-only property that contains where the resources files are stored.
 
QString etc
 read-only property that indicates where the <install>/etc folder is.
 
QString lang
 read-only property that contains the folder where the language files are stored.
 
QString platform
 read-only property that contains the platform specific folder.
 
QString 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.
 
QString 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.
 
QString bin32
 This is a read-only property that contains the folder where the platforms specific 32-bit binaries are stored.
 
QString library
 This is a read-only property that contains the folder where the platforms specific libraries are stored.
 
QString legacyPlugins
 Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property.
 
QString plugins
 Location where the plugins that comply with the current SDK are stored.
 
QString temp
 This is a read-only property that contains where the application will create its temporary files.
 
QString userConfig
 This is a read-only property that contains the folder where the user configuration is stored.
 
QString 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

QString 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.

QString 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.

QString specialFolders::bin32
read

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

QString specialFolders::config
read

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

QString specialFolders::etc
read

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

QString specialFolders::htmlHelp
read

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

QString specialFolders::lang
read

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

QString specialFolders::legacyPlugins
read

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

QString specialFolders::library
read

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

QString specialFolders::platform
read

read-only property that contains the platform specific folder.

QString specialFolders::plugins
read

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

QString specialFolders::resource
read

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

QString specialFolders::root
read

read-only property for the root installation folder

QString specialFolders::temp
read

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

QString 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: