napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamares] Tidy up boolean options in Settings

Browse Source 
- The const getters for a single boolean value have moved
   to the header, for inlining.
 - Document the getters and what their settings mean.
This commit is contained in:
Adriaan de Groot 2020-02-05 13:35:26 +01:00
parent 21aec96e2e
commit 91625c8ba8
2 changed files with 25 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/libcalamares/Settings.cpp
View File

@ -265,37 +265,4 @@ Settings::brandingComponentName() const
return m_brandingComponentName;
}
bool
Settings::showPromptBeforeExecution() const
{
return m_promptInstall;
}
bool
Settings::debugMode() const
{
return m_debug;
}
bool
Settings::doChroot() const
{
return m_doChroot;
}
bool
Settings::disableCancel() const
{
return m_disableCancel;
}
bool
Settings::disableCancelDuringExec() const
{
return m_disableCancelDuringExec;
}
} // namespace Calamares

30
src/libcalamares/Settings.h
View File

@ -51,11 +51,31 @@ public:
QString brandingComponentName() const;
bool showPromptBeforeExecution() const;
/** @brief Is this a debugging run?
*
* Returns true if Calamares is in debug mode. In debug mode,
* modules and settings are loaded from more locations, to help
* development and debugging.
*/
bool debugMode() const { return m_debug; }
bool debugMode() const;
/** @brief Distinguish "install" from "OEM" modes.
*
* Returns true in "install" mode, which is where actions happen
* in a chroot -- the target system, which exists separately from
* the source system. In "OEM" mode, returns false and most actions
* apply to the *current* (host) system.
*/
bool doChroot() const { return m_doChroot; }
/** @brief Global setting of prompt-before-install.
*
* Returns true when the configuration is such that the user
* should be prompted one-last-time before any action is taken
* that really affects the machine.
*/
bool showPromptBeforeExecution() const { return m_promptInstall; }
bool doChroot() const;
/** @brief Distinguish between "install" and "setup" modes.
*
* This influences user-visible strings, for instance using the
@ -64,9 +84,9 @@ public:
bool isSetupMode() const { return m_isSetupMode; }
/** @brief Global setting of disable-cancel: can't cancel ever. */
bool disableCancel() const;
bool disableCancel() const { return m_disableCancel; }
/** @brief Temporary setting of disable-cancel: can't cancel during exec. */
bool disableCancelDuringExec() const;
bool disableCancelDuringExec() const { return m_disableCancelDuringExec; }
private:
static Settings* s_instance;