Updating Doxygen styling and Licenses
[baulk.git] / src / Baulk / baulk.h
blobcfcbc5c153da0a58e03128d105118c6c9ac921b4
1 // Baulk
2 //
3 // Baulk - Copyright (C) 2008 - Jacob Alexander
4 //
5 // Baulk is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation; either version 2 of the License, or
8 // any later version, including version 3 of the License.
9 //
10 // Baulk is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef __BAULK_H
19 #define __BAULK_H
21 #include <QCloseEvent>
22 #include <QMainWindow>
23 #include <QProcess>
24 #include <QTest>
25 #include <QWidget>
27 #include <baulkwidget.h>
28 #include <libraryloader.h>
30 //! Main GUI Entrance class for Baulk.
31 /*!
32 * Handles:
33 * - Loading BaulkControl Shared Library
34 * - Connecting message output to BaulkControl
35 * - Connecting the Window Titling setting to BaulkControl.
37 class Baulk : public QMainWindow {
38 Q_OBJECT
40 public:
41 //! Baulk Constructor
42 Baulk( QWidget *parent = 0 );
44 /*!
45 * This public function allows \link handler() \endlink
46 * to pass Console Out Messages into Baulk
48 bool updateMsgLogs( QStringList msgLogs );
50 bool processCommandArgs();
52 private:
53 //! BaulkControl Pointer
54 BaulkWidget *controller;
56 //! BaulkControl Library Pointer
57 LibraryLoader *library;
59 private slots:
60 //! Allows BaulkControl to change the Window Title
61 void setWindowTitleName( QString windowTitle );
63 protected:
64 /*!
65 * Reimplemented QWidget Event that handles the application
66 * Quit Event
67 */
68 virtual void closeEvent( QCloseEvent *event );
71 #endif