umbrello API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

CPPHeaderCodeDocument Class Reference

class CPPHeaderCodeDocument A CPP UMLClassifier Header Code Document. More...

#include <cppheadercodedocument.h>

Inheritance diagram for CPPHeaderCodeDocument:

ClassifierCodeDocument CodeDocument CodeGenObjectWithTextBlocks List of all members.

Public Member Functions

 CPPHeaderCodeDocument (UMLClassifier *classifier)
 Constructor.
virtual ~CPPHeaderCodeDocument ()
 Empty Destructor.
bool addCodeOperation (CodeOperation *op)
 add a code operation to this cpp classifier code document.

Protected Member Functions

void resetTextBlocks ()
 Save the XMI representation of this object.
virtual void loadChildTextBlocksFromNode (QDomElement &root)
 need to overwrite this for cpp header since we need to pick up the header class declaration block.
void addOrUpdateCodeClassFieldMethodsInCodeBlock (CodeClassFieldList &list, CPPHeaderClassDeclarationBlock *codeBlock)
CodeComment * newCodeComment ()
 create a new code comment.
void updateContent ()
 Save the XMI representation of this object.

Detailed Description

class CPPHeaderCodeDocument A CPP UMLClassifier Header Code Document.

Definition at line 34 of file cppheadercodedocument.h.

Constructor & Destructor Documentation

CPPHeaderCodeDocument::CPPHeaderCodeDocument (  UMLClassifier *  concept  ) 
 

Constructor.

This one represents the header portion. The sections of each are as follows:

header includes import statements class declaration guts of the class (e.g. field decl, accessor methods, operations, dependant classes)

Definition at line 54 of file cppheadercodedocument.cpp.

References CodeDocument::setFileExtension().

CPPHeaderCodeDocument::~CPPHeaderCodeDocument (   )  [virtual]
 

Empty Destructor.

Definition at line 80 of file cppheadercodedocument.cpp.

Member Function Documentation

bool CPPHeaderCodeDocument::addCodeOperation (  CodeOperation *  op  )  [virtual]
 

add a code operation to this cpp classifier code document.

Returns:
bool which is true IF the code operation was added successfully

Implements ClassifierCodeDocument.

Definition at line 276 of file cppheadercodedocument.cpp.

References CodeGenObjectWithTextBlocks::addTextBlock().

void CPPHeaderCodeDocument::resetTextBlocks (   )  [protected, virtual]
 

Save the XMI representation of this object.

Reimplemented from CodeDocument.

Definition at line 250 of file cppheadercodedocument.cpp.

void CPPHeaderCodeDocument::loadChildTextBlocksFromNode (  QDomElement &  root  )  [protected, virtual]
 

need to overwrite this for cpp header since we need to pick up the header class declaration block.

Reimplemented from CodeGenObjectWithTextBlocks.

Definition at line 106 of file cppheadercodedocument.cpp.

References CodeGenObjectWithTextBlocks::addTextBlock(), UMLDoc::findObjectById(), UMLApp::getDocument(), CodeDocument::getFileName(), CodeGenObjectWithTextBlocks::getHierarchicalCodeBlock(), UMLObject::loadFromXMI(), CodeBlockWithComments::loadFromXMI(), CodeBlock::loadFromXMI(), CodeComment::loadFromXMI(), CodeDocument::newCodeBlock(), CodeDocument::newCodeBlockWithComments(), and CodeDocument::newHierarchicalCodeBlock().

CodeComment* CPPHeaderCodeDocument::newCodeComment (   )  [protected]
 

create a new code comment.

IN this case it is a CPPCodeDocumentation object.

void CPPHeaderCodeDocument::updateContent (   )  [protected, virtual]
 

Save the XMI representation of this object.

Returns:
bool status of save

Implements ClassifierCodeDocument.

Definition at line 331 of file cppheadercodedocument.cpp.

References CodeGenObjectWithTextBlocks::addOrUpdateTaggedCodeBlockWithComments(), CodeDocument::cleanName(), CodeGenerator::cleanName(), CodeGenerator::findObjectsRelated(), UMLClassifier::findSuperClassConcepts(), CodeDocument::findTextBlockByTag(), CodeGenerationPolicy::getAutoGenerateConstructors(), UMLObject::getBaseType(), ClassifierCodeDocument::getCodeClassFieldList(), CodeGenerationPolicy::getCodeVerboseDocumentComments(), CodeBlockWithComments::getComment(), UMLApp::getCommonPolicy(), CodeBlock::getContentType(), UMLClassifier::getFilteredList(), CodeGenObjectWithTextBlocks::getHierarchicalCodeBlock(), CodeGenerationPolicy::getIndentation(), UMLObject::getName(), CodeGenerationPolicy::getNewLineEndingChars(), UMLClassifier::getOpList(), UMLObject::getPackage(), UMLObject::getPackages(), ClassifierCodeDocument::getParentClassifier(), UMLApp::getPolicyExt(), ClassifierCodeDocument::getSpecificClassFields(), UMLObject::getUMLPackage(), ClassifierCodeDocument::hasClassFields(), ClassifierCodeDocument::hasObjectVectorClassFields(), ClassifierCodeDocument::parentIsInterface(), CodeClassField::setWriteOutMethods(), and TextBlock::setWriteOutText().

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:04 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003