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

codegenerationpolicy.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   : Fri Jun 20 2003
 */



#ifndef CODEGENERATIONPOLICY_H
#define CODEGENERATIONPOLICY_H

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

class QWidget;
class KConfig;
class CodeGenerationPolicyPage;

class CodeGenerationPolicy : public QObject {
    Q_OBJECT
public:

    enum OverwritePolicy {Ok=0, Ask, Never, Cancel};
    enum ModifyNamePolicy {No=0, Underscore, Capitalise};
    enum NewLineType {UNIX=0, DOS, MAC};
    enum IndentationType {NONE=0, TAB, SPACE};
    enum CommentStyle { SingleLine=0, MultiLine };
    enum ScopePolicy { Public=200, Private, Protected, FromParent };

    // set some reasonable defaults
    OverwritePolicy  defaultOverwritePolicy()          const;
    bool             defaultVerboseSectionComments()   const;
    bool             defaultVerboseDocumentComments()  const;
    bool             defaultIncludeHeadings()          const;
    NewLineType      defaultLineEndingType()           const;
    IndentationType  defaultIndentType()               const;
    int              defaultIndentAmount()             const;
    ModifyNamePolicy defaultModifyNamePolicy()         const;
    CommentStyle     defaultCommentStyle()             const;
    ScopePolicy      defaultAttribAccessorScope()      const;
    ScopePolicy      defaultAssocFieldScope()          const;
    bool             defaultAutoGenerateConstructors() const;

    // Constructors/Destructors
    //

    // note that as the code gen policy may be the 'default' policy, it may
    // not be coupled with a code generator.
    CodeGenerationPolicy (CodeGenerationPolicy * clone = 0);
    CodeGenerationPolicy (KConfig * config );

    virtual ~CodeGenerationPolicy ( );

    // Public attributes
    //

    // Public attribute accessor methods
    //

    void setOverwritePolicy ( OverwritePolicy new_var );

    OverwritePolicy getOverwritePolicy ( ) const;


    void setCodeVerboseSectionComments ( bool new_var );

    bool getCodeVerboseSectionComments ( ) const;


    void setCodeVerboseDocumentComments ( bool new_var );

    bool getCodeVerboseDocumentComments ( ) const;

    void setHeadingFileDir ( const QString & path);

    QString getHeadingFileDir ( ) const;


    void setIncludeHeadings ( bool new_var );

    bool getIncludeHeadings ( ) const;


    void setOutputDirectory ( QDir new_var );

    QDir getOutputDirectory ( );

    void setLineEndingType ( NewLineType new_var );

    NewLineType getLineEndingType ( );

    QString getNewLineEndingChars ( ) const;

    void  setIndentationType ( IndentationType type );

    IndentationType getIndentationType ( );

    void  setIndentationAmount ( int amount );
    int getIndentationAmount ( );

    QString getIndentation ( ) const;

    void setModifyPolicy ( ModifyNamePolicy new_var );

    ModifyNamePolicy getModifyPolicy ( ) const;

    void setAutoGenerateConstructors ( bool var );

    bool getAutoGenerateConstructors ( );

    void setAttributeAccessorScope(ScopePolicy var);

    ScopePolicy getAttributeAccessorScope();

    void setAssociationFieldScope(ScopePolicy var);

    ScopePolicy getAssociationFieldScope();

    virtual CodeGenerationPolicyPage * createPage ( QWidget *parent = 0, const char * name = 0);

    QString getHeadingFile(QString str);

    virtual void setDefaults (CodeGenerationPolicy * defaults, bool emitUpdateSignal = true);

    virtual void setDefaults(KConfig * config, bool emitUpdateSignal = true);

    virtual void writeConfig (KConfig * config);

    void emitModifiedCodeContentSig();

    void setCommentStyle ( CommentStyle new_var );

    CommentStyle getCommentStyle ( );

signals:

    // this signal is sent whenever a change is made to the policy
    // which could modifiy code document content
    void modifiedCodeContent();

protected:

    // Policy of how to deal with overwriting existing files. Allowed values are "ask", "yes" and "no".
    OverwritePolicy m_overwritePolicy;

    // Whether or not verbose code commenting for sections is desired.
    // If true, comments for sections will be written even if the section is empty.
    bool m_codeVerboseSectionComments;

    // Whether or not verbose code commenting for documentation is desired.
    // If true, documentation for various code will be written even if no
    //code would normally be created at that point in the file.
    bool m_codeVerboseDocumentComments;

    QDir m_headingFiles; // location of the header file template.
    bool m_includeHeadings;
    QDir m_outputDirectory; // location of where output files will go.
    NewLineType m_lineEndingType; // What type of line ending characters to use.
    IndentationType m_indentationType; // The amount and type of whitespace to indent with.
    int m_indentationAmount; // The amount of units to indent with.
    ModifyNamePolicy m_modifyPolicy;
    bool m_autoGenerateConstructors;
    CommentStyle m_commentStyle;
    ScopePolicy m_attributeAccessorScope;
    ScopePolicy m_associationFieldScope;

    // these 2 private fields 'cache' the string values of other fields we may frequently call for
    QString m_lineEndingChars;
    QString m_indentation;

    void calculateIndentation ( );

protected:

    void initFields ( );

};

#endif // CODEGENERATIONPOLICY_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:07:55 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003