textblock.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
 
    SPDX-FileCopyrightText: 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov>
    SPDX-FileCopyrightText: 2004-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef TEXTBLOCK_H
#define TEXTBLOCK_H
 
#include <QDomDocument>
#include <QDomElement>
#include <QObject>
#include <QXmlStreamWriter>
 
class CodeDocument;
class QXmlStreamWriter;
 
class TextBlock
{
    friend class CodeGenObjectWithTextBlocks;
    friend class ClassifierCodeDocument;
public:
 
    explicit TextBlock(CodeDocument * parent, const QString & text = QString());
    virtual ~TextBlock();
 
    void setText(const QString & text);
    QString getText() const;
    void appendText(const QString & text);
 
    void setTag(const QString & value);
    QString getTag() const;
 
    CodeDocument * getParentDocument() const;
 
    void setWriteOutText(bool write);
    bool getWriteOutText() const;
 
    void setIndentationLevel(int level);
    int getIndentationLevel() const;
 
    QString getIndentationString(int level = 0) const;
 
    static QString getIndentation();
 
    static QString getNewLineEndingChars();
 
    static QString formatMultiLineText(const QString & work, const QString & linePrefix,
                                  const QString & breakStr,
                                  bool addBreak = true, bool lastLineHasBreak = true);
 
    virtual QString unformatText(const QString & text, const QString & indent = QString());
 
    virtual QString toString() const;
 
    static QString encodeText(const QString & text, const QString & endLine);
    static QString decodeText(const QString & text, const QString & endLine);
 
    virtual void saveToXMI(QXmlStreamWriter& writer) = 0;
 
    virtual void loadFromXMI(QDomElement & root) = 0;
 
    bool canDelete() const;
 
    virtual void setAttributesFromObject(TextBlock * obj);
 
    virtual QString getNewEditorLine(int amount = 0);
 
    virtual int firstEditableLine();
    virtual int lastEditableLine();
 
    friend QDebug operator<<(QDebug os, const TextBlock& obj);
 
protected:
 
    void setCanDelete(bool canDelete);
 
    virtual void release();
 
    virtual void setAttributesOnNode(QXmlStreamWriter& writer);
    virtual void setAttributesFromNode(QDomElement & root);
 
private:
 
    QString m_text;   //< The actual text of this code block.
    QString m_tag;
    bool    m_canDelete;
    bool    m_writeOutText;   //< Flag to write the text of this TextBlock into a file.
    int     m_indentationLevel;
    CodeDocument * m_parentDocument;
 
};
 
#endif // TEXTBLOCK_H