• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

umbrello/umbrello

  • sources
  • kde-4.12
  • kdesdk
  • umbrello
  • umbrello
  • codegenerators
hierarchicalcodeblock.h
Go to the documentation of this file.
1 /***************************************************************************
2  * This program is free software; you can redistribute it and/or modify *
3  * it under the terms of the GNU General Public License as published by *
4  * the Free Software Foundation; either version 2 of the License, or *
5  * (at your option) any later version. *
6  * *
7  * copyright (C) 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov> *
8  * copyright (C) 2004-2013 *
9  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
10  ***************************************************************************/
11 
12 #ifndef HIERARCHICALCODEBLOCK_H
13 #define HIERARCHICALCODEBLOCK_H
14 
15 #include "codegenobjectwithtextblocks.h"
16 #include "codeblockwithcomments.h"
17 #include "codeclassfieldlist.h"
18 
19 #include <QMap>
20 #include <QString>
21 
22 class HierarchicalCodeBlock : public CodeBlockWithComments, public CodeGenObjectWithTextBlocks
23 {
24  friend class CodeGenObjectWithTextBlocks;
25 public:
26 
27  explicit HierarchicalCodeBlock (CodeDocument * doc, const QString &startString = "", const QString &endString = "", const QString &comment = "");
28 
32  virtual ~HierarchicalCodeBlock ();
33 
34  void setEndText (const QString &new_var);
35 
36  QString getEndText () const;
37 
38  bool addTextBlock (TextBlock * add_object);
39 
40  bool insertTextBlock (TextBlock * newBlock, TextBlock * existingBlock, bool after = true);
41 
42  bool removeTextBlock (TextBlock * remove_object);
43 
44  void setStartText (const QString &text);
45 
46  QString getStartText () const;
47 
48  virtual void saveToXMI (QDomDocument & doc, QDomElement & root);
49 
50  virtual void loadFromXMI (QDomElement & root);
51 
52  virtual QString toString () const;
53 
54  QString getUniqueTag();
55  QString getUniqueTag(const QString& prefix);
56 
57  void addCodeClassFieldMethods (CodeClassFieldList &list);
58 
59  virtual CodeBlock * newCodeBlock();
60  virtual CodeBlockWithComments * newCodeBlockWithComments();
61  virtual HierarchicalCodeBlock * newHierarchicalCodeBlock();
62 
63 protected:
64 
65  virtual void release ();
66 
67  virtual void setAttributesOnNode (QDomDocument & doc, QDomElement & elem);
68 
69  virtual void setAttributesFromNode (QDomElement & element);
70 
71  virtual void setAttributesFromObject (TextBlock * obj);
72 
73  TextBlock * findCodeClassFieldTextBlockByTag (const QString &tag);
74 
75 private:
76 
77  QString m_startText;
78  QString m_endText;
79 
80  QString childTextBlocksToString() const;
81  void initAttributes () ;
82 
83 };
84 
85 #endif // HIERARCHICALCODEBLOCK_H
HierarchicalCodeBlock::newCodeBlockWithComments
virtual CodeBlockWithComments * newCodeBlockWithComments()
Definition: hierarchicalcodeblock.cpp:78
HierarchicalCodeBlock::release
virtual void release()
causes the text block to release all of its connections and any other text blocks that it 'owns'...
Definition: hierarchicalcodeblock.cpp:386
CodeBlock
A "chunk" of code within the code document.
Definition: codeblock.h:20
HierarchicalCodeBlock::~HierarchicalCodeBlock
virtual ~HierarchicalCodeBlock()
Empty Destructor.
Definition: hierarchicalcodeblock.cpp:35
HierarchicalCodeBlock::newCodeBlock
virtual CodeBlock * newCodeBlock()
Virtual methods that return a new code document objects.
Definition: hierarchicalcodeblock.cpp:73
HierarchicalCodeBlock::setEndText
void setEndText(const QString &new_var)
Set the value of m_endText.
Definition: hierarchicalcodeblock.cpp:43
HierarchicalCodeBlock::getUniqueTag
QString getUniqueTag()
return a unique, and currently unallocated, text block tag for this hblock
Definition: hierarchicalcodeblock.cpp:60
codeclassfieldlist.h
HierarchicalCodeBlock::addCodeClassFieldMethods
void addCodeClassFieldMethods(CodeClassFieldList &list)
Utility method to add accessormethods in this object.
Definition: hierarchicalcodeblock.cpp:215
HierarchicalCodeBlock::removeTextBlock
bool removeTextBlock(TextBlock *remove_object)
Remove a TextBlock object from m_textblockVector List returns boolean - true if successful.
Definition: hierarchicalcodeblock.cpp:169
HierarchicalCodeBlock::insertTextBlock
bool insertTextBlock(TextBlock *newBlock, TextBlock *existingBlock, bool after=true)
Insert a new text block before/after the existing text block.
Definition: hierarchicalcodeblock.cpp:107
CodeBlockWithComments
class CodeBlockWithComments A very common type of text block in any type of code. ...
Definition: codeblockwithcomments.h:24
HierarchicalCodeBlock::setAttributesFromObject
virtual void setAttributesFromObject(TextBlock *obj)
set the class attributes from a passed object
Definition: hierarchicalcodeblock.cpp:297
HierarchicalCodeBlock::saveToXMI
virtual void saveToXMI(QDomDocument &doc, QDomElement &root)
Save the XMI representation of this object.
Definition: hierarchicalcodeblock.cpp:240
HierarchicalCodeBlock::getEndText
QString getEndText() const
Get the value of m_endText.
Definition: hierarchicalcodeblock.cpp:52
HierarchicalCodeBlock::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
load params from the appropriate XMI element node.
Definition: hierarchicalcodeblock.cpp:269
CodeDocument
A document containing the code for one file.
Definition: codedocument.h:32
HierarchicalCodeBlock::addTextBlock
bool addTextBlock(TextBlock *add_object)
Add a TextBlock object to the m_textblockVector List.
Definition: hierarchicalcodeblock.cpp:93
codeblockwithcomments.h
codegenobjectwithtextblocks.h
CodeGenObjectWithTextBlocks
This abstract class is for code generator objects which 'own' text blocks.
Definition: codegenobjectwithtextblocks.h:31
HierarchicalCodeBlock::setStartText
void setStartText(const QString &text)
Definition: hierarchicalcodeblock.cpp:199
HierarchicalCodeBlock
Definition: hierarchicalcodeblock.h:22
TextBlock
The fundemental unit of text within an output file containing code.
Definition: textblock.h:24
HierarchicalCodeBlock::HierarchicalCodeBlock
HierarchicalCodeBlock(CodeDocument *doc, const QString &startString="", const QString &endString="", const QString &comment="")
Constructor.
Definition: hierarchicalcodeblock.cpp:27
HierarchicalCodeBlock::findCodeClassFieldTextBlockByTag
TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag)
look for specific text blocks which belong to code classfields
Definition: hierarchicalcodeblock.cpp:362
HierarchicalCodeBlock::toString
virtual QString toString() const
Definition: hierarchicalcodeblock.cpp:313
HierarchicalCodeBlock::newHierarchicalCodeBlock
virtual HierarchicalCodeBlock * newHierarchicalCodeBlock()
Definition: hierarchicalcodeblock.cpp:83
HierarchicalCodeBlock::getStartText
QString getStartText() const
Definition: hierarchicalcodeblock.cpp:207
CodeClassFieldList
QList< CodeClassField * > CodeClassFieldList
Definition: codeclassfieldlist.h:17
HierarchicalCodeBlock::setAttributesOnNode
virtual void setAttributesOnNode(QDomDocument &doc, QDomElement &elem)
set attributes of the node that represents this class in the XMI document.
Definition: hierarchicalcodeblock.cpp:251
HierarchicalCodeBlock::setAttributesFromNode
virtual void setAttributesFromNode(QDomElement &element)
set the class attributes of this object from the passed element node.
Definition: hierarchicalcodeblock.cpp:278
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:05:59 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

umbrello/umbrello

Skip menu "umbrello/umbrello"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal