|
Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
|
#include <projectoptionsmanager.h>
Public Slots | |
| void | DoClear (void) |
| Clear All Options in User Interface. | |
| void | ReadOptionState (uint OptionState) |
| Read & Decode the Options, and set ser Interface. | |
| void | ReadProjectId (PROJECT_INFORMATION *ProjectInfo) |
| Read Project's Options from Database & set User Interface. | |
Signals | |
| void | SendLogEntry (REMOTE_LOG_ENTRY LogEntry) |
| Send Log Entry to the Log \LogEntry Structure holding Log information. | |
| void | SendOptionState (uint ProjectOptions) |
| Set the Project's Options State. | |
Public Member Functions | |
| ProjectOptionsManager (Ui::MainWindow *UI_Window) | |
| ProjectOptionsManager Constructor. | |
| bool | CheckExcludeProjectList (uint Options) |
| Check if Project is Excluded from List \Options Encoded List of Options. | |
| bool | CheckControlDocAccess (uint Options) |
| Check if Document Access Control is Enabled \Options Encoded List of Options. | |
| bool | CheckOnlyDefaultPage (uint Options) |
| Check if make Only Default Page \Options Encoded List of Options. | |
| bool | CheckGroupAccessOnly (uint Options) |
| Check if Group Access Only \Options Encoded List of Options. | |
| bool | CheckEnableCustomDoxygen (uint Options) |
| Check if Custom Doxygen Settings Enabled \Options Encoded List of Options. | |
| bool | CheckCaveatLector (uint Options) |
| Check if Caveat Emptor warning needed \Options Encoded List of Options. | |
| bool | CheckPotentialHazard (uint Options) |
| Check if Potential Hazard warning needed \Options Encoded List of Options. | |
| bool | CheckAssistanceWelcome (uint Options) |
| Check if Assistance Welcome message needed \Options Encoded List of Options. | |
| bool | ChecktDonationsWelcome (uint Options) |
| Check if Donations Welcome message needed \Options Encoded List of Options. | |
| bool | CheckOfferPaypalDonation (uint Options) |
| Check if Paypal Donations available message needed \Options Encoded List of Options. | |
| bool | CheckCreateSourceArchive (uint OptionState) |
| Check if Source Archive is required \Options Encoded List of Options. | |
| bool | CheckAutomaticInstall (uint OptionState) |
| Check if Auto Install script is required \Options Encoded List of Options. | |
| bool | CheckAutomaticGit (uint OptionState) |
| uint | WriteOptionState (void) |
| Get the Options Encoded from User Interface. | |
Private Slots | |
| void | SetExcludeProjectList (Qt::CheckState State) |
| Set Exclude Project Option to desired State. | |
| void | SetControlDocAccess (Qt::CheckState State) |
| Set Doc Access Option to desired State. | |
| void | SetOnlyDefaultPage (bool State) |
| Set Only Default Page Option to desired State. | |
| void | SetGroupAccessOnly (bool State) |
| void | SetEnableCustomDoxygen (Qt::CheckState State) |
| Set Enable Custom Doxygen Option to desired State. | |
| void | SetCaveatLector (Qt::CheckState State) |
| Set Caveat Lector Option to desired State. | |
| void | SetPotentialHazard (Qt::CheckState State) |
| void | SetAssistanceWelcome (Qt::CheckState State) |
| Set Assistance Welcom Option to desired State. | |
| void | SetDonationsWelcome (Qt::CheckState State) |
| Set Donations Welcome Option to desired State. | |
| void | SetOfferPaypalDonation (Qt::CheckState State) |
| Set Paypal Donation Option to desired State. | |
| void | SetCreateSourceArchive (Qt::CheckState State) |
| void | SetUpdateGitRevision (Qt::CheckState State) |
| Set the Update Git Revision Option to desired state. | |
| void | SetAllowAutomaticInstall (Qt::CheckState State) |
| Set Allow Automatic Installation Option to desired State. | |
Private Member Functions | |
| void | LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message) |
| Add a Log Entry. | |
| void | SetOption (bool State, int Mask) |
| Set the Project's Selected Option to the Required State. | |
Private Attributes | |
| Ui::MainWindow * | ui |
| uint | project_options |
| Encoded Project Options Storage. | |
Definition at line 20 of file projectoptionsmanager.h.
| ProjectOptionsManager::ProjectOptionsManager | ( | Ui::MainWindow * | UI_Window | ) |
ProjectOptionsManager Constructor.
| UI_Window | Pointer to teh Main Window |
Definition at line 3 of file projectoptionsmanager.cpp.
References project_options, SetAllowAutomaticInstall(), SetAssistanceWelcome(), SetCaveatLector(), SetControlDocAccess(), SetCreateSourceArchive(), SetDonationsWelcome(), SetEnableCustomDoxygen(), SetExcludeProjectList(), SetGroupAccessOnly(), SetOfferPaypalDonation(), SetOnlyDefaultPage(), SetPotentialHazard(), SetUpdateGitRevision(), and ui.
| bool ProjectOptionsManager::CheckAssistanceWelcome | ( | uint | Options | ) |
Check if Assistance Welcome message needed \Options Encoded List of Options.
Definition at line 246 of file projectoptionsmanager.cpp.
References ASSISTANCE_WELCOME.
| bool ProjectOptionsManager::CheckAutomaticGit | ( | uint | OptionState | ) |
| bool ProjectOptionsManager::CheckAutomaticInstall | ( | uint | OptionState | ) |
Check if Auto Install script is required \Options Encoded List of Options.
Check if Automatic Git Revision is required \Options Encoded List of Options.
Definition at line 265 of file projectoptionsmanager.cpp.
References ALLOW_AUTOMATIC_INSTALL.
| bool ProjectOptionsManager::CheckCaveatLector | ( | uint | Options | ) |
Check if Caveat Emptor warning needed \Options Encoded List of Options.
Definition at line 236 of file projectoptionsmanager.cpp.
References CAVEAT_LECTOR.
| bool ProjectOptionsManager::CheckControlDocAccess | ( | uint | Options | ) |
Check if Document Access Control is Enabled \Options Encoded List of Options.
Definition at line 216 of file projectoptionsmanager.cpp.
References GROUP_ACCESS_ONLY.
| bool ProjectOptionsManager::CheckCreateSourceArchive | ( | uint | OptionState | ) |
Check if Source Archive is required \Options Encoded List of Options.
Definition at line 260 of file projectoptionsmanager.cpp.
References CREATE_SOURCE_ARCHIVE.
| bool ProjectOptionsManager::CheckEnableCustomDoxygen | ( | uint | Options | ) |
Check if Custom Doxygen Settings Enabled \Options Encoded List of Options.
Definition at line 231 of file projectoptionsmanager.cpp.
References ENABLE_CUSTOM_DOXYGEN.
| bool ProjectOptionsManager::CheckExcludeProjectList | ( | uint | Options | ) |
Check if Project is Excluded from List \Options Encoded List of Options.
Definition at line 211 of file projectoptionsmanager.cpp.
References EXCLUDE_PROJECT_LIST.
| bool ProjectOptionsManager::CheckGroupAccessOnly | ( | uint | Options | ) |
Check if Group Access Only \Options Encoded List of Options.
Definition at line 226 of file projectoptionsmanager.cpp.
References GROUP_ACCESS_ONLY.
| bool ProjectOptionsManager::CheckOfferPaypalDonation | ( | uint | Options | ) |
Check if Paypal Donations available message needed \Options Encoded List of Options.
Definition at line 255 of file projectoptionsmanager.cpp.
References OFFER_PAYPAL_DONATION.
| bool ProjectOptionsManager::CheckOnlyDefaultPage | ( | uint | Options | ) |
Check if make Only Default Page \Options Encoded List of Options.
Definition at line 221 of file projectoptionsmanager.cpp.
References ONLY_DEFAULT_PAGE.
| bool ProjectOptionsManager::CheckPotentialHazard | ( | uint | Options | ) |
Check if Potential Hazard warning needed \Options Encoded List of Options.
Definition at line 241 of file projectoptionsmanager.cpp.
References POTENTIAL_HAZARD.
| bool ProjectOptionsManager::ChecktDonationsWelcome | ( | uint | Options | ) |
Check if Donations Welcome message needed \Options Encoded List of Options.
Definition at line 250 of file projectoptionsmanager.cpp.
References DONATIONS_WELCOME.
|
slot |
Clear All Options in User Interface.
Definition at line 139 of file projectoptionsmanager.cpp.
References LOG_DEBUG, LogAdd(), MODE_OPERATOR, project_options, and ui.
|
private |
Add a Log Entry.
| Severity | Severity of the Logged Event |
| Mode | Part of the Program being Logged |
| Message | Description of the Log Event |
Definition at line 157 of file projectoptionsmanager.cpp.
References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.
Referenced by DoClear(), ReadOptionState(), and WriteOptionState().
|
slot |
Read & Decode the Options, and set ser Interface.
| OptionState | Project's Encoded Options |
Definition at line 171 of file projectoptionsmanager.cpp.
References ALLOW_AUTOMATIC_INSTALL, ASSISTANCE_WELCOME, CAVEAT_LECTOR, CONTROL_DOC_ACCESS, CREATE_SOURCE_ARCHIVE, DONATIONS_WELCOME, ENABLE_CUSTOM_DOXYGEN, EXCLUDE_PROJECT_LIST, GROUP_ACCESS_ONLY, LOG_DEBUG, LogAdd(), MODE_OPERATOR, OFFER_PAYPAL_DONATION, ONLY_DEFAULT_PAGE, POTENTIAL_HAZARD, and ui.
Referenced by ReadProjectId().
|
slot |
Read Project's Options from Database & set User Interface.
| ProjectId | Pointer to Project's Information |
Definition at line 166 of file projectoptionsmanager.cpp.
References PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectOptions, and ReadOptionState().
|
signal |
Send Log Entry to the Log \LogEntry Structure holding Log information.
Referenced by LogAdd().
|
signal |
Set the Project's Options State.
| ProjectOptions | Encoded Project Options |
Referenced by SetOption().
|
privateslot |
Set Allow Automatic Installation Option to desired State.
| State | State to set the Option |
Definition at line 125 of file projectoptionsmanager.cpp.
References ALLOW_AUTOMATIC_INSTALL, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Assistance Welcom Option to desired State.
| State | State to set the Option |
Definition at line 83 of file projectoptionsmanager.cpp.
References ASSISTANCE_WELCOME, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Caveat Lector Option to desired State.
| State | State to set the Option |
Definition at line 67 of file projectoptionsmanager.cpp.
References CAVEAT_LECTOR, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Doc Access Option to desired State.
| State | State to set the Option |
Definition at line 39 of file projectoptionsmanager.cpp.
References CONTROL_DOC_ACCESS, SetOption(), and ui.
Referenced by ProjectOptionsManager().
|
privateslot |
Definition at line 111 of file projectoptionsmanager.cpp.
References CREATE_SOURCE_ARCHIVE, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Donations Welcome Option to desired State.
| State | State to set the Option |
Definition at line 91 of file projectoptionsmanager.cpp.
References DONATIONS_WELCOME, SetOfferPaypalDonation(), SetOption(), and ui.
Referenced by ProjectOptionsManager().
|
privateslot |
Set Enable Custom Doxygen Option to desired State.
| State | State to set the Option |
Definition at line 59 of file projectoptionsmanager.cpp.
References ENABLE_CUSTOM_DOXYGEN, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Exclude Project Option to desired State.
| State | State to set the Option |
Definition at line 23 of file projectoptionsmanager.cpp.
References EXCLUDE_PROJECT_LIST, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Definition at line 51 of file projectoptionsmanager.cpp.
References GROUP_ACCESS_ONLY, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set Paypal Donation Option to desired State.
| State | State to set the Option |
Definition at line 104 of file projectoptionsmanager.cpp.
References OFFER_PAYPAL_DONATION, and SetOption().
Referenced by ProjectOptionsManager(), and SetDonationsWelcome().
|
privateslot |
Set Only Default Page Option to desired State.
| State | State to set the Option |
Definition at line 31 of file projectoptionsmanager.cpp.
References ONLY_DEFAULT_PAGE, and SetOption().
Referenced by ProjectOptionsManager().
|
private |
Set the Project's Selected Option to the Required State.
| State | On (true) or Off (false) |
| Mask | Mask to identifiy the Option Bit |
Definition at line 133 of file projectoptionsmanager.cpp.
References project_options, and SendOptionState().
Referenced by SetAllowAutomaticInstall(), SetAssistanceWelcome(), SetCaveatLector(), SetControlDocAccess(), SetCreateSourceArchive(), SetDonationsWelcome(), SetEnableCustomDoxygen(), SetExcludeProjectList(), SetGroupAccessOnly(), SetOfferPaypalDonation(), SetOnlyDefaultPage(), SetPotentialHazard(), and SetUpdateGitRevision().
|
privateslot |
Definition at line 75 of file projectoptionsmanager.cpp.
References POTENTIAL_HAZARD, and SetOption().
Referenced by ProjectOptionsManager().
|
privateslot |
Set the Update Git Revision Option to desired state.
| State | State to set the Option |
Definition at line 118 of file projectoptionsmanager.cpp.
References SetOption(), and UPDATE_GIT_REVISION.
Referenced by ProjectOptionsManager().
| uint ProjectOptionsManager::WriteOptionState | ( | void | ) |
Get the Options Encoded from User Interface.
Definition at line 189 of file projectoptionsmanager.cpp.
References ALLOW_AUTOMATIC_INSTALL, ASSISTANCE_WELCOME, CAVEAT_LECTOR, CONTROL_DOC_ACCESS, CREATE_SOURCE_ARCHIVE, DONATIONS_WELCOME, ENABLE_CUSTOM_DOXYGEN, EXCLUDE_PROJECT_LIST, GROUP_ACCESS_ONLY, LOG_DEBUG, LogAdd(), MODE_OPERATOR, OFFER_PAYPAL_DONATION, ONLY_DEFAULT_PAGE, POTENTIAL_HAZARD, and ui.
|
private |
Encoded Project Options Storage.
Definition at line 180 of file projectoptionsmanager.h.
Referenced by DoClear(), ProjectOptionsManager(), and SetOption().
|
private |
brief Pointer to the main window
Definition at line 174 of file projectoptionsmanager.h.
Referenced by DoClear(), ProjectOptionsManager(), ReadOptionState(), SetControlDocAccess(), SetDonationsWelcome(), and WriteOptionState().