gensrc.addins.addin.Addin Class Reference
Inheritance diagram for gensrc.addins.addin.Addin:
Collaboration diagram for gensrc.addins.addin.Addin:
Public Member Functions | |
| 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 | idStrip (self, parameterList) |
| def | relativePath (self) |
| def | repositoryClass (self) |
| def | overwriteVariable (self) |
| def | serialize (self, serializer) |
| serializer interface More... | |
| def | postSerialize (self) |
| def | __init__ (self) |
| private member functions More... | |
Public Attributes | |
| rootPath_ | |
| unchanged_ | |
| updated_ | |
| created_ | |
Static Public Attributes | |
| string | objectIdSuffix_ = '' |
| class variables | |
| string | repositoryClass_ = 'Repository' |
| string | overwriteVariable_ = 'Overwrite' |
Detailed Description
Class to encapsulate data and behavior required to generate addin source code.
Constructor & Destructor Documentation
◆ __init__()
| def gensrc.addins.addin.Addin.__init__ | ( | self | ) |
private member functions
Initialize the Addin object.
Member Function Documentation
◆ bufferLoop()
| def gensrc.addins.addin.Addin.bufferLoop | ( | self | ) |
Return the buffer of code for loop functions.
◆ created()
| def gensrc.addins.addin.Addin.created | ( | self | ) |
Return a count of the source code files for this addin which are created for this execution of gensrc.
◆ idStrip()
| def gensrc.addins.addin.Addin.idStrip | ( | self, | |
| parameterList | |||
| ) |
Return the RuleGroup object named idStrip which was loaded from the XML rule metadata for this addin. On platforms where this function is required, it must be overloaded in derived classes.
Reimplemented in gensrc.addins.excel.ExcelAddin.
◆ incrementCreated()
| def gensrc.addins.addin.Addin.incrementCreated | ( | self | ) |
Increment the count of created source code files.
◆ incrementUnchanged()
| def gensrc.addins.addin.Addin.incrementUnchanged | ( | self | ) |
Increment the count of unchanged source code files.
◆ incrementUpdated()
| def gensrc.addins.addin.Addin.incrementUpdated | ( | self | ) |
Increment the count of updated source code files.
◆ libraryCall()
| def gensrc.addins.addin.Addin.libraryCall | ( | self | ) |
Return the RuleGroup object named libraryCall which was loaded from the XML rule metadata for this addin.
◆ libraryReturnType()
| def gensrc.addins.addin.Addin.libraryReturnType | ( | self | ) |
Return the RuleGroup object named libraryReturnType which was loaded from the XML rule metadata for this addin.
◆ loopInputs()
| def gensrc.addins.addin.Addin.loopInputs | ( | self | ) |
Return the RuleGroup object named loopInputs which was loaded from the XML rule metadata for this addin.
◆ loopReturnType()
| def gensrc.addins.addin.Addin.loopReturnType | ( | self | ) |
Return the RuleGroup object named loopReturnType which was loaded from the XML rule metadata for this addin.
◆ objectIdSuffix()
| def gensrc.addins.addin.Addin.objectIdSuffix | ( | self | ) |
public interface
Return the text which is appended to variable names in autogenerated source code after object IDs are converted to the corresponding objects.
◆ overwriteVariable()
| def gensrc.addins.addin.Addin.overwriteVariable | ( | self | ) |
Return the name of the variable which indicates whether a new object should overwrite an existing one. Presently this variable is called 'Overwrite' on the Excel platform and is not defined elsewhere.
◆ postSerialize()
| def gensrc.addins.addin.Addin.postSerialize | ( | self | ) |
Perform post serialization initialization.
◆ relativePath()
| def gensrc.addins.addin.Addin.relativePath | ( | self | ) |
Return the subdirectory to which source code for this addin is written, relative to the root directory of the application.
◆ repositoryClass()
| def gensrc.addins.addin.Addin.repositoryClass | ( | self | ) |
Return the name of the ObjectHandler Repository class, e.g. 'RepositoryXL' on the Excel platform, otherwise 'Repository'.
◆ serialize()
| def gensrc.addins.addin.Addin.serialize | ( | self, | |
| serializer | |||
| ) |
serializer interface
Load/unload class state to/from serializer object.
Reimplemented in gensrc.addins.excel.ExcelAddin, gensrc.addins.calc.CalcAddin, gensrc.addins.serialization.Serialization, gensrc.addins.valueobjects.ValueObjects, and gensrc.addins.cpp.CppAddin.
◆ unchanged()
| def gensrc.addins.addin.Addin.unchanged | ( | self | ) |
Return a count of the source code files for this addin which are unchanged for this execution of gensrc.
◆ updated()
| def gensrc.addins.addin.Addin.updated | ( | self | ) |
Return a count of the source code files for this addin which are updated for this execution of gensrc.
◆ voCall()
| def gensrc.addins.addin.Addin.voCall | ( | self | ) |
Return the RuleGroup object named voCall which was loaded from the XML rule metadata for this addin.
The documentation for this class was generated from the following file:
- addin.py