Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
Loading...
Searching...
No Matches
ProjectOptionsManager Class Reference

#include <projectoptionsmanager.h>

Inheritance diagram for ProjectOptionsManager:
[legend]
Collaboration diagram for ProjectOptionsManager:
[legend]

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 CheckCreatePublishList (uint OptionState)
 Check if Automatic Publish List 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.

Detailed Description

Definition at line 20 of file projectoptionsmanager.h.

Constructor & Destructor Documentation

◆ ProjectOptionsManager()

ProjectOptionsManager::ProjectOptionsManager ( Ui::MainWindow * UI_Window)

ProjectOptionsManager Constructor.

Parameters
UI_WindowPointer to teh Main Window

Definition at line 3 of file projectoptionsmanager.cpp.

4{
5 ui = UI_Window;
7
8 QObject::connect(ui->ExcludeFromProjectList, SIGNAL(checkStateChanged(Qt::CheckState)), this, SLOT(SetExcludeProjectList(Qt::CheckState)));
9 QObject::connect(ui->ControlDocAccess, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetControlDocAccess(Qt::CheckState)));
10 QObject::connect(ui->OnlyInfoPage, SIGNAL(toggled(bool)), this, SLOT(SetOnlyDefaultPage(bool)));
11 QObject::connect(ui->LimitToAssoc, SIGNAL(toggled(bool)), this, SLOT(SetGroupAccessOnly(bool)));
12 QObject::connect(ui->EnableDoxyOptions, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetEnableCustomDoxygen(Qt::CheckState)));
13 QObject::connect(ui->CaveatLector, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetCaveatLector(Qt::CheckState)));
14 QObject::connect(ui->PossiblyHazardous, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetPotentialHazard(Qt::CheckState)));
15 QObject::connect(ui->AssistanceWelcome, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetAssistanceWelcome(Qt::CheckState)));
16 QObject::connect(ui->DonationsWelcome, SIGNAL(checkStateChanged(Qt::CheckState)), this, SLOT(SetDonationsWelcome(Qt::CheckState)));
17 QObject::connect(ui->OfferPaypal, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetOfferPaypalDonation(Qt::CheckState)));
18 QObject::connect(ui->CreateSourceArchive, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetCreateSourceArchive(Qt::CheckState)));
19 QObject::connect(ui->UpdateGitRevision, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetUpdateGitRevision(Qt::CheckState)));
20 QObject::connect(ui->AutomaticInstall, SIGNAL(checkStateChanged(Qt::CheckState )), this, SLOT(SetAllowAutomaticInstall(Qt::CheckState)));
21 QObject::connect (ui->CreatePublishList,
22 SIGNAL (checkStateChanged (Qt::CheckState)), this,
23 SLOT (SetCreatePublishList (Qt::CheckState)));
24}
void SetCaveatLector(Qt::CheckState State)
Set Caveat Lector Option to desired State.
void SetDonationsWelcome(Qt::CheckState State)
Set Donations Welcome Option to desired State.
void SetCreateSourceArchive(Qt::CheckState State)
void SetEnableCustomDoxygen(Qt::CheckState State)
Set Enable Custom Doxygen Option to desired State.
void SetPotentialHazard(Qt::CheckState State)
void SetAllowAutomaticInstall(Qt::CheckState State)
Set Allow Automatic Installation Option to desired State.
void SetUpdateGitRevision(Qt::CheckState State)
Set the Update Git Revision Option to desired state.
void SetControlDocAccess(Qt::CheckState State)
Set Doc Access Option to desired State.
void SetOfferPaypalDonation(Qt::CheckState State)
Set Paypal Donation Option to desired State.
void SetOnlyDefaultPage(bool State)
Set Only Default Page Option to desired State.
void SetExcludeProjectList(Qt::CheckState State)
Set Exclude Project Option to desired State.
void SetGroupAccessOnly(bool State)
uint project_options
Encoded Project Options Storage.
void SetAssistanceWelcome(Qt::CheckState State)
Set Assistance Welcom Option to desired State.

References project_options, SetAllowAutomaticInstall(), SetAssistanceWelcome(), SetCaveatLector(), SetControlDocAccess(), SetCreateSourceArchive(), SetDonationsWelcome(), SetEnableCustomDoxygen(), SetExcludeProjectList(), SetGroupAccessOnly(), SetOfferPaypalDonation(), SetOnlyDefaultPage(), SetPotentialHazard(), SetUpdateGitRevision(), and ui.

Here is the call graph for this function:

Member Function Documentation

◆ CheckAssistanceWelcome()

bool ProjectOptionsManager::CheckAssistanceWelcome ( uint Options)

Check if Assistance Welcome message needed \Options Encoded List of Options.

Definition at line 249 of file projectoptionsmanager.cpp.

250{
251 return(OptionState & ASSISTANCE_WELCOME);
252}
#define ASSISTANCE_WELCOME
Display Assistance Welcome Mask.

References ASSISTANCE_WELCOME.

◆ CheckAutomaticGit()

bool ProjectOptionsManager::CheckAutomaticGit ( uint OptionState)

Definition at line 279 of file projectoptionsmanager.cpp.

280{
281 return(OptionState & UPDATE_GIT_REVISION);
282}
#define UPDATE_GIT_REVISION

References UPDATE_GIT_REVISION.

◆ CheckAutomaticInstall()

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 274 of file projectoptionsmanager.cpp.

275{
276 return(OptionState & ALLOW_AUTOMATIC_INSTALL);
277}
#define ALLOW_AUTOMATIC_INSTALL

References ALLOW_AUTOMATIC_INSTALL.

◆ CheckCaveatLector()

bool ProjectOptionsManager::CheckCaveatLector ( uint Options)

Check if Caveat Emptor warning needed \Options Encoded List of Options.

Definition at line 239 of file projectoptionsmanager.cpp.

240{
241 return(OptionState & CAVEAT_LECTOR);
242}
#define CAVEAT_LECTOR
Display User Warning Mask.

References CAVEAT_LECTOR.

◆ CheckControlDocAccess()

bool ProjectOptionsManager::CheckControlDocAccess ( uint Options)

Check if Document Access Control is Enabled \Options Encoded List of Options.

Definition at line 219 of file projectoptionsmanager.cpp.

220{
221 return(OptionState & GROUP_ACCESS_ONLY);
222}
#define GROUP_ACCESS_ONLY
restrict Public Access Mask

References GROUP_ACCESS_ONLY.

◆ CheckCreatePublishList()

bool ProjectOptionsManager::CheckCreatePublishList ( uint OptionState)

Check if Automatic Publish List is required \Options Encoded List of Options.

Definition at line 269 of file projectoptionsmanager.cpp.

270{
271 return (OptionState & CREATE_PUBLISH_LIST);
272}
#define CREATE_PUBLISH_LIST
Create a SOurce Archive when Documentation Generated.

References CREATE_PUBLISH_LIST.

◆ CheckCreateSourceArchive()

bool ProjectOptionsManager::CheckCreateSourceArchive ( uint OptionState)

Check if Source Archive is required \Options Encoded List of Options.

Definition at line 263 of file projectoptionsmanager.cpp.

264{
265 return(OptionState & CREATE_SOURCE_ARCHIVE);
266}
#define CREATE_SOURCE_ARCHIVE
Create a SOurce Archive when Documentation Generated.

References CREATE_SOURCE_ARCHIVE.

◆ CheckEnableCustomDoxygen()

bool ProjectOptionsManager::CheckEnableCustomDoxygen ( uint Options)

Check if Custom Doxygen Settings Enabled \Options Encoded List of Options.

Definition at line 234 of file projectoptionsmanager.cpp.

235{
236 return(OptionState & ENABLE_CUSTOM_DOXYGEN);
237}
#define ENABLE_CUSTOM_DOXYGEN
Enable Custom Doxygen Definitions Mask.

References ENABLE_CUSTOM_DOXYGEN.

◆ CheckExcludeProjectList()

bool ProjectOptionsManager::CheckExcludeProjectList ( uint Options)

Check if Project is Excluded from List \Options Encoded List of Options.

Definition at line 214 of file projectoptionsmanager.cpp.

215{
216 return(OptionState & EXCLUDE_PROJECT_LIST);
217}
#define EXCLUDE_PROJECT_LIST
Exclude Project from Public List Mask.

References EXCLUDE_PROJECT_LIST.

◆ CheckGroupAccessOnly()

bool ProjectOptionsManager::CheckGroupAccessOnly ( uint Options)

Check if Group Access Only \Options Encoded List of Options.

Definition at line 229 of file projectoptionsmanager.cpp.

230{
231 return(OptionState & GROUP_ACCESS_ONLY);
232}

References GROUP_ACCESS_ONLY.

◆ CheckOfferPaypalDonation()

bool ProjectOptionsManager::CheckOfferPaypalDonation ( uint Options)

Check if Paypal Donations available message needed \Options Encoded List of Options.

Definition at line 258 of file projectoptionsmanager.cpp.

259{
260 return(OptionState & OFFER_PAYPAL_DONATION);
261}
#define OFFER_PAYPAL_DONATION
Display Paypal Available Mask.

References OFFER_PAYPAL_DONATION.

◆ CheckOnlyDefaultPage()

bool ProjectOptionsManager::CheckOnlyDefaultPage ( uint Options)

Check if make Only Default Page \Options Encoded List of Options.

Definition at line 224 of file projectoptionsmanager.cpp.

225{
226 return(OptionState & ONLY_DEFAULT_PAGE);
227}
#define ONLY_DEFAULT_PAGE
Only Display Default Page to Public Mask.

References ONLY_DEFAULT_PAGE.

◆ CheckPotentialHazard()

bool ProjectOptionsManager::CheckPotentialHazard ( uint Options)

Check if Potential Hazard warning needed \Options Encoded List of Options.

Definition at line 244 of file projectoptionsmanager.cpp.

245{
246 return(OptionState & POTENTIAL_HAZARD);
247}
#define POTENTIAL_HAZARD
Display Potential Harzard Mask.

References POTENTIAL_HAZARD.

◆ ChecktDonationsWelcome()

bool ProjectOptionsManager::ChecktDonationsWelcome ( uint Options)

Check if Donations Welcome message needed \Options Encoded List of Options.

Definition at line 253 of file projectoptionsmanager.cpp.

254{
255 return(OptionState & DONATIONS_WELCOME);
256}
#define DONATIONS_WELCOME
Display Donations Welcome Mask.

References DONATIONS_WELCOME.

◆ DoClear

void ProjectOptionsManager::DoClear ( void )
slot

Clear All Options in User Interface.

Definition at line 142 of file projectoptionsmanager.cpp.

143{
144 ui->ExcludeFromProjectList->setChecked(false);
145 ui->ControlDocAccess->setChecked(false);
146 ui->OnlyInfoPage->setChecked(true);
147 ui->EnableDoxyOptions->setChecked(false);
148 ui->CaveatLector->setChecked(false);
149 ui->PossiblyHazardous->setChecked(false);
150 ui->AssistanceWelcome->setChecked(false);
151 ui->DonationsWelcome->setChecked(false);
152 ui->OfferPaypal->setChecked(false);
153 ui->CreateSourceArchive->setChecked(false);
154 ui->AutomaticInstall->setChecked(false);
155 project_options = 0;
156
157 LogAdd(LOG_DEBUG, MODE_OPERATOR , "Cleared the Project Options on the Display");
158}
void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
Add a Log Entry.
@ LOG_DEBUG
Definition logger.h:56
@ MODE_OPERATOR
Definition logger.h:34

References LOG_DEBUG, LogAdd(), MODE_OPERATOR, project_options, and ui.

Here is the call graph for this function:

◆ LogAdd()

void ProjectOptionsManager::LogAdd ( LOGGING_SEVERITY Severity,
LOGGING_MODE Mode,
QString Message )
private

Add a Log Entry.

Parameters
SeveritySeverity of the Logged Event
ModePart of the Program being Logged
MessageDescription of the Log Event

Definition at line 160 of file projectoptionsmanager.cpp.

161{
162 REMOTE_LOG_ENTRY log_entry;
163 log_entry.Severity = Severity;
164 log_entry.Mode = Mode;
165 log_entry.Message = Message;
166 emit SendLogEntry(log_entry);
167}
void SendLogEntry(REMOTE_LOG_ENTRY LogEntry)
Send Log Entry to the Log \LogEntry Structure holding Log information.
LOGGING_MODE Mode
Definition logger.h:61
QString Message
Definition logger.h:63
LOGGING_SEVERITY Severity
Definition logger.h:62

References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.

Referenced by DoClear(), ReadOptionState(), and WriteOptionState().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadOptionState

void ProjectOptionsManager::ReadOptionState ( uint OptionState)
slot

Read & Decode the Options, and set ser Interface.

Parameters
OptionStateProject's Encoded Options

Definition at line 174 of file projectoptionsmanager.cpp.

175{
176 ui->ExcludeFromProjectList->setChecked(OptionState & EXCLUDE_PROJECT_LIST);
177 ui->ControlDocAccess->setChecked(OptionState & CONTROL_DOC_ACCESS);
178 ui->OnlyInfoPage->setChecked(OptionState & ONLY_DEFAULT_PAGE);
179 ui->LimitToAssoc->setChecked(OptionState & GROUP_ACCESS_ONLY);
180 ui->EnableDoxyOptions->setChecked(OptionState & ENABLE_CUSTOM_DOXYGEN);
181 ui->CaveatLector->setChecked(OptionState & CAVEAT_LECTOR);
182 ui->PossiblyHazardous->setChecked(OptionState & POTENTIAL_HAZARD);
183 ui->AssistanceWelcome->setChecked(OptionState & ASSISTANCE_WELCOME);
184 ui->DonationsWelcome->setChecked(OptionState & DONATIONS_WELCOME);
185 ui->OfferPaypal->setChecked(OptionState & OFFER_PAYPAL_DONATION);
186 ui->CreateSourceArchive->setChecked(OptionState & CREATE_SOURCE_ARCHIVE);
187 ui->AutomaticInstall->setChecked(OptionState & ALLOW_AUTOMATIC_INSTALL);
188
189 LogAdd(LOG_DEBUG, MODE_OPERATOR, "User Interface loaded with Project's State of Options");
190}
#define CONTROL_DOC_ACCESS
Control Document Access to Public Mask.

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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadProjectId

void ProjectOptionsManager::ReadProjectId ( PROJECT_INFORMATION * ProjectInfo)
slot

Read Project's Options from Database & set User Interface.

Parameters
ProjectIdPointer to Project's Information

Definition at line 169 of file projectoptionsmanager.cpp.

170{
172}
void ReadOptionState(uint OptionState)
Read & Decode the Options, and set ser Interface.
PROJECT_DESCRIPTION ProjectDesc

References PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectOptions, and ReadOptionState().

Here is the call graph for this function:

◆ SendLogEntry

void ProjectOptionsManager::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry)
signal

Send Log Entry to the Log \LogEntry Structure holding Log information.

Referenced by LogAdd().

Here is the caller graph for this function:

◆ SendOptionState

void ProjectOptionsManager::SendOptionState ( uint ProjectOptions)
signal

Set the Project's Options State.

Parameters
ProjectOptionsEncoded Project Options

Referenced by SetOption().

Here is the caller graph for this function:

◆ SetAllowAutomaticInstall

void ProjectOptionsManager::SetAllowAutomaticInstall ( Qt::CheckState State)
privateslot

Set Allow Automatic Installation Option to desired State.

Parameters
StateState to set the Option

Definition at line 128 of file projectoptionsmanager.cpp.

129{
130 bool state = (bool)State;
131 uint mask = ALLOW_AUTOMATIC_INSTALL;
132 SetOption(state, mask);
133}
void SetOption(bool State, int Mask)
Set the Project's Selected Option to the Required State.

References ALLOW_AUTOMATIC_INSTALL, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetAssistanceWelcome

void ProjectOptionsManager::SetAssistanceWelcome ( Qt::CheckState State)
privateslot

Set Assistance Welcom Option to desired State.

Parameters
StateState to set the Option

Definition at line 86 of file projectoptionsmanager.cpp.

87{
88 bool state = (bool)State;
89 uint mask = ASSISTANCE_WELCOME;
90
91 SetOption(state, mask);
92}

References ASSISTANCE_WELCOME, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetCaveatLector

void ProjectOptionsManager::SetCaveatLector ( Qt::CheckState State)
privateslot

Set Caveat Lector Option to desired State.

Parameters
StateState to set the Option

Definition at line 70 of file projectoptionsmanager.cpp.

71{
72 bool state = (bool)State;
73 uint mask = CAVEAT_LECTOR;
74
75 SetOption(state, mask);
76}

References CAVEAT_LECTOR, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetControlDocAccess

void ProjectOptionsManager::SetControlDocAccess ( Qt::CheckState State)
privateslot

Set Doc Access Option to desired State.

Parameters
StateState to set the Option

Definition at line 42 of file projectoptionsmanager.cpp.

43{
44 bool state = (bool)State;
45 uint mask = CONTROL_DOC_ACCESS;
46
47 SetOption(state, mask);
48 if (!state)
49 {
50 ui->OnlyInfoPage->setCheckable(true);
51 }
52}

References CONTROL_DOC_ACCESS, SetOption(), and ui.

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetCreateSourceArchive

void ProjectOptionsManager::SetCreateSourceArchive ( Qt::CheckState State)
privateslot

Definition at line 114 of file projectoptionsmanager.cpp.

115{
116 bool state = (bool)State;
117 uint mask = CREATE_SOURCE_ARCHIVE;
118 SetOption(state, mask);
119}

References CREATE_SOURCE_ARCHIVE, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetDonationsWelcome

void ProjectOptionsManager::SetDonationsWelcome ( Qt::CheckState State)
privateslot

Set Donations Welcome Option to desired State.

Parameters
StateState to set the Option

Definition at line 94 of file projectoptionsmanager.cpp.

95{
96 bool state = (bool)State;
97 uint mask = DONATIONS_WELCOME;
98
99 SetOption(state, mask);
100 if (!state)
101 {
102 ui->OfferPaypal->setChecked(false);
103 SetOfferPaypalDonation(Qt::Unchecked);
104 }
105}

References DONATIONS_WELCOME, SetOfferPaypalDonation(), SetOption(), and ui.

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetEnableCustomDoxygen

void ProjectOptionsManager::SetEnableCustomDoxygen ( Qt::CheckState State)
privateslot

Set Enable Custom Doxygen Option to desired State.

Parameters
StateState to set the Option

Definition at line 62 of file projectoptionsmanager.cpp.

63{
64 bool state = (bool)State;
65 uint mask = ENABLE_CUSTOM_DOXYGEN;
66
67 SetOption(state, mask);
68}

References ENABLE_CUSTOM_DOXYGEN, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetExcludeProjectList

void ProjectOptionsManager::SetExcludeProjectList ( Qt::CheckState State)
privateslot

Set Exclude Project Option to desired State.

Parameters
StateState to set the Option

Definition at line 26 of file projectoptionsmanager.cpp.

27{
28 bool state = (bool)State;
29 uint mask = EXCLUDE_PROJECT_LIST;
30
31 SetOption(state, mask);
32}

References EXCLUDE_PROJECT_LIST, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetGroupAccessOnly

void ProjectOptionsManager::SetGroupAccessOnly ( bool State)
privateslot

Definition at line 54 of file projectoptionsmanager.cpp.

55{
56 bool state = (bool)State;
57 uint mask = GROUP_ACCESS_ONLY;
58
59 SetOption(state, mask);
60}

References GROUP_ACCESS_ONLY, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetOfferPaypalDonation

void ProjectOptionsManager::SetOfferPaypalDonation ( Qt::CheckState State)
privateslot

Set Paypal Donation Option to desired State.

Parameters
StateState to set the Option

Definition at line 107 of file projectoptionsmanager.cpp.

108{
109 bool state = (bool)State;
110 uint mask = OFFER_PAYPAL_DONATION;
111 SetOption(state, mask);
112}

References OFFER_PAYPAL_DONATION, and SetOption().

Referenced by ProjectOptionsManager(), and SetDonationsWelcome().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetOnlyDefaultPage

void ProjectOptionsManager::SetOnlyDefaultPage ( bool State)
privateslot

Set Only Default Page Option to desired State.

Parameters
StateState to set the Option

Definition at line 34 of file projectoptionsmanager.cpp.

35{
36 bool state = (bool)State;
37 uint mask = ONLY_DEFAULT_PAGE;
38
39 SetOption(state, mask);
40}

References ONLY_DEFAULT_PAGE, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetOption()

void ProjectOptionsManager::SetOption ( bool State,
int Mask )
private

Set the Project's Selected Option to the Required State.

Parameters
StateOn (true) or Off (false)
MaskMask to identifiy the Option Bit

Definition at line 136 of file projectoptionsmanager.cpp.

137{
138 if (State) project_options |= Mask; else project_options &= ~Mask;
140}
void SendOptionState(uint ProjectOptions)
Set the Project's Options State.

References project_options, and SendOptionState().

Referenced by SetAllowAutomaticInstall(), SetAssistanceWelcome(), SetCaveatLector(), SetControlDocAccess(), SetCreateSourceArchive(), SetDonationsWelcome(), SetEnableCustomDoxygen(), SetExcludeProjectList(), SetGroupAccessOnly(), SetOfferPaypalDonation(), SetOnlyDefaultPage(), SetPotentialHazard(), and SetUpdateGitRevision().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetPotentialHazard

void ProjectOptionsManager::SetPotentialHazard ( Qt::CheckState State)
privateslot

Definition at line 78 of file projectoptionsmanager.cpp.

79{
80 bool state = (bool)State;
81 uint mask = POTENTIAL_HAZARD;
82
83 SetOption(state, mask);
84}

References POTENTIAL_HAZARD, and SetOption().

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetUpdateGitRevision

void ProjectOptionsManager::SetUpdateGitRevision ( Qt::CheckState State)
privateslot

Set the Update Git Revision Option to desired state.

Parameters
StateState to set the Option

Definition at line 121 of file projectoptionsmanager.cpp.

122{
123 bool state = (bool)State;
124 uint mask = UPDATE_GIT_REVISION;
125 SetOption(state, mask);
126}

References SetOption(), and UPDATE_GIT_REVISION.

Referenced by ProjectOptionsManager().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteOptionState()

uint ProjectOptionsManager::WriteOptionState ( void )

Get the Options Encoded from User Interface.

Returns
Encoded List of Options

Definition at line 192 of file projectoptionsmanager.cpp.

193{
194 uint option_state = 0;
195
196 if (ui->ExcludeFromProjectList->isChecked()) option_state |= EXCLUDE_PROJECT_LIST;
197 if (ui->ControlDocAccess->isChecked()) option_state |= CONTROL_DOC_ACCESS;
198 if (ui->OnlyInfoPage->isChecked()) option_state |= ONLY_DEFAULT_PAGE;
199 if (ui->LimitToAssoc->isChecked()) option_state |= GROUP_ACCESS_ONLY;
200 if (ui->EnableDoxyOptions->isChecked()) option_state |= ENABLE_CUSTOM_DOXYGEN;
201 if (ui->CaveatLector->isChecked()) option_state |= CAVEAT_LECTOR;
202 if (ui->PossiblyHazardous->isChecked()) option_state |= POTENTIAL_HAZARD;
203 if (ui->AssistanceWelcome->isChecked()) option_state |= ASSISTANCE_WELCOME;
204 if (ui->DonationsWelcome->isChecked()) option_state|= DONATIONS_WELCOME;
205 if (ui->OfferPaypal->isChecked()) option_state |= OFFER_PAYPAL_DONATION;
206 if (ui->CreateSourceArchive->isChecked()) option_state |= CREATE_SOURCE_ARCHIVE;
207 if (ui->AutomaticInstall->isChecked()) option_state |= ALLOW_AUTOMATIC_INSTALL;
208
209 LogAdd(LOG_DEBUG, MODE_OPERATOR, "Project's Encoded Options loaded into display");
210
211 return(option_state);
212}

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.

Here is the call graph for this function:

Field Documentation

◆ project_options

uint ProjectOptionsManager::project_options
private

Encoded Project Options Storage.

Definition at line 187 of file projectoptionsmanager.h.

Referenced by DoClear(), ProjectOptionsManager(), and SetOption().

◆ ui

Ui::MainWindow* ProjectOptionsManager::ui
private

brief Pointer to the main window

Definition at line 181 of file projectoptionsmanager.h.

Referenced by DoClear(), ProjectOptionsManager(), ReadOptionState(), SetControlDocAccess(), SetDonationsWelcome(), and WriteOptionState().


The documentation for this class was generated from the following files: