• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

umbrello/umbrello

  • sources
  • kde-4.12
  • kdesdk
  • umbrello
  • umbrello
  • codegenerators
codegenerationpolicy.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  * This program is free software; you can redistribute it and/or modify *
3  * it under the terms of the GNU General Public License as published by *
4  * the Free Software Foundation; either version 2 of the License, or *
5  * (at your option) any later version. *
6  * *
7  * copyright (C) 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov> *
8  * copyright (C) 2003-2013 *
9  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
10  ***************************************************************************/
11 
12 // own header
13 #include "codegenerationpolicy.h"
14 
15 // app includes
16 #include "codegenerationpolicypage.h"
17 #include "debug_utils.h"
18 #include "uml.h"
19 #include "umldoc.h"
20 #include "umbrellosettings.h"
21 
22 // kde includes
23 #include <kconfig.h>
24 #include <kstandarddirs.h>
25 
26 // qt includes
27 #include <QDateTime>
28 #include <QRegExp>
29 #include <QStringList>
30 #include <QTextStream>
31 
32 using namespace std;
33 
34 #define MAXLINES 256
35 
40 CodeGenerationPolicy::CodeGenerationPolicy(CodeGenerationPolicy * clone)
41 {
42  // first call the function which can give us values from disk, so that we have something to fall back on
43  setDefaults(false);
44  // then set the values from the object passed.
45  setDefaults(clone, false);
46 }
47 
51 CodeGenerationPolicy::CodeGenerationPolicy()
52 {
53  setDefaults(false);
54 }
55 
59 CodeGenerationPolicy::~CodeGenerationPolicy()
60 {
61 }
62 
69 void CodeGenerationPolicy::setOverwritePolicy (OverwritePolicy new_var)
70 {
71  Settings::optionState().codeGenerationState.overwritePolicy = new_var;
72 }
73 
80 CodeGenerationPolicy::OverwritePolicy CodeGenerationPolicy::getOverwritePolicy () const
81 {
82  return Settings::optionState().codeGenerationState.overwritePolicy;
83 }
84 
89 void CodeGenerationPolicy::setCommentStyle (CommentStyle new_var)
90 {
91  Settings::optionState().codeGenerationState.commentStyle = new_var;
92  emit modifiedCodeContent();
93 }
94 
99 CodeGenerationPolicy::CommentStyle CodeGenerationPolicy::getCommentStyle()
100 {
101  return Settings::optionState().codeGenerationState.commentStyle;
102 }
103 
110 void CodeGenerationPolicy::setCodeVerboseSectionComments (bool new_var)
111 {
112  Settings::optionState().codeGenerationState.forceSections = new_var;
113  emit modifiedCodeContent();
114 }
115 
122 bool CodeGenerationPolicy::getCodeVerboseSectionComments () const
123 {
124  return Settings::optionState().codeGenerationState.forceSections;
125 }
126 
134 void CodeGenerationPolicy::setCodeVerboseDocumentComments (bool new_var)
135 {
136  Settings::optionState().codeGenerationState.forceDoc = new_var;
137  emit modifiedCodeContent();
138 }
139 
147 bool CodeGenerationPolicy::getCodeVerboseDocumentComments () const
148 {
149  return Settings::optionState().codeGenerationState.forceDoc;
150 }
151 
157 void CodeGenerationPolicy::setHeadingFileDir (const QString & path)
158 {
159  Settings::optionState().codeGenerationState.headingsDirectory.setPath(path);
160 }
161 
167 QString CodeGenerationPolicy::getHeadingFileDir () const
168 {
169  return Settings::optionState().codeGenerationState.headingsDirectory.absolutePath();
170 }
171 
176 void CodeGenerationPolicy::setIncludeHeadings (bool new_var)
177 {
178  Settings::optionState().codeGenerationState.includeHeadings = new_var;
179  emit modifiedCodeContent();
180 }
181 
186 bool CodeGenerationPolicy::getIncludeHeadings () const
187 {
188  return Settings::optionState().codeGenerationState.includeHeadings;
189 }
190 
196 void CodeGenerationPolicy::setOutputDirectory (QDir new_var)
197 {
198  Settings::optionState().codeGenerationState.outputDirectory = new_var;
199 }
200 
206 QDir CodeGenerationPolicy::getOutputDirectory ()
207 {
208  return Settings::optionState().codeGenerationState.outputDirectory;
209 }
210 
216 void CodeGenerationPolicy::setLineEndingType (NewLineType type)
217 {
218  Settings::optionState().codeGenerationState.lineEndingType = type;
219  switch (Settings::optionState().codeGenerationState.lineEndingType) {
220  case MAC:
221  m_lineEndingChars = QString("\r\n");
222  break;
223  case DOS:
224  m_lineEndingChars = QString("\r");
225  break;
226  case UNIX:
227  default:
228  m_lineEndingChars = QString("\n");
229  break;
230  }
231  emit modifiedCodeContent();
232 }
233 
239 CodeGenerationPolicy::NewLineType CodeGenerationPolicy::getLineEndingType ()
240 {
241  return Settings::optionState().codeGenerationState.lineEndingType;
242 }
243 
248 QString CodeGenerationPolicy::getNewLineEndingChars () const
249 {
250  return m_lineEndingChars;
251 }
252 
258 void CodeGenerationPolicy::setIndentationType (IndentationType new_var)
259 {
260  Settings::optionState().codeGenerationState.indentationType = new_var;
261  calculateIndentation();
262  emit modifiedCodeContent();
263 }
264 
268 CodeGenerationPolicy::IndentationType CodeGenerationPolicy::getIndentationType ()
269 {
270  return Settings::optionState().codeGenerationState.indentationType;
271 }
272 
277 void CodeGenerationPolicy::setIndentationAmount (int amount)
278 {
279  if (amount > -1)
280  {
281  Settings::optionState().codeGenerationState.indentationAmount = amount;
282  calculateIndentation();
283  emit modifiedCodeContent();
284  }
285 }
286 
290 int CodeGenerationPolicy::getIndentationAmount ()
291 {
292  return Settings::optionState().codeGenerationState.indentationAmount;
293 }
294 
299 QString CodeGenerationPolicy::getIndentation () const
300 {
301  return m_indentation;
302 }
303 
307 void CodeGenerationPolicy::calculateIndentation ()
308 {
309  QString indent;
310  m_indentation.clear();
311  switch (Settings::optionState().codeGenerationState.indentationType) {
312  case NONE:
313  break;
314  case TAB:
315  indent = QString("\t");
316  break;
317  default:
318  case SPACE:
319  indent = QString(" ");
320  break;
321  }
322 
323  if (Settings::optionState().codeGenerationState.indentationAmount > 999) { //:TODO: fix this - no initialization
324  uDebug() << "too big indentation amount = " << Settings::optionState().codeGenerationState.indentationAmount;
325  }
326  else {
327  for (int i = 0; i < Settings::optionState().codeGenerationState.indentationAmount; ++i) {
328  m_indentation += indent;
329  }
330  }
331 }
332 
337 void CodeGenerationPolicy::setModifyPolicy (ModifyNamePolicy new_var)
338 {
339  Settings::optionState().codeGenerationState.modnamePolicy = new_var;
340 }
341 
346 CodeGenerationPolicy::ModifyNamePolicy CodeGenerationPolicy::getModifyPolicy () const
347 {
348  return Settings::optionState().codeGenerationState.modnamePolicy;
349 }
350 
355 void CodeGenerationPolicy::setAutoGenerateConstructors(bool var)
356 {
357  Settings::optionState().codeGenerationState.autoGenEmptyConstructors = var;
358  emit modifiedCodeContent();
359 }
360 
365 bool CodeGenerationPolicy::getAutoGenerateConstructors()
366 {
367  return Settings::optionState().codeGenerationState.autoGenEmptyConstructors;
368 }
369 
374 void CodeGenerationPolicy::setAttributeAccessorScope(Uml::Visibility::Enum var)
375 {
376  Settings::optionState().codeGenerationState.defaultAttributeAccessorScope = var;
377  emit modifiedCodeContent();
378 }
379 
384 Uml::Visibility::Enum CodeGenerationPolicy::getAttributeAccessorScope()
385 {
386  return Settings::optionState().codeGenerationState.defaultAttributeAccessorScope;
387 }
388 
393 void CodeGenerationPolicy::setAssociationFieldScope(Uml::Visibility::Enum var)
394 {
395  Settings::optionState().codeGenerationState.defaultAssocFieldScope = var;
396  emit modifiedCodeContent();
397 }
398 
403 Uml::Visibility::Enum CodeGenerationPolicy::getAssociationFieldScope()
404 {
405  return Settings::optionState().codeGenerationState.defaultAssocFieldScope;
406 }
407 
412 CodeGenerationPolicyPage * CodeGenerationPolicy::createPage (QWidget *pWidget, const char *name)
413 {
414  return new CodeGenerationPolicyPage (pWidget, name, 0);
415 }
416 
420 void CodeGenerationPolicy::emitModifiedCodeContentSig()
421 {
422  if (!UMLApp::app()->document()->loading())
423  emit modifiedCodeContent();
424 }
425 
429 void CodeGenerationPolicy::setDefaults (CodeGenerationPolicy * clone, bool emitUpdateSignal)
430 {
431  if (!clone)
432  return;
433 
434  blockSignals(true); // we need to do this because otherwise most of these
435  // settors below will each send the modifiedCodeContent() signal
436  // needlessly (we can just make one call at the end).
437 
438  setCodeVerboseSectionComments (clone->getCodeVerboseSectionComments());
439  setCodeVerboseDocumentComments (clone->getCodeVerboseDocumentComments());
440  setHeadingFileDir (clone->getHeadingFileDir());
441  setIncludeHeadings (clone->getIncludeHeadings());
442  setOutputDirectory (clone->getOutputDirectory());
443  setLineEndingType (clone->getLineEndingType());
444  setIndentationAmount (clone->getIndentationAmount());
445  setIndentationType (clone->getIndentationType());
446  setModifyPolicy (clone->getModifyPolicy());
447  setOverwritePolicy (clone->getOverwritePolicy());
448 
449  calculateIndentation();
450  blockSignals(false); // "as you were citizen"
451 
452  if (emitUpdateSignal)
453  emit modifiedCodeContent();
454 }
455 
459 void CodeGenerationPolicy::setDefaults(bool emitUpdateSignal)
460 {
461  blockSignals(true); // we need to do this because otherwise most of these
462  // settors below will each send the modifiedCodeContent() signal
463  // needlessly (we can just make one call at the end).
464 
465  setCodeVerboseSectionComments(UmbrelloSettings::forceDoc());
466  setCodeVerboseDocumentComments(UmbrelloSettings::forceSections());
467  setLineEndingType(UmbrelloSettings::lineEndingType());
468  setIndentationType(UmbrelloSettings::indentationType());
469  setIndentationAmount(UmbrelloSettings::indentationAmount());
470  setAutoGenerateConstructors(UmbrelloSettings::autoGenEmptyConstructors());
471  setAttributeAccessorScope(UmbrelloSettings::defaultAttributeAccessorScope());
472  setAssociationFieldScope(UmbrelloSettings::defaultAssocFieldScope());
473  setCommentStyle(UmbrelloSettings::commentStyle());
474 
475  calculateIndentation();
476 
477  QString path = UmbrelloSettings::outputDirectory();
478  if (path.isEmpty())
479  path = QDir::homePath() + "/uml-generated-code/";
480  setOutputDirectory (QDir (path));
481 
482  path = UmbrelloSettings::headingsDirectory();
483  if (path.isEmpty()) {
484  KStandardDirs stddirs;
485  path = stddirs.findDirs("data","umbrello/headings").first();
486  }
487  setHeadingFileDir (path);
488 
489  setIncludeHeadings(UmbrelloSettings::includeHeadings());
490  setOverwritePolicy(UmbrelloSettings::overwritePolicy());
491  setModifyPolicy(UmbrelloSettings::modnamePolicy());
492 
493  blockSignals(false); // "as you were citizen"
494 
495  if (emitUpdateSignal)
496  emit modifiedCodeContent();
497 }
498 
502 void CodeGenerationPolicy::writeConfig ()
503 {
504  UmbrelloSettings::setDefaultAttributeAccessorScope(getAttributeAccessorScope());
505  UmbrelloSettings::setDefaultAssocFieldScope(getAssociationFieldScope());
506  UmbrelloSettings::setCommentStyle(getCommentStyle());
507  UmbrelloSettings::setAutoGenEmptyConstructors(getAutoGenerateConstructors());
508  //UmbrelloSettings::setNewcodegen(getNewCodegen());
509  UmbrelloSettings::setForceDoc(getCodeVerboseDocumentComments());
510  UmbrelloSettings::setForceSections(getCodeVerboseSectionComments());
511 
512  UmbrelloSettings::setLineEndingType(getLineEndingType());
513  UmbrelloSettings::setIndentationType(getIndentationType());
514  UmbrelloSettings::setIndentationAmount(getIndentationAmount());
515 
516  UmbrelloSettings::setOutputDirectory(getOutputDirectory().absolutePath());
517  UmbrelloSettings::setHeadingsDirectory(getHeadingFileDir());
518  UmbrelloSettings::setIncludeHeadings(getIncludeHeadings());
519  UmbrelloSettings::setOverwritePolicy(getOverwritePolicy());
520  UmbrelloSettings::setModnamePolicy(getModifyPolicy());
521 
522  // this will be written to the disk from the place it was called :)
523 }
524 
540 QString CodeGenerationPolicy::getHeadingFile(const QString& str)
541 {
542  if (!getIncludeHeadings() || str.isEmpty())
543  return QString();
544  if (str.contains(" ") || str.contains(";")) {
545  uWarning() << "File folder must not have spaces or semi colons!";
546  return QString();
547  }
548  //if we only get the extension, then we look for the default
549  // heading.[extension]. If there is no such file, we try to
550  // get any file with the same extension
551  QString filename;
552  QDir headingFiles = Settings::optionState().codeGenerationState.headingsDirectory;
553  if (str.startsWith('.')) {
554  if (QFile::exists(headingFiles.absoluteFilePath("heading"+str)))
555  filename = headingFiles.absoluteFilePath("heading"+str);
556  else {
557  QStringList filters;
558  filters << '*' + str;
559  headingFiles.setNameFilters(filters);
560  //if there is more than one match we just take the first one
561  QStringList fileList = headingFiles.entryList();
562  if (!fileList.isEmpty())
563  filename = headingFiles.absoluteFilePath(fileList.first());
564  // uWarning() << "header file name set to " << filename << " because it was *";
565  }
566  } else { //we got a file name (not only extension)
567  filename = headingFiles.absoluteFilePath(str);
568  }
569 
570  if (filename.isEmpty())
571  return QString();
572  QFile f(filename);
573  if (!f.open(QIODevice::ReadOnly)) {
574  // uWarning() << "Error opening heading file: " << f.name();
575  // uWarning() << "Headings directory was " << headingFiles.absolutePath();
576  return QString();
577  }
578 
579  QTextStream ts(&f);
580  QString retstr;
581  QString endLine = getNewLineEndingChars();
582  for (int l = 0; l < MAXLINES && !ts.atEnd(); ++l) {
583  retstr += ts.readLine()+endLine;
584  }
585 
586  //do variable substitution
587  retstr.replace(QRegExp("%author%"), QString(qgetenv("USER"))); //get the user name from some where else
588  retstr.replace(QRegExp("%headingpath%"), filename);
589  retstr.replace(QRegExp("%time%"), QTime::currentTime().toString());
590  retstr.replace(QRegExp("%date%"), QDate::currentDate().toString());
591  // the replace filepath, time parts are also in the code document updateHeader method
592  // (which is not a virtual function)...
593 
594  return retstr;
595 }
596 
597 #include "codegenerationpolicy.moc"
CodeGenerationPolicy::setIncludeHeadings
void setIncludeHeadings(bool new_var)
Set the value of m_includeHeadings.
Definition: codegenerationpolicy.cpp:176
UmbrelloSettings::setIncludeHeadings
static void setIncludeHeadings(bool v)
Set Include headings.
Definition: umbrellosettings.h:1126
Settings::CodeGenerationState::forceDoc
bool forceDoc
Definition: optionstate.h:80
Settings::CodeGenerationState::includeHeadings
bool includeHeadings
Definition: optionstate.h:83
CodeGenerationPolicy::setLineEndingType
void setLineEndingType(NewLineType type)
Set the value of m_lineEndingType What line ending characters to use.
Definition: codegenerationpolicy.cpp:216
Settings::CodeGenerationState::forceSections
bool forceSections
Definition: optionstate.h:81
UmbrelloSettings::setDefaultAssocFieldScope
static void setDefaultAssocFieldScope(Uml::Visibility::Enum v)
Set Default Association Field Scope.
Definition: umbrellosettings.h:1031
Settings::CodeGenerationState::commentStyle
CodeGenerationPolicy::CommentStyle commentStyle
Definition: optionstate.h:77
UmbrelloSettings::forceDoc
static bool forceDoc()
Get Force Documentation.
Definition: umbrellosettings.h:1079
Settings::optionState
OptionState & optionState()
Definition: optionstate.cpp:25
CodeGenerationPolicy::setAutoGenerateConstructors
void setAutoGenerateConstructors(bool var)
Set the value of m_autoGenerateConstructors.
Definition: codegenerationpolicy.cpp:355
Settings::CodeGenerationState::defaultAttributeAccessorScope
Uml::Visibility::Enum defaultAttributeAccessorScope
Definition: optionstate.h:79
Uml::Visibility::Enum
Enum
Definition: basictypes.h:56
umbrellosettings.h
CodeGenerationPolicy::emitModifiedCodeContentSig
void emitModifiedCodeContentSig()
Emits the signal 'ModifiedCodeContent'.
Definition: codegenerationpolicy.cpp:420
CodeGenerationPolicy::setOutputDirectory
void setOutputDirectory(QDir new_var)
Set the value of m_outputDirectory location of where output files will go.
Definition: codegenerationpolicy.cpp:196
CodeGenerationPolicy::getNewLineEndingChars
QString getNewLineEndingChars() const
Utility function to get the actual characters.
Definition: codegenerationpolicy.cpp:248
UmbrelloSettings::includeHeadings
static bool includeHeadings()
Get Include headings.
Definition: umbrellosettings.h:1136
CodeGenerationPolicy::calculateIndentation
void calculateIndentation()
Calculate the indentation.
Definition: codegenerationpolicy.cpp:307
QWidget
UMLApp::app
static UMLApp * app()
Get the last created instance of this class.
Definition: uml.cpp:206
CodeGenerationPolicy::getIndentationAmount
int getIndentationAmount()
Get indentation level units.
Definition: codegenerationpolicy.cpp:290
CodeGenerationPolicy
class CodeGenerationPolicy This class describes the code generation policy for this project...
Definition: codegenerationpolicy.h:29
CodeGenerationPolicy::setCodeVerboseDocumentComments
void setCodeVerboseDocumentComments(bool new_var)
Set the value of m_codeVerboseDocumentComments Whether or not verbose code commenting for documentati...
Definition: codegenerationpolicy.cpp:134
CodeGenerationPolicy::setAssociationFieldScope
void setAssociationFieldScope(Uml::Visibility::Enum var)
Set the value of m_associationFieldScope.
Definition: codegenerationpolicy.cpp:393
CodeGenerationPolicy::getModifyPolicy
ModifyNamePolicy getModifyPolicy() const
Get the value of m_modifyPolicy.
Definition: codegenerationpolicy.cpp:346
CodeGenerationPolicy::setDefaults
virtual void setDefaults(CodeGenerationPolicy *defaults, bool emitUpdateSignal=true)
set the defaults from a config file
Definition: codegenerationpolicy.cpp:429
UmbrelloSettings::defaultAttributeAccessorScope
static Uml::Visibility::Enum defaultAttributeAccessorScope()
Get Default Attribute Accessor Scope.
Definition: umbrellosettings.h:1060
UmbrelloSettings::setForceDoc
static void setForceDoc(bool v)
Set Force Documentation.
Definition: umbrellosettings.h:1069
uWarning
#define uWarning()
Definition: debug_utils.h:97
UmbrelloSettings::setLineEndingType
static void setLineEndingType(CodeGenerationPolicy::NewLineType v)
Set Line Ending Type.
Definition: umbrellosettings.h:1190
debug_utils.h
codegenerationpolicy.h
UmbrelloSettings::commentStyle
static CodeGenerationPolicy::CommentStyle commentStyle()
Get Comment Style.
Definition: umbrellosettings.h:1022
CodeGenerationPolicy::CommentStyle
CommentStyle
Definition: codegenerationpolicy.h:50
CodeGenerationPolicy::getOutputDirectory
QDir getOutputDirectory()
Get the value of m_outputDirectory location of where output files will go.
Definition: codegenerationpolicy.cpp:206
Settings::CodeGenerationState::indentationType
CodeGenerationPolicy::IndentationType indentationType
Definition: optionstate.h:85
CodeGenerationPolicy::getCodeVerboseDocumentComments
bool getCodeVerboseDocumentComments() const
Get the value of m_codeVerboseDocumentComments Whether or not verbose code commenting for documentati...
Definition: codegenerationpolicy.cpp:147
UmbrelloSettings::modnamePolicy
static CodeGenerationPolicy::ModifyNamePolicy modnamePolicy()
Get Modifier Name Policy.
Definition: umbrellosettings.h:1219
CodeGenerationPolicy::getAssociationFieldScope
Uml::Visibility::Enum getAssociationFieldScope()
Get the value of m_associationFieldScope.
Definition: codegenerationpolicy.cpp:403
CodeGenerationPolicy::CodeGenerationPolicy
CodeGenerationPolicy()
Constructor.
Definition: codegenerationpolicy.cpp:51
UmbrelloSettings::setDefaultAttributeAccessorScope
static void setDefaultAttributeAccessorScope(Uml::Visibility::Enum v)
Set Default Attribute Accessor Scope.
Definition: umbrellosettings.h:1050
CodeGenerationPolicy::setModifyPolicy
void setModifyPolicy(ModifyNamePolicy new_var)
Set the value of m_modifyPolicy.
Definition: codegenerationpolicy.cpp:337
CodeGenerationPolicy::getIndentationType
IndentationType getIndentationType()
Get the value of m_indentationType.
Definition: codegenerationpolicy.cpp:268
CodeGenerationPolicy::getIndentation
QString getIndentation() const
Utility method to get the amount (and type of whitespace) to indent with.
Definition: codegenerationpolicy.cpp:299
CodeGenerationPolicy::createPage
virtual CodeGenerationPolicyPage * createPage(QWidget *parent=0, const char *name=0)
Create a new dialog interface for this object.
Definition: codegenerationpolicy.cpp:412
CodeGenerationPolicy::OverwritePolicy
OverwritePolicy
OverwritePolicy can have the following values.
Definition: codegenerationpolicy.h:46
Settings::CodeGenerationState::defaultAssocFieldScope
Uml::Visibility::Enum defaultAssocFieldScope
Definition: optionstate.h:78
codegenerationpolicypage.h
uDebug
#define uDebug()
Definition: debug_utils.h:95
UmbrelloSettings::forceSections
static bool forceSections()
Get Force Section Documentation.
Definition: umbrellosettings.h:1098
CodeGenerationPolicy::writeConfig
virtual void writeConfig()
Write Default params.
Definition: codegenerationpolicy.cpp:502
Settings::CodeGenerationState::overwritePolicy
CodeGenerationPolicy::OverwritePolicy overwritePolicy
Definition: optionstate.h:89
CodeGenerationPolicy::setCodeVerboseSectionComments
void setCodeVerboseSectionComments(bool new_var)
Set the value of m_codeVerboseSectionComments Whether or not verbose code commenting for sections is ...
Definition: codegenerationpolicy.cpp:110
UmbrelloSettings::setOverwritePolicy
static void setOverwritePolicy(CodeGenerationPolicy::OverwritePolicy v)
Set Overwrite Policy.
Definition: umbrellosettings.h:1247
CodeGenerationPolicy::IndentationType
IndentationType
Definition: codegenerationpolicy.h:49
CodeGenerationPolicy::setIndentationAmount
void setIndentationAmount(int amount)
Set how many units to indent for each indentation level.
Definition: codegenerationpolicy.cpp:277
MAXLINES
#define MAXLINES
Definition: codegenerationpolicy.cpp:34
CodeGenerationPolicy::setAttributeAccessorScope
void setAttributeAccessorScope(Uml::Visibility::Enum var)
Set the value of m_attributeAccessorScope.
Definition: codegenerationpolicy.cpp:374
CodeGenerationPolicy::getAutoGenerateConstructors
bool getAutoGenerateConstructors()
Get the value of m_autoGenerateConstructors.
Definition: codegenerationpolicy.cpp:365
CodeGenerationPolicy::getOverwritePolicy
OverwritePolicy getOverwritePolicy() const
Get the value of m_overwritePolicy Policy of how to deal with overwriting existing files...
Definition: codegenerationpolicy.cpp:80
UmbrelloSettings::indentationType
static CodeGenerationPolicy::IndentationType indentationType()
Get Indentation Type.
Definition: umbrellosettings.h:1181
CodeGenerationPolicy::~CodeGenerationPolicy
virtual ~CodeGenerationPolicy()
Destructor.
Definition: codegenerationpolicy.cpp:59
UmbrelloSettings::setIndentationAmount
static void setIndentationAmount(int v)
Set Indentation Amount.
Definition: umbrellosettings.h:1145
UmbrelloSettings::lineEndingType
static CodeGenerationPolicy::NewLineType lineEndingType()
Get Line Ending Type.
Definition: umbrellosettings.h:1200
CodeGenerationPolicy::getCodeVerboseSectionComments
bool getCodeVerboseSectionComments() const
Get the value of m_codeVerboseSectionComments Whether or not verbose code commenting for sections is ...
Definition: codegenerationpolicy.cpp:122
CodeGenerationPolicy::setCommentStyle
void setCommentStyle(CommentStyle new_var)
Set the value of m_commentStyle.
Definition: codegenerationpolicy.cpp:89
Settings::CodeGenerationState::lineEndingType
CodeGenerationPolicy::NewLineType lineEndingType
Definition: optionstate.h:86
UmbrelloSettings::setIndentationType
static void setIndentationType(CodeGenerationPolicy::IndentationType v)
Set Indentation Type.
Definition: umbrellosettings.h:1171
UmbrelloSettings::indentationAmount
static int indentationAmount()
Get Indentation Amount.
Definition: umbrellosettings.h:1162
UmbrelloSettings::setForceSections
static void setForceSections(bool v)
Set Force Section Documentation.
Definition: umbrellosettings.h:1088
UmbrelloSettings::setHeadingsDirectory
static void setHeadingsDirectory(const QString &v)
Set Headings Directory.
Definition: umbrellosettings.h:1107
umldoc.h
CodeGenerationPolicy::getAttributeAccessorScope
Uml::Visibility::Enum getAttributeAccessorScope()
Get the value of m_attributeAccessorScope.
Definition: codegenerationpolicy.cpp:384
Uml::ModelType::toString
QString toString(Enum item)
Convert ModelType item into QString representation.
Definition: basictypes.cpp:39
Settings::OptionState::codeGenerationState
CodeGenerationState codeGenerationState
Definition: optionstate.h:146
UmbrelloSettings::overwritePolicy
static CodeGenerationPolicy::OverwritePolicy overwritePolicy()
Get Overwrite Policy.
Definition: umbrellosettings.h:1257
UmbrelloSettings::autoGenEmptyConstructors
static bool autoGenEmptyConstructors()
Get Auto Generate Empty Constructors.
Definition: umbrellosettings.h:1003
Settings::CodeGenerationState::headingsDirectory
QDir headingsDirectory
Definition: optionstate.h:82
CodeGenerationPolicy::NewLineType
NewLineType
Definition: codegenerationpolicy.h:48
CodeGenerationPolicy::ModifyNamePolicy
ModifyNamePolicy
Definition: codegenerationpolicy.h:47
CodeGenerationPolicy::getLineEndingType
NewLineType getLineEndingType()
Get the value of m_lineEndingType What line ending characters to use.
Definition: codegenerationpolicy.cpp:239
CodeGenerationPolicy::setIndentationType
void setIndentationType(IndentationType type)
Set the value of m_indentationType The amount and type of whitespace to indent with.
Definition: codegenerationpolicy.cpp:258
UmbrelloSettings::outputDirectory
static QString outputDirectory()
Get Output Directory.
Definition: umbrellosettings.h:1238
UmbrelloSettings::setAutoGenEmptyConstructors
static void setAutoGenEmptyConstructors(bool v)
Set Auto Generate Empty Constructors.
Definition: umbrellosettings.h:993
CodeGenerationPolicyPage
Definition: codegenerationpolicypage.h:30
UmbrelloSettings::setCommentStyle
static void setCommentStyle(CodeGenerationPolicy::CommentStyle v)
Set Comment Style.
Definition: umbrellosettings.h:1012
Settings::CodeGenerationState::autoGenEmptyConstructors
bool autoGenEmptyConstructors
Definition: optionstate.h:76
CodeGenerationPolicy::setHeadingFileDir
void setHeadingFileDir(const QString &path)
Set the value of m_headingFileDir location of the header file template.
Definition: codegenerationpolicy.cpp:157
UmbrelloSettings::headingsDirectory
static QString headingsDirectory()
Get Headings Directory.
Definition: umbrellosettings.h:1117
Settings::CodeGenerationState::modnamePolicy
CodeGenerationPolicy::ModifyNamePolicy modnamePolicy
Definition: optionstate.h:87
UmbrelloSettings::defaultAssocFieldScope
static Uml::Visibility::Enum defaultAssocFieldScope()
Get Default Association Field Scope.
Definition: umbrellosettings.h:1041
CodeGenerationPolicy::getHeadingFile
QString getHeadingFile(const QString &str)
Gets the heading file (as a string) to be inserted at the beginning of the generated file...
Definition: codegenerationpolicy.cpp:540
UmbrelloSettings::setOutputDirectory
static void setOutputDirectory(const QString &v)
Set Output Directory.
Definition: umbrellosettings.h:1228
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Get the value of m_commentStyle.
Definition: codegenerationpolicy.cpp:99
Settings::CodeGenerationState::indentationAmount
int indentationAmount
Definition: optionstate.h:84
Settings::CodeGenerationState::outputDirectory
QDir outputDirectory
Definition: optionstate.h:88
CodeGenerationPolicy::getHeadingFileDir
QString getHeadingFileDir() const
Get the value of m_headingFileDir location of the header file template.
Definition: codegenerationpolicy.cpp:167
CodeGenerationPolicy::setOverwritePolicy
void setOverwritePolicy(OverwritePolicy new_var)
Set the value of m_overwritePolicy Policy of how to deal with overwriting existing files...
Definition: codegenerationpolicy.cpp:69
uml.h
CodeGenerationPolicy::getIncludeHeadings
bool getIncludeHeadings() const
Get the value of m_includeHeadings.
Definition: codegenerationpolicy.cpp:186
UmbrelloSettings::setModnamePolicy
static void setModnamePolicy(CodeGenerationPolicy::ModifyNamePolicy v)
Set Modifier Name Policy.
Definition: umbrellosettings.h:1209
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:05:59 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

umbrello/umbrello

Skip menu "umbrello/umbrello"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal