Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
Loading...
Searching...
No Matches
projectdocmanager.h
Go to the documentation of this file.
1
8
9#ifndef PROJECTDOCMANAGER_H
10#define PROJECTDOCMANAGER_H
11
12#include <QObject>
13#include <QSqlQuery>
14#include <ui_mainwindow.h>
15#include "logger.h"
16#include "common_definitions.h"
17
18
29
34class ProjectDocManager : public QObject
35{
36 Q_OBJECT
37public:
38
44 ProjectDocManager(Ui::MainWindow* UI_Window);
45
51
60 bool CommitGitDirectory(QString SrcFilePath, QString VersionsString, QString Message);
61
62public slots:
63
72 void LoadProjectList();
73
80
85 void SaveProject(void);
86
92 int CreateProjectId(void);
93
94private:
95
100 Ui::MainWindow* ui;
101
107
108
118 QString GetFile( QString InitialName, GET_FILE_TYPE FileType);
119
127 void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message);
128
134 void ShowMessage(QString Message);
135
141 void LoadProjectFromDatabase(int Item);
142
148 void SetEditButtons(bool State);
149
156 int GetLicenceIndex(QString LicenceName);
157
163 bool IsSaveAvailable(void);
164
169 void UpdateProjectToDatabase(void);
170
177
185 bool CopyRecursively(const QString &SourceFilePath, const QString &TargetFilePath);
186
193 bool InitiasliseGitDirectory(QString SrcFilePath);
194
202 bool LockProject(int ProjectIndex, bool LockState);
203
209 void LockSubsButtons(bool State);
210
211private slots:
217 void SetDocAccess(int State);
218
224 void SetDoxyOptions(int State);
225
231 void SetDonationsWelcome(int State);
232
237 void GetDoxyLogo(void);
238
245 void GetDoxyHeader(void);
246
253 void GetDoxyFooter(void);
254
261 void GetDoxyStylesheet(void);
262
267 void StartProject(void);
268
274 void SetEditState(int State);
275
281 void ReadActivated(int Item);
282
287 void DoEditAbort(void);
288
293 void DoEditSave(void);
294
299 void EnableUserInterface(bool State);
300
301signals:
302
307 void SendClear(void);
308
315
322
328 void SendLicenceState(LICENCE_STATE ProjectLicences);
329
336
343
349 void SendSubstituteState(bool State);
350
356
362};
363
364#endif // PROJECTDOCMANAGER_H
bool InitiasliseGitDirectory(QString SrcFilePath)
Initialise the Project's Git Directory.
~ProjectDocManager()
ProjectManager Class Deconstructor.
void ReceiveProjectId(PROJECT_INFORMATION ProjectId)
Receive the Project's Information for processing.
int CreateProjectId(void)
Create the next unused project number.
void GetDoxyHeader(void)
Get Custom Doxygen Header.
void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message)
Send Message to the Log.
QString GetFile(QString InitialName, GET_FILE_TYPE FileType)
Read a file into a String.
void SendDevelopmentFamily(DEVELOPMENT_FAMILY DevFamily)
Send Development Family Information Structure for Update.
void LoadSubstituteTable()
Load System Substituitions.
void StartProject(void)
Enable the Project User Interface for editing.
void SendLogEntry(REMOTE_LOG_ENTRY LogEntry)
Send Log Entry via the Signal-Slot Method.
ProjectDocManager(Ui::MainWindow *UI_Window)
ProjectManager Class Constructor.
void SaveLocalSubstitutes(void)
Send a Trigger to Load.
void SetDonationsWelcome(int State)
Enable/Disable Donation Options.
bool CommitGitDirectory(QString SrcFilePath, QString VersionsString, QString Message)
Commit Project Files to Git.
void ShowMessage(QString Message)
Shows Message in popup window.
void SaveProject(void)
Save a new project to the database.
void SendSubstituteState(bool State)
Send the Substitute Enable State.
void GetDoxyLogo(void)
Get the Doxygen Logo from known image files.
bool CopyRecursively(const QString &SourceFilePath, const QString &TargetFilePath)
Recursively copy files from Source to Destination.
void GetDoxyFooter(void)
Get Custom Doxygen Footer.
PROJECT_INFORMATION project_info
Structure to hold Project Information.
void SendLicenceState(LICENCE_STATE ProjectLicences)
Send out the current Licence States.
int GetLicenceIndex(QString LicenceName)
Get the Licence Database Index from the Licence Name.
bool LockProject(int ProjectIndex, bool LockState)
Lock/Unlock Project in the Database.
void SetDocAccess(int State)
Enable/Disable Document Access Restrictions.
void LoadProjectList()
Load Select Project List from Database.
void UpdateProjectToDatabase(void)
Updates an Existing Project.
void LoadProjectFromDatabase(int Item)
Load Project Information from Database.
void DoEditSave(void)
Abort Editing after Saving.
void SetDoxyOptions(int State)
Enable/Disable Custom Doxy Options.
void SendClear(void)
Send a Project Clear Command.
void SetEditButtons(bool State)
Enable/Disable Edit buttons.
void SendProjectId(PROJECT_INFORMATION *ProjectId)
Send out Project Information for Updates.
bool IsSaveAvailable(void)
Check if Project Save is Enabled.
void LockSubsButtons(bool State)
Lock/unlock the Substitution Buttons.
bool InsertNewProjectInDatabase(void)
Inserts new project into the database.
void ReadActivated(int Item)
Load a Project & Enable editing.
void GetDoxyStylesheet(void)
Get Custom Doxygen Stylesheet.
void EnableUserInterface(bool State)
Enable the Project User Interface.
void SetEditState(int State)
Enable/Disable editing.
Ui::MainWindow * ui
Pointer to the Main Window.
void SendVersion(REMOTE_VERSION_ENTRY VersionInfo)
Send out the Project Version Information.
void DoEditAbort(void)
Abort Editing without Saving.
Common Structure Defintitions.
LOGGING_SEVERITY
Log Severity allow the selection of logging events based on Severity.
Definition logger.h:48
LOGGING_MODE
Log Severity allow the selection of logging events based on the mode.
Definition logger.h:21
GET_FILE_TYPE
Type of File to Search for.
@ GET_IMAGE_FILE
@ GET_HTML_FILE
@ GET_CSS_FILE
Summary of Project Types.
Assigned Software, Hardware and COgumenttaion Licences.
Project Information Passed Between Functions.
Definition logger.h:60
Version Structure used between functions.