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