DOORS Project reporting V1.0
Functions
pr_doxygencommenting _forfunctions.dxl File Reference

Go to the source code of this file.

Functions

void clearWordState ()
void logError (string errDescription, string errMessage, Object o)
void vbaCheckRes (string res)
void collapseSelection ()
void collapseSelectionBackwards ()
string vbaGetStyleName (OleAutoObj objDoc, int styleNumber)
string wordCheckVersion ()
bool wordPreChecksVBA ()
void getWordStyleNames (OleAutoObj objDoc)
void fillStyleNameArrays ()
void InitWord ()
void UpdateTOC ()
string makeFontTableFromStyle (string styleName)
string pasteAndApplyStyle (OleAutoObj objSelection, RTF_string__ s, string styleName)
string pasteAndApplyStyle (OleAutoObj objSelection, Buffer b, string styleName)
void endKey ()
void MakeSection (string Headline_s, string Text_s, string SectionStructure_s, int SectionStructureLevel_i)
void printFilterError (string input, string err)
Filter parseSimpleFilter (string input)
Filter parseFilter (Buffer b, int startAt, stopAt)
Filter parseFilter (string input)
bool CheckModuleOpen (string ModuleName_s)
OleAutoObj getRange (OleAutoObj obj)
OleAutoObj wordMakeSizedTableVBA (int noRows, int noCols, bool TableBookMarking_b)
int styleIndex (Object o)
OleAutoObj wordGetNumberedCellVBA (OleAutoObj objTable, int rowNo, int cellNo)
string getStyleForAttribute (Object o, string aName)
void wordSetCellContentsVBA (OleAutoObj objCell, Object o, string s)
OleAutoObj nextCellVBA (OleAutoObj objTable, objCell)
OleAutoObj insertBlankRow (OleAutoObj objTable, OleAutoObj objCell)
string pasteHeading (OleAutoObj objSelection, Object o, bool doNumbers)
void wordDumpBodyVBA (Object o, string ObjValue)
void wordDumpCellVBA (OleAutoObj objCell, Object o, bool doNumber, string ObjValue)
OleAutoObj exportTableLayoutRowHeader (Object o, OleAutoObj objTable, objCell)
void wordDumpNamedCellVBA (OleAutoObj objCell, Object o, string attrInCell, string ObjValue)
string GetValue (Object obj, string AttributeName_s, string s_Scriptpath)
OleAutoObj exportTableLayoutRow (Object o, OleAutoObj objTable, objCell, string StrColumnBookMarking_s[], int NumOfColumns_i, string StrColumn_s1[], bool b_FPresent)
int convertMillimetersToPoints (int milliMeters)
void SetColumnWidth (OleAutoObj objColumn, int ColumnWidth_i)
void AutoFitBehavior (OleAutoObj Table_ole)
void create_View (string StrColumn_s[], string StrColumn_s1[], bool TableBookMarking_b, int ColWidth_i[], int NumOfColumns_i, bool AutoWidth_b, string StrColumnBookMarking_s[], string StrColHyperLinking_s[], bool b_FPresent)
string FunctionforParam (OleAutoObj FParamList_ole, int NumOfParams_i)
void ProcessTable (OleAutoObj Table_ole)
void HandleSection (OleAutoObj Section_ole, int SectionStructureLevel_i)
void GetFilterFromXML ()
bool initXML ()
void Export (DB db)
void GetConfigFile ()
void initGUI ()

Function Documentation

void AutoFitBehavior ( OleAutoObj  Table_ole)
 AutoFitBehavior ()
 Description: based on table cells contents or based on width of the document window, it resizes the table

Definition at line 1373 of file pr_doxygencommenting _forfunctions.dxl.

bool CheckModuleOpen ( string  ModuleName_s)
 CheckModuleOpen ()
 Description:to verify the module selected is opened or not

Definition at line 660 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void clearWordState ( )
 clearWordState()
 Description: Controls most display changes on the monitor while a procedure is running and word export will be halted

Definition at line 7 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void collapseSelection ( )
 collapseSelection()
 Description: to make the start and end points as same to enter the data

Definition at line 46 of file pr_doxygencommenting _forfunctions.dxl.

References vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void collapseSelectionBackwards ( )
 collapseSelectionBackwards()
 Description: The direction in which to collapse the range or selection

Definition at line 57 of file pr_doxygencommenting _forfunctions.dxl.

References vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

int convertMillimetersToPoints ( int  milliMeters)
 convertMillimetersToPoints ()
 Description:conversion of data 

Definition at line 1353 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void create_View ( string  StrColumn_s[],
string  StrColumn_s1[],
bool  TableBookMarking_b,
int  ColWidth_i[],
int  NumOfColumns_i,
bool  AutoWidth_b,
string  StrColumnBookMarking_s[],
string  StrColHyperLinking_s[],
bool  b_FPresent 
)
 create_View ()
 Description: if the Type=view this function is called and it will export the columns /attribute data into the word document

Definition at line 1383 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), collapseSelectionBackwards(), convertMillimetersToPoints(), exportTableLayoutRow(), exportTableLayoutRowHeader(), insertBlankRow(), SetColumnWidth(), vbaCheckRes(), wordGetNumberedCellVBA(), wordMakeSizedTableVBA(), and wordSetCellContentsVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

void endKey ( )
 endKey()
 Description:able of contents will be stored in the begining without this it will be at the end of the document

Definition at line 408 of file pr_doxygencommenting _forfunctions.dxl.

References vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void Export ( DB  db)
 Export () 
 Description:Export function triggered when click on "export to word" internally calls different functions to expoprt the object into word and finally gives the message for the user.

Definition at line 2152 of file pr_doxygencommenting _forfunctions.dxl.

References GetFilterFromXML(), and initXML().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj exportTableLayoutRow ( Object  o,
OleAutoObj  objTable,
objCell  ,
string  StrColumnBookMarking_s[],
int  NumOfColumns_i,
string  StrColumn_s1[],
bool  b_FPresent 
)
 exportTableLayoutRow ()
 Description: 

Definition at line 1189 of file pr_doxygencommenting _forfunctions.dxl.

References GetValue(), nextCellVBA(), vbaCheckRes(), wordDumpCellVBA(), wordDumpNamedCellVBA(), and wordSetCellContentsVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj exportTableLayoutRowHeader ( Object  o,
OleAutoObj  objTable,
objCell   
)
 exportTableLayoutRowHeader ()
 Description: 

Definition at line 1063 of file pr_doxygencommenting _forfunctions.dxl.

References nextCellVBA(), wordDumpCellVBA(), and wordSetCellContentsVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

void fillStyleNameArrays ( )
 fillStyleNameArrays()
 Description: headingstyle and bodystyle are set in string of arrays

Definition at line 310 of file pr_doxygencommenting _forfunctions.dxl.

References vbaGetStyleName().

Here is the call graph for this function:

Here is the caller graph for this function:

string FunctionforParam ( OleAutoObj  FParamList_ole,
int  NumOfParams_i 
)
 FunctionforParam ()
 Description: the function to read the parameters mentioned for the function evocation(function post processing node) 

Definition at line 1651 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void GetConfigFile ( )
 GetConfigFile()
 Description: for testing purpose set the module attribute and the value to be populated on DBE

Definition at line 2207 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void GetFilterFromXML ( )
 GetFilterFromXML ()
 Description: XMl file reading for fetching the filters, section information

Definition at line 2066 of file pr_doxygencommenting _forfunctions.dxl.

References HandleSection(), and UpdateTOC().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj getRange ( OleAutoObj  obj)
 getRange ()
 Description:portion of a document that's contained in the specified object

Definition at line 686 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

string getStyleForAttribute ( Object  o,
string  aName 
)
 getStyleForAttribute ()
 Description:Heading style and body styles are defined and assigned for attributes in different levels (currently the default style is taken for all)

Definition at line 798 of file pr_doxygencommenting _forfunctions.dxl.

References styleIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

string GetValue ( Object  obj,
string  AttributeName_s,
string  s_Scriptpath 
)
 GetValue ()
 Description: to fetch the value from the selected object and with the attribute name 

Definition at line 1144 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void getWordStyleNames ( OleAutoObj  objDoc)
 getWordStyleNames()
 Description: to get the Fontname, style name etc

Definition at line 194 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void HandleSection ( OleAutoObj  Section_ole,
int  SectionStructureLevel_i 
)
 HandleSection ()
 Description:  XMl file reading for looping of sections information and table etc

Definition at line 1991 of file pr_doxygencommenting _forfunctions.dxl.

References InitWord(), MakeSection(), and ProcessTable().

Here is the call graph for this function:

Here is the caller graph for this function:

void initGUI ( )
 initGUI()
 Description: Initial GUI to fetch the config file 
 initiate the XMl file before calling this function 

Definition at line 2222 of file pr_doxygencommenting _forfunctions.dxl.

References Export(), and GetConfigFile().

Here is the call graph for this function:

void InitWord ( )
 InitWord()
 Description: Initialize the word document

Definition at line 333 of file pr_doxygencommenting _forfunctions.dxl.

References fillStyleNameArrays(), getWordStyleNames(), vbaGetStyleName(), wordCheckVersion(), and wordPreChecksVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

bool initXML ( )
 initXML ()
 Description: XMl file reading

Definition at line 2108 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

OleAutoObj insertBlankRow ( OleAutoObj  objTable,
OleAutoObj  objCell 
)
 insertBlankRow ()
 Description:rows will be inserted in table format one after the other

Definition at line 898 of file pr_doxygencommenting _forfunctions.dxl.

References nextCellVBA(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void logError ( string  errDescription,
string  errMessage,
Object  o 
)
 logError()
 Description:Error logging is captured

Definition at line 18 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

string makeFontTableFromStyle ( string  styleName)
 makeFontTableFromStyle()
 Description: get the font name from font skiplist using stylename as key and generate a font table

Definition at line 364 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void MakeSection ( string  Headline_s,
string  Text_s,
string  SectionStructure_s,
int  SectionStructureLevel_i 
)
 MakeSection()
 Description:make different sections in the document (like headlines, text etc)

Definition at line 420 of file pr_doxygencommenting _forfunctions.dxl.

References endKey(), pasteAndApplyStyle(), and vbaGetStyleName().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj nextCellVBA ( OleAutoObj  objTable,
objCell   
)
 nextCellVBA ()
 Description:control will be moved to the next row of the table

Definition at line 868 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), vbaCheckRes(), and wordGetNumberedCellVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

Filter parseFilter ( Buffer  b,
int  startAt,
stopAt   
)

Definition at line 544 of file pr_doxygencommenting _forfunctions.dxl.

References parseSimpleFilter(), and printFilterError().

Here is the call graph for this function:

Here is the caller graph for this function:

Filter parseFilter ( string  input)

Definition at line 645 of file pr_doxygencommenting _forfunctions.dxl.

References parseFilter().

Here is the call graph for this function:

Filter parseSimpleFilter ( string  input)

Definition at line 460 of file pr_doxygencommenting _forfunctions.dxl.

References printFilterError().

Here is the call graph for this function:

Here is the caller graph for this function:

string pasteAndApplyStyle ( OleAutoObj  objSelection,
RTF_string__  s,
string  styleName 
)
 pasteAndApplyStyle()
 Description: pasting of the data (richtext) from doors to word

Definition at line 383 of file pr_doxygencommenting _forfunctions.dxl.

References makeFontTableFromStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

string pasteAndApplyStyle ( OleAutoObj  objSelection,
Buffer  b,
string  styleName 
)
 pasteAndApplyStyle()
 Description:pasting of the data (buffer) from doors to word 

Definition at line 396 of file pr_doxygencommenting _forfunctions.dxl.

References makeFontTableFromStyle().

Here is the call graph for this function:

string pasteHeading ( OleAutoObj  objSelection,
Object  o,
bool  doNumbers 
)
 pasteHeading ()
 Description:to paste the heading informations

Definition at line 916 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), getStyleForAttribute(), pasteAndApplyStyle(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void printFilterError ( string  input,
string  err 
)
 printFilterError (),parseSimpleFilter(),parseFilter(),parseFilter()
 Description:Complete section for filtering processing

Definition at line 455 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void ProcessTable ( OleAutoObj  Table_ole)
 ProcessTable ()
 Description: the table attribute and the elements init will be processed like column text, width etc

Definition at line 1696 of file pr_doxygencommenting _forfunctions.dxl.

References CheckModuleOpen(), create_View(), FunctionforParam(), parseFilter(), pasteAndApplyStyle(), and vbaGetStyleName().

Here is the call graph for this function:

Here is the caller graph for this function:

void SetColumnWidth ( OleAutoObj  objColumn,
int  ColumnWidth_i 
)
 SetColumnWidth ()
 Description: to set the column width as defined by the user in the XML configuration file

Definition at line 1362 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

int styleIndex ( Object  o)
 styleIndex ()
 Description:the style levels are called in wordSetCellContentsVBA, getStyleForAttribute functions

Definition at line 758 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void UpdateTOC ( )
 UpdateTOC()
 Description: To update the table of contents.

Definition at line 350 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void vbaCheckRes ( string  res)
 vbaCheckRes()
 Description:Verification method used for OLE methods

Definition at line 32 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState().

Here is the call graph for this function:

Here is the caller graph for this function:

string vbaGetStyleName ( OleAutoObj  objDoc,
int  styleNumber 
)
 vbaGetStyleName()
 Description: takes style number as input, resolves the styles, style, style name and returns the same

Definition at line 68 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

string wordCheckVersion ( )
 wordCheckVersion()
 Description:get the word document's version, either by takingthe existing word, or by creating a new one

Definition at line 111 of file pr_doxygencommenting _forfunctions.dxl.

References vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

void wordDumpBodyVBA ( Object  o,
string  ObjValue 
)
 wordDumpBodyVBA ()
 Description:actual data will be dumped into word(output file) from DOORS module (input)

Definition at line 944 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), getStyleForAttribute(), logError(), and pasteAndApplyStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

void wordDumpCellVBA ( OleAutoObj  objCell,
Object  o,
bool  doNumber,
string  ObjValue 
)
 wordDumpCellVBA ()
 Description:actual data will be dumped into word(output file) from DOORS module (input)

Definition at line 985 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), collapseSelectionBackwards(), getStyleForAttribute(), logError(), pasteAndApplyStyle(), pasteHeading(), vbaCheckRes(), and wordDumpBodyVBA().

Here is the call graph for this function:

Here is the caller graph for this function:

void wordDumpNamedCellVBA ( OleAutoObj  objCell,
Object  o,
string  attrInCell,
string  ObjValue 
)
 wordDumpNamedCellVBA ()
 Description: 

Definition at line 1100 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), collapseSelectionBackwards(), getStyleForAttribute(), logError(), pasteAndApplyStyle(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj wordGetNumberedCellVBA ( OleAutoObj  objTable,
int  rowNo,
int  cellNo 
)
 wordGetNumberedCellVBA ()
 Description:eading style and body styles are defined and assigned for attributes in different levels

Definition at line 776 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

OleAutoObj wordMakeSizedTableVBA ( int  noRows,
int  noCols,
bool  TableBookMarking_b 
)
 wordMakeSizedTableVBA ()
 Description:create table with no.of rows and columns

Definition at line 704 of file pr_doxygencommenting _forfunctions.dxl.

References clearWordState(), collapseSelection(), getRange(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function:

bool wordPreChecksVBA ( )
 wordPreChecksVBA()
 Description:to make the word document visible, active and set the control

Definition at line 138 of file pr_doxygencommenting _forfunctions.dxl.

Here is the caller graph for this function:

void wordSetCellContentsVBA ( OleAutoObj  objCell,
Object  o,
string  s 
)
 wordSetCellContentsVBA ()
 Description:sets the table cells with the data from the selected object attribute from the selected module and the view.

Definition at line 836 of file pr_doxygencommenting _forfunctions.dxl.

References collapseSelection(), collapseSelectionBackwards(), getStyleForAttribute(), pasteAndApplyStyle(), styleIndex(), and vbaCheckRes().

Here is the call graph for this function:

Here is the caller graph for this function: