umbrello  2.30.80
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Public Member Functions | Static Public Attributes | List of all members
CPPMakefileCodeDocument Class Reference

#include <cppmakecodedocument.h>

Inheritance diagram for CPPMakefileCodeDocument:
Inheritance graph
Collaboration diagram for CPPMakefileCodeDocument:
Collaboration graph

Public Member Functions

 CPPMakefileCodeDocument ()
 
virtual ~CPPMakefileCodeDocument ()
 
QString toString ()
 
QString getPath ()
 
void updateContent ()
 
- Public Member Functions inherited from CodeDocument
 CodeDocument ()
 
virtual ~CodeDocument ()
 
void setFileExtension (const QString &new_var)
 
QString getFileExtension () const
 
void setFileName (const QString &new_var)
 
QString getFileName () const
 
void setPackage (UMLPackage *new_var)
 
QString getPackage () const
 
void setID (const QString &new_id)
 
QString ID () const
 
void setWriteOutCode (bool new_var)
 
bool getWriteOutCode ()
 
void setHeader (CodeComment *comment)
 
CodeCommentgetHeader ()
 
bool insertTextBlock (TextBlock *newBlock, TextBlock *existingBlock, bool after=true)
 
TextBlockfindTextBlockByTag (const QString &tag, bool descendIntoChildren=false)
 
virtual void saveToXMI1 (QDomDocument &doc, QDomElement &root)
 
virtual void loadFromXMI1 (QDomElement &root)
 
virtual CodeBlocknewCodeBlock ()
 
virtual HierarchicalCodeBlocknewHierarchicalCodeBlock ()
 
virtual CodeBlockWithCommentsnewCodeBlockWithComments ()
 
virtual QString getUniqueTag (const QString &prefix=QString())
 
QString cleanName (const QString &name)
 
virtual void synchronize ()
 
- Public Member Functions inherited from CodeGenObjectWithTextBlocks
 CodeGenObjectWithTextBlocks (CodeDocument *parent)
 
virtual ~CodeGenObjectWithTextBlocks ()
 
virtual bool addTextBlock (TextBlock *add_object)
 
virtual bool removeTextBlock (TextBlock *remove_object)
 
TextBlockListgetTextBlockList () const
 
virtual HierarchicalCodeBlockgetHierarchicalCodeBlock (const QString &tag, const QString &comment, int indentLevel)
 
virtual CodeBlockWithCommentsgetCodeBlockWithComments (const QString &tag, const QString &comment, int indentLevel)
 
CodeCommentaddOrUpdateTaggedCodeComment (const QString &tag=QString(), const QString &text=QString(), int indentationLevel=0)
 
CodeBlockWithCommentsaddOrUpdateTaggedCodeBlockWithComments (const QString &tag, const QString &text, const QString &ctext, int indentLevel, bool forceUserBlockUpdate)
 
TextBlockfindTextBlockByTag (const QString &tag)
 
CodeGenObjectWithTextBlocksfindParentObjectForTaggedTextBlock (const QString &tag)
 

Static Public Attributes

static const char * DOCUMENT_ID_VALUE = "Makefile_DOC"
 

Additional Inherited Members

- Protected Member Functions inherited from CodeDocument
virtual void setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
 
virtual void setAttributesFromNode (QDomElement &element)
 
void addChildTagToMap (const QString &tag, TextBlock *tb)
 
void removeChildTagFromMap (const QString &tag)
 
void updateHeader ()
 
void resetTextBlocks ()
 
virtual TextBlockfindCodeClassFieldTextBlockByTag (const QString &tag)
 
- Protected Member Functions inherited from CodeGenObjectWithTextBlocks
void setAttributesFromObject (CodeGenObjectWithTextBlocks *obj)
 
virtual void loadChildTextBlocksFromNode (QDomElement &root)
 
- Protected Attributes inherited from CodeGenObjectWithTextBlocks
QMap< QString, TextBlock * > m_textBlockTagMap
 
TextBlockList m_textblockVector
 

Detailed Description

class CPPMakefileCodeDocument Represents

Constructor & Destructor Documentation

◆ CPPMakefileCodeDocument()

CPPMakefileCodeDocument::CPPMakefileCodeDocument ( )

Constructor

Here is the call graph for this function:

◆ ~CPPMakefileCodeDocument()

CPPMakefileCodeDocument::~CPPMakefileCodeDocument ( )
virtual

Empty Destructor

Member Function Documentation

◆ getPath()

QString CPPMakefileCodeDocument::getPath ( )
virtual

Get the value of the path to this code document.

Returns
the value of m_pathName

Reimplemented from CodeDocument.

Here is the call graph for this function:

◆ toString()

QString CPPMakefileCodeDocument::toString ( )
virtual
Returns
QString

Reimplemented from CodeDocument.

◆ updateContent()

void CPPMakefileCodeDocument::updateContent ( )
virtual

Update the content of this code document. This is where you should lay out your code document structure of textblocks in the inheriting class, should it have any text in it. Vanilla code documents don't have much to do.. override this with a different version for your own documents.

Reimplemented from CodeDocument.

Member Data Documentation

◆ DOCUMENT_ID_VALUE

const char * CPPMakefileCodeDocument::DOCUMENT_ID_VALUE = "Makefile_DOC"
static

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