albaGUIApplicationSettings Class Reference

#include <albaGUIApplicationSettings.h>

Inheritance diagram for albaGUIApplicationSettings:

Collaboration diagram for albaGUIApplicationSettings:

Public Types
enum	APP_SETTINGS_WIDGET_ID { ID_LOG_TO_FILE = MINID , ID_LOG_DIR , ID_WARN_UNDO , ID_AUTOSAVE }

Public Member Functions
	albaGUIApplicationSettings (albaObserver *Listener, const albaString &label=_("Application"))
	~albaGUIApplicationSettings ()
void	OnEvent (albaEventBase *alba_event)
bool	GetLogToFileStatus ()
void	SetLogFileStatus (int log_status)
void	SetAutoSave (int autoSave)
albaString &	GetLogFolder ()
void	SetLogFolder (albaString log_folder)
bool	GetWarnUserFlag ()
void	EnableLogDirChoices ()
void	DisableLogDirChoices ()
bool	IsAutoSaveOn ()
int *	GetAutoSave ()
Public Member Functions inherited from albaGUISettings
	albaGUISettings (albaObserver *Listener, const albaString &label=_("Settings"))
	~albaGUISettings ()
virtual void	OnEvent (albaEventBase *alba_event)
void	SetListener (albaObserver *Listener)
albaGUI *	GetGui ()
const char *	GetLabel ()
Public Member Functions inherited from albaObserver
	albaObserver ()
virtual	~albaObserver ()
virtual void	OnEvent (albaEventBase *e)=0

Protected Member Functions
void	CreateGui ()
void	InitializeSettings ()
void	EnableItems ()
virtual void	CreateGui ()
virtual void	InitializeSettings ()

Protected Attributes
int	m_LogToFile
albaString	m_LogFolder
int	m_WarnUserFlag
bool	m_EnableLogDirChoices
int	m_AutoSaveProject
Protected Attributes inherited from albaGUISettings
albaGUI *	m_Gui
albaString	m_Label
wxConfig *	m_Config
albaObserver *	m_Listener

Detailed Description

Class Name: albaGUIApplicationSettings.

Class that contains several application options like:

• logging to file
• logging verbosity
• logging directory
• Undo warning
• passphrase for data encryption
• default image type when saving a snapshot

Definition at line 36 of file albaGUIApplicationSettings.h.

Member Enumeration Documentation

APP_SETTINGS_WIDGET_ID

enum albaGUIApplicationSettings::APP_SETTINGS_WIDGET_ID

GUI IDs.

Enumerator
ID_LOG_TO_FILE
ID_LOG_DIR
ID_WARN_UNDO
ID_AUTOSAVE

Definition at line 45 of file albaGUIApplicationSettings.h.

Constructor & Destructor Documentation

albaGUIApplicationSettings()

albaGUIApplicationSettings::albaGUIApplicationSettings	(	albaObserver *	Listener,
		const albaString &	label = _("Application")
	)

constructor .

~albaGUIApplicationSettings()

albaGUIApplicationSettings::~albaGUIApplicationSettings

(

)

destructor .

Member Function Documentation

OnEvent()

void albaGUIApplicationSettings::OnEvent ( albaEventBase *  alba_event )

virtual

Answer to the messages coming from interface.

Reimplemented from albaGUISettings.

GetLogToFileStatus()

bool albaGUIApplicationSettings::GetLogToFileStatus ( )

inline

Return true if Log To File is enabled.

Definition at line 57 of file albaGUIApplicationSettings.h.

SetLogFileStatus()

void albaGUIApplicationSettings::SetLogFileStatus

(

int

log_status

)

Set the log status flag.

SetAutoSave()

void albaGUIApplicationSettings::SetAutoSave

(

int

autoSave

)

Enable/Disable AutoSave Project.

GetLogFolder()

albaString & albaGUIApplicationSettings::GetLogFolder ( )

inline

Return the folder in which store the log files.

Definition at line 66 of file albaGUIApplicationSettings.h.

SetLogFolder()

void albaGUIApplicationSettings::SetLogFolder

(

albaString

log_folder

)

Set a folder name for the log file.

GetWarnUserFlag()

bool albaGUIApplicationSettings::GetWarnUserFlag ( )

inline

Return the status of the WarnUser flag.

Definition at line 72 of file albaGUIApplicationSettings.h.

EnableLogDirChoices()

void albaGUIApplicationSettings::EnableLogDirChoices ( )

inline

Enable the possibility to choose log directory.

Definition at line 75 of file albaGUIApplicationSettings.h.

DisableLogDirChoices()

void albaGUIApplicationSettings::DisableLogDirChoices ( )

inline

Disable the possibility to choose log directory.

Definition at line 77 of file albaGUIApplicationSettings.h.

IsAutoSaveOn()

bool albaGUIApplicationSettings::IsAutoSaveOn ( )

inline

Definition at line 79 of file albaGUIApplicationSettings.h.

GetAutoSave()

int * albaGUIApplicationSettings::GetAutoSave ( )

inline

Definition at line 80 of file albaGUIApplicationSettings.h.

CreateGui()

void albaGUIApplicationSettings::CreateGui ( )

protectedvirtual

Create the GUI for the setting panel.

Reimplemented from albaGUISettings.

InitializeSettings()

void albaGUIApplicationSettings::InitializeSettings ( )

protectedvirtual

Initialize the application settings.

Reimplemented from albaGUISettings.

EnableItems()

void albaGUIApplicationSettings::EnableItems ( )

protected

Used to enable/disable items according to the current widgets state.

Member Data Documentation

m_LogToFile

int albaGUIApplicationSettings::m_LogToFile

protected

Flag used to store the On-Off state of log to file mechanism.

Definition at line 93 of file albaGUIApplicationSettings.h.

m_LogFolder

albaString albaGUIApplicationSettings::m_LogFolder

protected

Flag used to store the log folder.

Definition at line 94 of file albaGUIApplicationSettings.h.

m_WarnUserFlag

int albaGUIApplicationSettings::m_WarnUserFlag

protected

Warn user flag on not supported undo operations.

Definition at line 96 of file albaGUIApplicationSettings.h.

m_EnableLogDirChoices

bool albaGUIApplicationSettings::m_EnableLogDirChoices

protected

Definition at line 98 of file albaGUIApplicationSettings.h.

m_AutoSaveProject

int albaGUIApplicationSettings::m_AutoSaveProject

protected

Definition at line 100 of file albaGUIApplicationSettings.h.

---

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

• albaGUIApplicationSettings.h