gensrc.addins.excel.ExcelAddin Class Reference

Inheritance diagram for gensrc.addins.excel.ExcelAddin:

Collaboration diagram for gensrc.addins.excel.ExcelAddin:

Public Member Functions
def	generate (self, categoryList, enumerationList)
	public interface More...
def	generateFunctions (self)
def	indexOfCol (self, str)
def	cellNameConflict (self, funcName)
def	xlWizardCheck (self, func)
def	generateFunction (self, func)
def	checkLen (self, str)
def	generateRegisterFunction (self, func, categoryName, register=True)
def	outputRegisterFile (self, registerCode, unregisterCode, categoryName)
def	generateRegisterFunctions (self, cat)
def	generateAddin (self)
def	generateExportSymbols (self)
def	generateFunctionCount (self)
def	printDebug (self)
def	functionDeclaration (self)
def	functionReturnType (self)
def	xlRegisterParam (self)
def	xlRegisterReturn (self)
def	parameterList (self)
def	registerParameters (self)
def	cppConversions (self)
def	libraryConversions (self)
def	enumConversions (self)
def	objectConversions (self)
def	referenceConversions (self)
def	returnConversion (self)
def	loopName (self, param)
def	idStrip (self, parameterList)
def	serialize (self, serializer)
	serializer interface More...
Public Member Functions inherited from gensrc.addins.addin.Addin
def	objectIdSuffix (self)
	public interface More...
def	bufferLoop (self)
def	unchanged (self)
def	updated (self)
def	created (self)
def	incrementUnchanged (self)
def	incrementUpdated (self)
def	incrementCreated (self)
def	voCall (self)
def	libraryCall (self)
def	libraryReturnType (self)
def	loopInputs (self)
def	loopReturnType (self)
def	relativePath (self)
def	repositoryClass (self)
def	overwriteVariable (self)
def	postSerialize (self)
def	__init__ (self)
	private member functions More...

Public Attributes
	categoryList_
	enumerationList_
	functionCount_
Public Attributes inherited from gensrc.addins.addin.Addin
	rootPath_
	unchanged_
	updated_
	created_

Static Public Attributes
string	XL_WIZARD_CHECK
	class variables More...
string	ID_STRIP
string	VALIDATE_TRIGGER
string	objectIdSuffix_ = 'Strip'
string	repositoryClass_ = 'RepositoryXL'
string	overwriteVariable_ = '*Overwrite'
Static Public Attributes inherited from gensrc.addins.addin.Addin
string	objectIdSuffix_ = ''
	class variables
string	repositoryClass_ = 'Repository'
string	overwriteVariable_ = 'Overwrite'

Detailed Description

Generate source code for Excel addin.

Member Function Documentation

cellNameConflict()

def gensrc.addins.excel.ExcelAddin.cellNameConflict	(		self,
			funcName
	)

Return a boolean indicating whether the given function name
conflicts with a cell range name in Excel.

checkLen()

def gensrc.addins.excel.ExcelAddin.checkLen	(		self,
			str
	)

Calculate the length of the string, ensure that this value doesn't exceed
Excel's limit, and return the value.

cppConversions()

def gensrc.addins.excel.ExcelAddin.cppConversions

(

self

)

Return the RuleGroup object named cppConversions which was loaded
from the XML rule metadata for this addin.

enumConversions()

def gensrc.addins.excel.ExcelAddin.enumConversions

(

self

)

Return the RuleGroup object named enumConversions which was loaded
from the XML rule metadata for this addin.

functionDeclaration()

def gensrc.addins.excel.ExcelAddin.functionDeclaration

(

self

)

Return the RuleGroup object named functionDeclaration which was loaded
from the XML rule metadata for this addin.

functionReturnType()

def gensrc.addins.excel.ExcelAddin.functionReturnType

(

self

)

Return the RuleGroup object named functionReturnType which was loaded
from the XML rule metadata for this addin.

generate()

def gensrc.addins.excel.ExcelAddin.generate	(		self,
			categoryList,
			enumerationList
	)

public interface

Generate source code for Excel addin.

generateAddin()

def gensrc.addins.excel.ExcelAddin.generateAddin

(

self

)

Generate source code to register functions.

generateExportSymbols()

def gensrc.addins.excel.ExcelAddin.generateExportSymbols

(

self

)

Generate directives that cause exported symbols to be available to
clients of this Addin.

generateFunction()

def gensrc.addins.excel.ExcelAddin.generateFunction	(		self,
			func
	)

Generate source code for a given function.

generateFunctionCount()

def gensrc.addins.excel.ExcelAddin.generateFunctionCount

(

self

)

Generate a header indicating the number of functions in this addin.

generateFunctions()

def gensrc.addins.excel.ExcelAddin.generateFunctions

(

self

)

Generate source code for all functions in all categories.

generateRegisterFunction()

def gensrc.addins.excel.ExcelAddin.generateRegisterFunction	(		self,
			func,
			categoryName,
			register = True
	)

Generate code to register/unregister given function.

generateRegisterFunctions()

def gensrc.addins.excel.ExcelAddin.generateRegisterFunctions	(		self,
			cat
	)

Generate the code for registering addin functions with Excel.

idStrip()

def gensrc.addins.excel.ExcelAddin.idStrip	(		self,
			parameterList
	)

Return a snippet of code comprising the list of parameters,
where the Excel cell update counter suffix has been removed
from object IDs.

Reimplemented from gensrc.addins.addin.Addin.

indexOfCol()

def gensrc.addins.excel.ExcelAddin.indexOfCol	(		self,
			str
	)

Convert an Excel column ID to an int

libraryConversions()

def gensrc.addins.excel.ExcelAddin.libraryConversions

(

self

)

Return the RuleGroup object named libraryConversions which was loaded
from the XML rule metadata for this addin.

loopName()

def gensrc.addins.excel.ExcelAddin.loopName	(		self,
			param
	)

Return the name of the given parameter as required for loop code - in
this case no conversion is performed.

objectConversions()

def gensrc.addins.excel.ExcelAddin.objectConversions

(

self

)

Return the RuleGroup object named objectConversions which was loaded
from the XML rule metadata for this addin.

outputRegisterFile()

def gensrc.addins.excel.ExcelAddin.outputRegisterFile	(		self,
			registerCode,
			unregisterCode,
			categoryName
	)

Write to disk the buffer for registering functions.

parameterList()

def gensrc.addins.excel.ExcelAddin.parameterList

(

self

)

Return the RuleGroup object named parameterList which was loaded
from the XML rule metadata for this addin.

printDebug()

def gensrc.addins.excel.ExcelAddin.printDebug

(

self

)

Write debug info to stdout.

referenceConversions()

def gensrc.addins.excel.ExcelAddin.referenceConversions

(

self

)

Return the RuleGroup object named referenceConversions which was loaded
from the XML rule metadata for this addin.

registerParameters()

def gensrc.addins.excel.ExcelAddin.registerParameters

(

self

)

Return the RuleGroup object named registerParameters which was loaded
from the XML rule metadata for this addin.

returnConversion()

def gensrc.addins.excel.ExcelAddin.returnConversion

(

self

)

Return the RuleGroup object named returnConversion which was loaded
from the XML rule metadata for this addin.

serialize()

def gensrc.addins.excel.ExcelAddin.serialize	(		self,
			serializer
	)

serializer interface

Load/unload class state to/from serializer object.

Reimplemented from gensrc.addins.addin.Addin.

xlRegisterParam()

def gensrc.addins.excel.ExcelAddin.xlRegisterParam

(

self

)

Return the RuleGroup object named xlRegisterParam which was loaded
from the XML rule metadata for this addin.

xlRegisterReturn()

def gensrc.addins.excel.ExcelAddin.xlRegisterReturn

(

self

)

Return the RuleGroup object named xlRegisterReturn which was loaded
from the XML rule metadata for this addin.

xlWizardCheck()

def gensrc.addins.excel.ExcelAddin.xlWizardCheck	(		self,
			func
	)

Test whether the function should check for the Function Wizard
and if so return the relevant code snippet.

Member Data Documentation

ID_STRIP

string gensrc.addins.excel.ExcelAddin.ID_STRIP

static

Initial value:

=  '''
    // Strip the Excel cell update counter suffix from Object IDs
    
    std::string ObjectIdStrip = ObjectHandler::CallingRange::getStub(ObjectId);%s\n'''

VALIDATE_TRIGGER

string gensrc.addins.excel.ExcelAddin.VALIDATE_TRIGGER

static

Initial value:

=  '''
    ObjectHandler::validateRange(Trigger, "Trigger");'''

XL_WIZARD_CHECK

string gensrc.addins.excel.ExcelAddin.XL_WIZARD_CHECK

static

Initial value:

=  '''
    if (functionCall->calledByFunctionWizard())
        return 0;\n'''

class variables

---

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

• excel.py