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

textblock.h

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   copyright (C) 2004-2006                                               *
 *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
 ***************************************************************************/

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



#ifndef TEXTBLOCK_H
#define TEXTBLOCK_H

#include <qdom.h>
#include <qobject.h>

class CodeDocument;

class TextBlock : virtual public QObject {
    friend class CodeGenObjectWithTextBlocks;
    friend class ClassifierCodeDocument;
    Q_OBJECT
public:

    // Constructors/Destructors
    //

    explicit TextBlock ( CodeDocument * parent, const QString & text = "");

    // destructor
    ~TextBlock ( );

    // Public attributes
    //

    // Public attribute accessor methods
    //

    void setText ( const QString &new_var );

    void appendText ( const QString &new_text );

    QString getText ( ) const;

    QString getTag( ) const;

    void setTag( const QString &value );

    CodeDocument * getParentDocument ( );

    void setWriteOutText ( bool new_var );

    bool getWriteOutText ( );

    void setIndentationLevel ( int level );

    int getIndentationLevel ( );

    QString getIndentationString ( int level = 0);

    QString getIndentation();

    QString getNewLineEndingChars ( );

    // should be static
    QString formatMultiLineText ( const QString &text, const QString &linePrefix,
                                  const QString& breakStr,
                                  bool alwaysAddBreak = true, bool lastLineHasBreak = true);

    virtual QString unformatText ( const QString & text, const QString & indent = "");

    virtual QString toString ( );

    static QString encodeText(const QString& text , const QString &endChars);


    static QString decodeText(const QString& text, const QString &endChars);

    virtual void saveToXMI ( QDomDocument & doc, QDomElement & root ) = 0;

    virtual void loadFromXMI ( QDomElement & root ) = 0;

    bool canDelete ();

    virtual void setAttributesFromObject (TextBlock * obj);

    virtual QString getNewEditorLine( int indentAmount = 0 );

    virtual int firstEditableLine();
    virtual int lastEditableLine();

protected:

    virtual     void release ();

    void setParentDocument ( CodeDocument * new_var );

    virtual void setAttributesOnNode ( QDomDocument & doc, QDomElement & blockElement);

    virtual void setAttributesFromNode ( QDomElement & element);

    bool m_canDelete;

private:

    // The actual text of this code block.
    QString m_text;
    QString m_tag;

    // Whether or not to include the text of this TextBlock into a file.
    bool m_writeOutText;

    int m_indentationLevel;
    CodeDocument * m_parentDocument;

    void initFields ( CodeDocument * doc);

};

#endif // TEXTBLOCK_H

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:00 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003