AddOn Class Reference

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

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	getUninitFilePath ()
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

AddOn()

void AddOn::AddOn ( void addOnPath )

inline

Member Function Documentation

getBaseName()

void AddOn::getBaseName ( )

inline

getClassName()

void AddOn::getClassName ( )

inline

getDocHtmlUrl()

void AddOn::getDocHtmlUrl ( )

inline

getDocJsFile()

void AddOn::getDocJsFile ( )

inline

getDocPath()

void AddOn::getDocPath ( )

inline

getFilePath()

void AddOn::getFilePath ( )

inline

getGroupName()

void AddOn::getGroupName ( )

inline

getGuiAction()

void AddOn::getGuiAction ( )

inline

getInitFilePath()

void AddOn::getInitFilePath ( )

inline

getParentTitle()

void AddOn::getParentTitle ( )

inline

getParentTitles()

void AddOn::getParentTitles ( )

inline

getPath()

void AddOn::getPath ( )

inline

getPostInitFilePath()

void AddOn::getPostInitFilePath ( )

inline

getPreferenceFile()

void AddOn::getPreferenceFile ( )

inline

getPreferenceWidget()

void AddOn::getPreferenceWidget ( )

inline

getTitle()

void AddOn::getTitle ( )

inline

getUninitFilePath()

void AddOn::getUninitFilePath ( )

inline

hasDoc()

void AddOn::hasDoc ( )

inline

hasGuiAction()

void AddOn::hasGuiAction ( )

inline

hasShortcuts()

void AddOn::hasShortcuts ( )

inline

init()

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.

initAddOn()

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

inline

Called once on startup.

isTopLevel()

void AddOn::isTopLevel ( )

inline

load()

void AddOn::load ( void initOnly )

inline

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

Parameters

initOnly

True: only load the add-on if no file ClassNameInit.js is present.

postInit()

void AddOn::postInit ( void splash, void text )

inline

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

postInitAddOn()

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

inline

Called once in the end after startup.

preferenceFileExists()

void AddOn::preferenceFileExists ( )

inline

setPreferenceWidget()

void AddOn::setPreferenceWidget ( void w )

inline

toString()

void AddOn::toString ( )

inline

For debugging.

uninit()

void AddOn::uninit ( )

inline

Member Data Documentation

fileInfo

int AddOn::fileInfo

widget

int AddOn::widget

---

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

• scripts/AddOn.js