
/***************************************************************************
 *                                                                         *
 *   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   : Mon Sep 1 2003
 */



#ifndef CPPCODEDOCUMENTATION_H
#define CPPCODEDOCUMENTATION_H

#include <qstring.h>
#include "../codecomment.h"

class CodeDocument; 

/**
  * class CPPCodeDocumentation
  * A CPP code comment. There is only a single styles of comments: 
  * these are simply started with double slash sequence and no terminating
  * characters
  */

class CPPCodeDocumentation : virtual public CodeComment
{
	Q_OBJECT
public:

	// Constructors/Destructors
	//  


	/**
	 * Constructors
	 */
	CPPCodeDocumentation ( CodeDocument * doc, const QString & text = "");

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

	// Public attributes
	//  

	// Other
	//  

        /**
         * Save the XMI representation of this object
         * @return      bool    status of save
         */
        virtual bool saveToXMI ( QDomDocument & doc, QDomElement & root );

	/**
	 * @return	QString
	 */
	QString toString ( );


       /** UnFormat a long text string. Typically, this means removing
         *  the indentaion (linePrefix) and/or newline chars from each line.
         */
        virtual QString unformatText ( const QString & text, const QString & indent = "" );

        /** a special version here because we want to not only indent
         * the new line, but to add the " * " sequence as well.
         */
        virtual QString getNewEditorLine ( int amount );

        /** Ush. These are terrifically bad and must one day go away.
         * Both methods indicate the range of lines in this textblock
         * which may be edited by the codeeditor (assuming that any are
         * actually editable). The default case is no lines are editable.
         * The line numbering starts with '0' and a '-1' means no line
         * qualifies.
         */
        virtual int firstEditableLine();
        virtual int lastEditableLine();

protected:

private:

};

#endif // CPPCODEDOCUMENTATION_H
