Documentation fixes
[vlp.git] / src / edit / ProgramStructureDialog.h
1 #ifndef _VLP_EDITOR_PROGRAMSTRUCTUREDIALOG_H
2 #define _VLP_EDITOR_PROGRAMSTRUCTUREDIALOG_H
3
4 #include <QtGui/QDialog>
5 #include <QtCore/QString>
6
7
8 #include "ui/dialogs/ProgramStructureDialog.h"
9
10 /**
11  * @file
12  */
13
14 namespace loglan {
15 namespace vlp {
16 namespace dialog {
17
18 /**
19  * Program Structure Dialog class
20  * Displays dialog for generating code template for program structure
21  */
22 class ProgramStructureDialog : public QDialog, private Ui::ProgramStructureDialog {
23 public:
24         /**
25          * Class constructor
26          */
27         ProgramStructureDialog(QWidget * parent = 0);
28
29         /**
30          * Class destuctor
31          */
32         ~ProgramStructureDialog();
33
34         /**
35          * Gets user-passed program name
36          * 
37          * @return program name entered in dialog
38          */
39         QString getProgramName();
40
41         /**
42          * Gets program code template
43          * 
44          * @return program code template with program name
45          */
46         QString getCode();
47 };
48
49 }
50 }
51 }
52
53 #endif /* _VLP_EDITOR_PROGRAMSTRUCTUREDIALOG_H */