QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
AddOn Class Reference

Initializes and manages all add-ons. More...

List of all members.

Public Member Functions

void AddOn (void addOnPath)
void getBaseName ()
void getClassName ()
void getDocHtmlUrl ()
void getDocJsFile ()
void getDocPath ()
void getFilePath ()
void getGroupName ()
void getGuiAction ()
void getInitFilePath ()
void getParentTitle ()
void getParentTitles ()
void getPath ()
void getPostInitFilePath ()
void getPreferenceFile ()
void getPreferenceWidget ()
void getTitle ()
void hasDoc ()
void hasGuiAction ()
void hasShortcuts ()
void init (void splash, void text)
 Called once on startup to initialize the add-on, its preference page and its documentation if applicable.
void initAddOn (void splash, void text)
void isTopLevel ()
void load (void initOnly)
 Loads the add-on by including its main source file.
void postInit (void splash, void text)
 Called once on startup to post-initialize the add-on.
void postInitAddOn (void splash, void text)
void preferenceFileExists ()
void setPreferenceWidget (void w)
void toString ()
 For debugging.
void uninit ()

Public Attributes

int fileInfo
int widget

Detailed Description

Initializes and manages all add-ons.

Every directory in the script directory of QCAD is a add-on if it contains an ECMAScript file with the same name as the directory and the extension ".js". For example MyAddOn/MyAddOn.js.


Constructor & Destructor Documentation

void AddOn::AddOn ( void  addOnPath)
inline

Member Function Documentation

void AddOn::getBaseName ( )
inline
void AddOn::getClassName ( )
inline
void AddOn::getDocHtmlUrl ( )
inline
void AddOn::getDocJsFile ( )
inline
void AddOn::getDocPath ( )
inline
void AddOn::getFilePath ( )
inline
void AddOn::getGroupName ( )
inline
void AddOn::getGuiAction ( )
inline
void AddOn::getInitFilePath ( )
inline
void AddOn::getParentTitle ( )
inline
void AddOn::getParentTitles ( )
inline
void AddOn::getPath ( )
inline
void AddOn::getPostInitFilePath ( )
inline
void AddOn::getPreferenceFile ( )
inline
void AddOn::getPreferenceWidget ( )
inline
void AddOn::getTitle ( )
inline
void AddOn::hasDoc ( )
inline
void AddOn::hasGuiAction ( )
inline
void AddOn::hasShortcuts ( )
inline
void AddOn::init ( void  splash,
void  text 
)
inline

Called once on startup to initialize the add-on, its preference page and its documentation if applicable.

void AddOn::initAddOn ( void  splash,
void  text 
)
inline

Called once on startup.

void AddOn::isTopLevel ( )
inline
void AddOn::load ( void  initOnly)
inline

Loads the add-on by including its main source file.

Parameters:
initOnlyTrue: only load the add-on if no file ClassNameInit.js is present.
void AddOn::postInit ( void  splash,
void  text 
)
inline

Called once on startup to post-initialize the add-on.

void AddOn::postInitAddOn ( void  splash,
void  text 
)
inline

Called once in the end after startup.

void AddOn::preferenceFileExists ( )
inline
void AddOn::setPreferenceWidget ( void  w)
inline
void AddOn::toString ( )
inline

For debugging.

void AddOn::uninit ( )
inline

Member Data Documentation

int AddOn::fileInfo
int AddOn::widget

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