TinkerCell Core 1.0
TinkerCell's Core library providing all basic functionalities
Static Public Member Functions | Static Public Attributes
Tinkercell::GlobalSettings Class Reference

This class stores global variables such as project names, enables/disabled feature, etc. Use the following static bools to enable or disable features: ENABLE_HISTORY_WINDOW ENABLE_CONSOLE_WINDOW ENABLE_GRAPHING_TOOLS ENABLE_CODING_TOOLS ENABLE_ALIGNMENT_MENU ENABLE_COLOR_TOOLBAR ENABLE_ZOOM_TOOLBAR ENABLE_TEXT_TOOLBAR ENABLE_PYTHON ENABLE_RUBY ENABLE_OCTAVE ENABLE_LOADSAVE_TOOL. More...

#include <GlobalSettings.h>

List of all members.

Static Public Member Functions

static void RegisterDataTypes ()
 register all the TinkerCell data structures with Qt
static QString homeDir ()
 The TinkerCell user directory, which is User's Documents Folder/TinkerCell by default, but users may change this setting.
static QString tempDir ()
 The TinkerCell user temporary directory, which is <SYSTEM temp="" folder>="">/TinkerCell.

Static Public Attributes

static bool ENABLE_HISTORY_WINDOW
 enable history window -- defaults to true
static bool ENABLE_CONSOLE_WINDOW
 enable console window -- defaults to true
static bool ENABLE_GRAPHING_TOOLS
 enable plot2d, plot3d, and gnuplot -- defaults to false
static bool ENABLE_CODING_TOOLS
 enable coding window and interpreters -- defaults to false
static bool ENABLE_ALIGNMENT_MENU
 enable alignment menu -- defaults to true
static bool ENABLE_COLOR_TOOLBAR
 enable color menu -- defaults to true
static bool ENABLE_ZOOM_TOOLBAR
 enable zoom menu -- defaults to true
static bool ENABLE_TEXT_TOOLBAR
 enable text options -- defaults to true
static bool ENABLE_PYTHON
 enable python interpreter -- defaults to false
static bool ENABLE_OCTAVE
 enable octave interpreter -- defaults to false
static bool ENABLE_RUBY
 enable octave interpreter -- defaults to false
static bool ENABLE_LOADSAVE_TOOL
 enable loading and saving -- defaults to true
static QString PROJECTWEBSITE
 the project website
static QString ORGANIZATIONNAME
 the project organization name
static QString PROJECTNAME
 the project name
static QString PROJECTICON
 the project icon file
static QString CPP_ENTRY_FUNCTION
 the default function that is loaded in C++ plugins
static QString C_ENTRY_FUNCTION
 the default function that is loaded in C plugins
static QString PROJECT_VERSION
 the default project version
static QString PROGRAM_MODE
 an optional string that can be used to change the mode of the application. The meaning of this variable depends on the purpose of the application. Empty by default.
static QStringList OPEN_FILE_EXTENSIONS
 the default file extensions that can be opened
static QStringList SAVE_FILE_EXTENSIONS
 the default file extensions that can be saved
static bool DO_SVN_UPDATE
 if there is an svn service that stores latest plug-ins, then set DO_SVN_UPDATE and CODING_TOOLS to true
static QString PLUGINS_SVN_URL
 if there is an svn service that stores latest plug-ins, place that url here

Detailed Description

This class stores global variables such as project names, enables/disabled feature, etc. Use the following static bools to enable or disable features: ENABLE_HISTORY_WINDOW ENABLE_CONSOLE_WINDOW ENABLE_GRAPHING_TOOLS ENABLE_CODING_TOOLS ENABLE_ALIGNMENT_MENU ENABLE_COLOR_TOOLBAR ENABLE_ZOOM_TOOLBAR ENABLE_TEXT_TOOLBAR ENABLE_PYTHON ENABLE_RUBY ENABLE_OCTAVE ENABLE_LOADSAVE_TOOL.

Definition at line 38 of file GlobalSettings.h.


Member Function Documentation

static QString Tinkercell::GlobalSettings::homeDir ( ) [static]

The TinkerCell user directory, which is User's Documents Folder/TinkerCell by default, but users may change this setting.

Here is the caller graph for this function:

static void Tinkercell::GlobalSettings::RegisterDataTypes ( ) [static]

register all the TinkerCell data structures with Qt

static QString Tinkercell::GlobalSettings::tempDir ( ) [static]

The TinkerCell user temporary directory, which is <SYSTEM temp="" folder>="">/TinkerCell.

Here is the caller graph for this function:


Member Data Documentation

the default function that is loaded in C plugins

Definition at line 93 of file GlobalSettings.h.

the default function that is loaded in C++ plugins

Definition at line 90 of file GlobalSettings.h.

if there is an svn service that stores latest plug-ins, then set DO_SVN_UPDATE and CODING_TOOLS to true

Definition at line 109 of file GlobalSettings.h.

enable alignment menu -- defaults to true

Definition at line 54 of file GlobalSettings.h.

enable coding window and interpreters -- defaults to false

Definition at line 51 of file GlobalSettings.h.

enable color menu -- defaults to true

Definition at line 57 of file GlobalSettings.h.

enable console window -- defaults to true

Definition at line 45 of file GlobalSettings.h.

enable plot2d, plot3d, and gnuplot -- defaults to false

Definition at line 48 of file GlobalSettings.h.

enable history window -- defaults to true

Definition at line 42 of file GlobalSettings.h.

enable loading and saving -- defaults to true

Definition at line 75 of file GlobalSettings.h.

enable octave interpreter -- defaults to false

Definition at line 69 of file GlobalSettings.h.

enable python interpreter -- defaults to false

Definition at line 66 of file GlobalSettings.h.

enable octave interpreter -- defaults to false

Definition at line 72 of file GlobalSettings.h.

enable text options -- defaults to true

Definition at line 63 of file GlobalSettings.h.

enable zoom menu -- defaults to true

Definition at line 60 of file GlobalSettings.h.

the default file extensions that can be opened

Definition at line 103 of file GlobalSettings.h.

the project organization name

Definition at line 81 of file GlobalSettings.h.

if there is an svn service that stores latest plug-ins, place that url here

Definition at line 112 of file GlobalSettings.h.

an optional string that can be used to change the mode of the application. The meaning of this variable depends on the purpose of the application. Empty by default.

Definition at line 100 of file GlobalSettings.h.

the default project version

Definition at line 96 of file GlobalSettings.h.

the project icon file

Definition at line 87 of file GlobalSettings.h.

the project name

Definition at line 84 of file GlobalSettings.h.

the project website

Definition at line 78 of file GlobalSettings.h.

the default file extensions that can be saved

Definition at line 106 of file GlobalSettings.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines