openfluid::base::PreferencesManager Class Reference

#include <base/PreferencesManager.hpp>

Classes
struct	ExternalTool_t
struct	SyntaxHighlightingRule_t
struct	WindowGeometry_t

Public Types
enum class	ExternalToolContext { WORKSPACE , WARE , FILE }
typedef std::map< std::string, SyntaxHighlightingRule_t >	SyntaxHighlightingRules_t

Public Member Functions
std::string	getSettingsFile () const
void	setUILanguage (const std::string &Lang)
std::string	getUILanguage () const
void	setWorkspacesPaths (const std::vector< std::string > &Paths)
std::vector< std::string >	getWorkspacesPaths () const
std::string	getCurrentWorkspacePath () const
void	setAppWindowGeometry (const std::string &AppSettings, const WindowGeometry_t &Geometry)
WindowGeometry_t	getAppWindowGeometry (const std::string &AppSettings) const
void	setBuilderExtraSimulatorsPaths (const std::vector< std::string > &Paths)
void	addBuilderExtraSimulatorsPath (const std::string &Path)
void	removeBuilderExtraSimulatorsPath (const std::string &Path)
std::vector< std::string >	getBuilderExtraSimulatorsPaths () const
void	setBuilderExtraExtensionsPaths (const std::vector< std::string > &Paths)
void	addBuilderExtraExtensionsPath (const std::string &Path)
void	removeBuilderExtraExtensionsPath (const std::string &Path)
std::vector< std::string >	getBuilderExtraExtensionsPaths () const
void	setBuilderExtraObserversPaths (const std::vector< std::string > &Paths)
void	addBuilderExtraObserversPath (const std::string &Path)
void	removeBuilderExtraObserversPath (const std::string &Path)
std::vector< std::string >	getBuilderExtraObserversPaths () const
void	setBuilderDeltaT (openfluid::core::Duration_t DeltaT)
openfluid::core::Duration_t	getBuilderDeltaT () const
void	setBuilderBeginDate (const std::string &Begin)
std::string	getBuilderBeginDate () const
void	setBuilderEndDate (const std::string &End)
std::string	getBuilderEndDate () const
int	getBuilderDockArea () const
void	setBuilderDockArea (int Area)
int	getBuilderToolBarArea () const
void	setBuilderToolBarArea (int Area)
bool	isBuilderWareRemovalConfirm () const
void	setBuilderWareRemovalConfirm (bool Confirm)
bool	isBuilderParamRemovalConfirm () const
void	setBuilderParamRemovalConfirm (bool Confirm)
bool	isBuilderWaresWatchersActive () const
void	setBuilderWaresWatchersActive (bool Active)
bool	isBuilderAutomaticSaveBeforeRun () const
void	setBuilderAutomaticSaveBeforeRun (bool AutoSave)
bool	isBuilderSpatialUnitsRemovalConfirm () const
void	setBuilderSpatialUnitsRemovalConfirm (bool Confirm)
bool	isBuilderSpatialConnsRemovalConfirm () const
void	setBuilderSpatialConnsRemovalConfirm (bool Confirm)
bool	isBuilderSpatialAttrsRemovalConfirm () const
void	setBuilderSpatialAttrsRemovalConfirm (bool Confirm)
bool	isBuilderSkipGhostMigration () const
void	setBuilderSkipGhostMigration (bool Skip)
bool	isWaresdevAutomaticSaveBeforeBuild () const
void	setWaresdevAutomaticSaveBeforeBuild (bool AutoSave)
std::list< ExternalTool_t >	getWaresdevExternalTools () const
std::list< ExternalTool_t >	getWaresdevExternalToolsInContext (const ExternalToolContext Context) const
void	setWaresdevExternalTools (const std::list< ExternalTool_t > &Tools)
void	setWaresdevTextEditorDefaults (bool ForceReset)
bool	isWaresdevSyntaxHighlightingEnabled () const
void	setWaresdevSyntaxHighlightingEnabled (bool Enabled)
SyntaxHighlightingRules_t	getWaresdevSyntaxHighlightingRules () const
void	setWaresdevSyntaxHighlightingRules (const SyntaxHighlightingRules_t &Rules)
bool	isWaresdevCurrentlineHighlightingEnabled () const
void	setWaresdevCurrentlineHighlightingEnabled (bool Enabled)
std::string	getWaresdevCurrentlineColor () const
void	setWaresdevCurrentlineColor (const std::string &Color)
std::string	getWaresdevFontName () const
void	setWaresdevFontName (const std::string &FontName)
bool	isWaresdevLineWrappingEnabled () const
void	setWaresdevLineWrappingEnabled (bool Enabled)
int	getWaresdevIndentSpaceNb () const
bool	isWaresdevSpaceTabDisplayEnabled () const
void	setWaresdevSpaceTabDisplayEnabled (bool Enabled)
bool	isWaresdevCarriageReturnDisplayEnabled () const
void	setWaresdevCarriageReturnDisplayEnabled (bool Enabled)
void	setWaresdevIndentSpaceNb (int SpaceNumber)
std::string	getWaresdevConfigureEnv (const std::string &Name) const
void	setWaresdevConfigureEnv (const std::string &Name, const std::string &Value)
std::string	getWaresdevConfigureOptions () const
void	setWaresdevConfigureOptions (const std::string &Options)
std::string	getWaresdevConfigureGenerator () const
void	setWaresdevConfigureGenerator (const std::string &Generator)
std::string	getWaresdevBuildEnv (const std::string &Name) const
void	setWaresdevBuildEnv (const std::string &Name, const std::string &Value)
bool	isWaresdevShowCommandEnv (const std::string &Name) const
void	setWaresdevShowCommandEnv (const std::string &Name, bool Enabled)
bool	isWaresdevGitSslNoVerify () const
void	setWaresdevGitSslNoVerify (bool NoVerify)
bool	isWaresdevCheckoutCurrentVersion () const
void	setWaresdevCheckoutCurrentVersion (bool CheckoutCurrentVersion)
std::string	getWaresdevImportHubUrl () const
void	setWaresdevImportHubUrl (const std::string &Url)
std::string	getWaresdevImportHubUsername () const
void	setWaresdevImportHubUsername (const std::string &Username)

Static Public Member Functions
static void	setSettingsFile (const std::string &FilePath)
static std::vector< std::string >	getAvailableUILanguages ()
static bool	isUILanguageAvailable (const std::string &Lang)

Member Typedef Documentation

SyntaxHighlightingRules_t

typedef std::map<std::string, SyntaxHighlightingRule_t> openfluid::base::PreferencesManager::SyntaxHighlightingRules_t

Member Enumeration Documentation

ExternalToolContext

enum openfluid::base::PreferencesManager::ExternalToolContext

strong

Enumerator
WORKSPACE
WARE
FILE

Member Function Documentation

addBuilderExtraExtensionsPath()

void openfluid::base::PreferencesManager::addBuilderExtraExtensionsPath

(

const std::string &

Path

)

addBuilderExtraObserversPath()

void openfluid::base::PreferencesManager::addBuilderExtraObserversPath

(

const std::string &

Path

)

addBuilderExtraSimulatorsPath()

void openfluid::base::PreferencesManager::addBuilderExtraSimulatorsPath

(

const std::string &

Path

)

getAppWindowGeometry()

WindowGeometry_t openfluid::base::PreferencesManager::getAppWindowGeometry

(

const std::string &

AppSettings

)

const

getAvailableUILanguages()

static std::vector<std::string> openfluid::base::PreferencesManager::getAvailableUILanguages ( )

static

getBuilderBeginDate()

std::string openfluid::base::PreferencesManager::getBuilderBeginDate

(

)

const

getBuilderDeltaT()

openfluid::core::Duration_t openfluid::base::PreferencesManager::getBuilderDeltaT

(

)

const

getBuilderDockArea()

int openfluid::base::PreferencesManager::getBuilderDockArea

(

)

const

getBuilderEndDate()

std::string openfluid::base::PreferencesManager::getBuilderEndDate

(

)

const

getBuilderExtraExtensionsPaths()

std::vector<std::string> openfluid::base::PreferencesManager::getBuilderExtraExtensionsPaths

(

)

const

getBuilderExtraObserversPaths()

std::vector<std::string> openfluid::base::PreferencesManager::getBuilderExtraObserversPaths

(

)

const

getBuilderExtraSimulatorsPaths()

std::vector<std::string> openfluid::base::PreferencesManager::getBuilderExtraSimulatorsPaths

(

)

const

getBuilderToolBarArea()

int openfluid::base::PreferencesManager::getBuilderToolBarArea

(

)

const

getCurrentWorkspacePath()

std::string openfluid::base::PreferencesManager::getCurrentWorkspacePath

(

)

const

getSettingsFile()

std::string openfluid::base::PreferencesManager::getSettingsFile

(

)

const

getUILanguage()

std::string openfluid::base::PreferencesManager::getUILanguage

(

)

const

getWaresdevBuildEnv()

std::string openfluid::base::PreferencesManager::getWaresdevBuildEnv

(

const std::string &

Name

)

const

getWaresdevConfigureEnv()

std::string openfluid::base::PreferencesManager::getWaresdevConfigureEnv

(

const std::string &

Name

)

const

getWaresdevConfigureGenerator()

std::string openfluid::base::PreferencesManager::getWaresdevConfigureGenerator

(

)

const

getWaresdevConfigureOptions()

std::string openfluid::base::PreferencesManager::getWaresdevConfigureOptions

(

)

const

getWaresdevCurrentlineColor()

std::string openfluid::base::PreferencesManager::getWaresdevCurrentlineColor

(

)

const

getWaresdevExternalTools()

std::list<ExternalTool_t> openfluid::base::PreferencesManager::getWaresdevExternalTools

(

)

const

getWaresdevExternalToolsInContext()

std::list<ExternalTool_t> openfluid::base::PreferencesManager::getWaresdevExternalToolsInContext

(

const ExternalToolContext

Context

)

const

getWaresdevFontName()

std::string openfluid::base::PreferencesManager::getWaresdevFontName

(

)

const

getWaresdevImportHubUrl()

std::string openfluid::base::PreferencesManager::getWaresdevImportHubUrl

(

)

const

getWaresdevImportHubUsername()

std::string openfluid::base::PreferencesManager::getWaresdevImportHubUsername

(

)

const

getWaresdevIndentSpaceNb()

int openfluid::base::PreferencesManager::getWaresdevIndentSpaceNb

(

)

const

getWaresdevSyntaxHighlightingRules()

SyntaxHighlightingRules_t openfluid::base::PreferencesManager::getWaresdevSyntaxHighlightingRules

(

)

const

getWorkspacesPaths()

std::vector<std::string> openfluid::base::PreferencesManager::getWorkspacesPaths

(

)

const

isBuilderAutomaticSaveBeforeRun()

bool openfluid::base::PreferencesManager::isBuilderAutomaticSaveBeforeRun

(

)

const

isBuilderParamRemovalConfirm()

bool openfluid::base::PreferencesManager::isBuilderParamRemovalConfirm

(

)

const

isBuilderSkipGhostMigration()

bool openfluid::base::PreferencesManager::isBuilderSkipGhostMigration

(

)

const

isBuilderSpatialAttrsRemovalConfirm()

bool openfluid::base::PreferencesManager::isBuilderSpatialAttrsRemovalConfirm

(

)

const

isBuilderSpatialConnsRemovalConfirm()

bool openfluid::base::PreferencesManager::isBuilderSpatialConnsRemovalConfirm

(

)

const

isBuilderSpatialUnitsRemovalConfirm()

bool openfluid::base::PreferencesManager::isBuilderSpatialUnitsRemovalConfirm

(

)

const

isBuilderWareRemovalConfirm()

bool openfluid::base::PreferencesManager::isBuilderWareRemovalConfirm

(

)

const

isBuilderWaresWatchersActive()

bool openfluid::base::PreferencesManager::isBuilderWaresWatchersActive

(

)

const

isUILanguageAvailable()

static bool openfluid::base::PreferencesManager::isUILanguageAvailable ( const std::string &  Lang )

static

isWaresdevAutomaticSaveBeforeBuild()

bool openfluid::base::PreferencesManager::isWaresdevAutomaticSaveBeforeBuild

(

)

const

isWaresdevCarriageReturnDisplayEnabled()

bool openfluid::base::PreferencesManager::isWaresdevCarriageReturnDisplayEnabled

(

)

const

isWaresdevCheckoutCurrentVersion()

bool openfluid::base::PreferencesManager::isWaresdevCheckoutCurrentVersion

(

)

const

isWaresdevCurrentlineHighlightingEnabled()

bool openfluid::base::PreferencesManager::isWaresdevCurrentlineHighlightingEnabled

(

)

const

isWaresdevGitSslNoVerify()

bool openfluid::base::PreferencesManager::isWaresdevGitSslNoVerify

(

)

const

isWaresdevLineWrappingEnabled()

bool openfluid::base::PreferencesManager::isWaresdevLineWrappingEnabled

(

)

const

isWaresdevShowCommandEnv()

bool openfluid::base::PreferencesManager::isWaresdevShowCommandEnv

(

const std::string &

Name

)

const

isWaresdevSpaceTabDisplayEnabled()

bool openfluid::base::PreferencesManager::isWaresdevSpaceTabDisplayEnabled

(

)

const

isWaresdevSyntaxHighlightingEnabled()

bool openfluid::base::PreferencesManager::isWaresdevSyntaxHighlightingEnabled

(

)

const

removeBuilderExtraExtensionsPath()

void openfluid::base::PreferencesManager::removeBuilderExtraExtensionsPath

(

const std::string &

Path

)

removeBuilderExtraObserversPath()

void openfluid::base::PreferencesManager::removeBuilderExtraObserversPath

(

const std::string &

Path

)

removeBuilderExtraSimulatorsPath()

void openfluid::base::PreferencesManager::removeBuilderExtraSimulatorsPath

(

const std::string &

Path

)

setAppWindowGeometry()

void openfluid::base::PreferencesManager::setAppWindowGeometry	(	const std::string &	AppSettings,
		const WindowGeometry_t &	Geometry
	)

setBuilderAutomaticSaveBeforeRun()

void openfluid::base::PreferencesManager::setBuilderAutomaticSaveBeforeRun

(

bool

AutoSave

)

setBuilderBeginDate()

void openfluid::base::PreferencesManager::setBuilderBeginDate

(

const std::string &

Begin

)

setBuilderDeltaT()

void openfluid::base::PreferencesManager::setBuilderDeltaT

(

openfluid::core::Duration_t

DeltaT

)

setBuilderDockArea()

void openfluid::base::PreferencesManager::setBuilderDockArea

(

int

Area

)

setBuilderEndDate()

void openfluid::base::PreferencesManager::setBuilderEndDate

(

const std::string &

End

)

setBuilderExtraExtensionsPaths()

void openfluid::base::PreferencesManager::setBuilderExtraExtensionsPaths

(

const std::vector< std::string > &

Paths

)

setBuilderExtraObserversPaths()

void openfluid::base::PreferencesManager::setBuilderExtraObserversPaths

(

const std::vector< std::string > &

Paths

)

setBuilderExtraSimulatorsPaths()

void openfluid::base::PreferencesManager::setBuilderExtraSimulatorsPaths

(

const std::vector< std::string > &

Paths

)

setBuilderParamRemovalConfirm()

void openfluid::base::PreferencesManager::setBuilderParamRemovalConfirm

(

bool

Confirm

)

setBuilderSkipGhostMigration()

void openfluid::base::PreferencesManager::setBuilderSkipGhostMigration

(

bool

Skip

)

setBuilderSpatialAttrsRemovalConfirm()

void openfluid::base::PreferencesManager::setBuilderSpatialAttrsRemovalConfirm

(

bool

Confirm

)

setBuilderSpatialConnsRemovalConfirm()

void openfluid::base::PreferencesManager::setBuilderSpatialConnsRemovalConfirm

(

bool

Confirm

)

setBuilderSpatialUnitsRemovalConfirm()

void openfluid::base::PreferencesManager::setBuilderSpatialUnitsRemovalConfirm

(

bool

Confirm

)

setBuilderToolBarArea()

void openfluid::base::PreferencesManager::setBuilderToolBarArea

(

int

Area

)

setBuilderWareRemovalConfirm()

void openfluid::base::PreferencesManager::setBuilderWareRemovalConfirm

(

bool

Confirm

)

setBuilderWaresWatchersActive()

void openfluid::base::PreferencesManager::setBuilderWaresWatchersActive

(

bool

Active

)

setSettingsFile()

static void openfluid::base::PreferencesManager::setSettingsFile ( const std::string &  FilePath )

static

Used only if another file is used as the settings file instead of the default one (e.g. for testing). To be set before the first call of instance().

setUILanguage()

void openfluid::base::PreferencesManager::setUILanguage

(

const std::string &

Lang

)

setWaresdevAutomaticSaveBeforeBuild()

void openfluid::base::PreferencesManager::setWaresdevAutomaticSaveBeforeBuild

(

bool

AutoSave

)

setWaresdevBuildEnv()

void openfluid::base::PreferencesManager::setWaresdevBuildEnv	(	const std::string &	Name,
		const std::string &	Value
	)

setWaresdevCarriageReturnDisplayEnabled()

void openfluid::base::PreferencesManager::setWaresdevCarriageReturnDisplayEnabled

(

bool

Enabled

)

setWaresdevCheckoutCurrentVersion()

void openfluid::base::PreferencesManager::setWaresdevCheckoutCurrentVersion

(

bool

CheckoutCurrentVersion

)

setWaresdevConfigureEnv()

void openfluid::base::PreferencesManager::setWaresdevConfigureEnv	(	const std::string &	Name,
		const std::string &	Value
	)

setWaresdevConfigureGenerator()

void openfluid::base::PreferencesManager::setWaresdevConfigureGenerator

(

const std::string &

Generator

)

setWaresdevConfigureOptions()

void openfluid::base::PreferencesManager::setWaresdevConfigureOptions

(

const std::string &

Options

)

setWaresdevCurrentlineColor()

void openfluid::base::PreferencesManager::setWaresdevCurrentlineColor

(

const std::string &

Color

)

setWaresdevCurrentlineHighlightingEnabled()

void openfluid::base::PreferencesManager::setWaresdevCurrentlineHighlightingEnabled

(

bool

Enabled

)

setWaresdevExternalTools()

void openfluid::base::PreferencesManager::setWaresdevExternalTools

(

const std::list< ExternalTool_t > &

Tools

)

setWaresdevFontName()

void openfluid::base::PreferencesManager::setWaresdevFontName

(

const std::string &

FontName

)

setWaresdevGitSslNoVerify()

void openfluid::base::PreferencesManager::setWaresdevGitSslNoVerify

(

bool

NoVerify

)

setWaresdevImportHubUrl()

void openfluid::base::PreferencesManager::setWaresdevImportHubUrl

(

const std::string &

Url

)

setWaresdevImportHubUsername()

void openfluid::base::PreferencesManager::setWaresdevImportHubUsername

(

const std::string &

Username

)

setWaresdevIndentSpaceNb()

void openfluid::base::PreferencesManager::setWaresdevIndentSpaceNb

(

int

SpaceNumber

)

setWaresdevLineWrappingEnabled()

void openfluid::base::PreferencesManager::setWaresdevLineWrappingEnabled

(

bool

Enabled

)

setWaresdevShowCommandEnv()

void openfluid::base::PreferencesManager::setWaresdevShowCommandEnv	(	const std::string &	Name,
		bool	Enabled
	)

setWaresdevSpaceTabDisplayEnabled()

void openfluid::base::PreferencesManager::setWaresdevSpaceTabDisplayEnabled

(

bool

Enabled

)

setWaresdevSyntaxHighlightingEnabled()

void openfluid::base::PreferencesManager::setWaresdevSyntaxHighlightingEnabled

(

bool

Enabled

)

setWaresdevSyntaxHighlightingRules()

void openfluid::base::PreferencesManager::setWaresdevSyntaxHighlightingRules

(

const SyntaxHighlightingRules_t &

Rules

)

setWaresdevTextEditorDefaults()

void openfluid::base::PreferencesManager::setWaresdevTextEditorDefaults

(

bool

ForceReset

)

setWorkspacesPaths()

void openfluid::base::PreferencesManager::setWorkspacesPaths

(

const std::vector< std::string > &

Paths

)

---

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

• base/PreferencesManager.hpp