summaryrefslogtreecommitdiffstats
path: root/umbrello/umbrello/codeblockwithcomments.h
blob: 3b5d3f66859dc012717d350fa853f79e70840d49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

/*  This code generated by:
 *      Author : thomas
 *      Date   : Wed Jun 18 2003
 */



#ifndef CODEBLOCKWITHCOMMENTS_H
#define CODEBLOCKWITHCOMMENTS_H


#include "codeblock.h"
#include "codecomment.h"

class HierarchicalCodeBlock;

/**
  * class CodeBlockWithComments
  * A very common type of text block in any type of code.
  */

class CodeBlockWithComments : public CodeBlock
{
    Q_OBJECT
  TQ_OBJECT
public:

    // Constructors/Destructors
    //


    /**
     * Basic Constructor
     */
    explicit CodeBlockWithComments ( CodeDocument * doc , const TQString & body = "", const TQString & comment = "");
    explicit CodeBlockWithComments ( HierarchicalCodeBlock * hblock, const TQString & body = "", const TQString & comment = "" );

    /**
     * Empty Destructor
     */
    virtual ~CodeBlockWithComments ( );


    /**
     * Set the Comment object
     */
    void setComment ( CodeComment * object );

    /**
     * Get the Comment object
     */
    CodeComment * getComment ( );

    /**
     * @return  TQString
     */
    virtual TQString toString ( );

    /** A utility method that causes the comment and body of the code block
     * to have the same indentation level.
     */
    void setOverallIndentationLevel ( int level );

    /**
     * Save the XMI representation of this object
     */
    virtual void saveToXMI ( TQDomDocument & doc, TQDomElement & root );

    /**
     * load params from the appropriate XMI element node.
     */
    virtual void loadFromXMI ( TQDomElement & root );

    /** set the class attributes from a passed object
     */
    virtual void setAttributesFromObject (TextBlock * obj);

protected:

    /** set attributes of the node that represents this class
     * in the XMI document.
     */
    virtual void setAttributesOnNode (TQDomDocument & doc, TQDomElement & blockElement);

    /** set the class attributes of this object from
    * the passed element node.
    */
    virtual void setAttributesFromNode ( TQDomElement & element);

private:

    CodeComment * m_comment;

    void initFields(CodeDocument *parent, const TQString& comment);

};

#endif // CODEBLOCKWITHCOMMENTS_H