VidaliaSettings Class Reference

#include <vidaliasettings.h>

Inheritance diagram for VidaliaSettings:

VSettings ServiceSettings List of all members.

Public Member Functions

 VidaliaSettings ()
QString getLanguageCode ()
void setLanguageCode (QString languageCode)
QString getInterfaceStyle ()
void setInterfaceStyle (QString styleKey)
bool runTorAtStart ()
void setRunTorAtStart (bool run)
bool showMainWindowAtStart ()
void setShowMainWindowAtStart (bool show)
bool runVidaliaOnBoot ()
void setRunVidaliaOnBoot (bool run)
QString getBrowserExecutable () const
void setBrowserExecutable (const QString &browserExecutable)
QString getBrowserDirectory () const
void setBrowserDirectory (const QString &browserDirectory)
QString getIMExecutable () const
void setIMExecutable (const QString &IMExecutable)
bool runProxyAtStart ()
void setRunProxyAtStart (bool run)
QString getProxyExecutable () const
void setProxyExecutable (const QString &proxyExecutable)
QStringList getProxyExecutableArguments () const
void setProxyExecutableArguments (const QStringList &proxyExecutableArguments)

Detailed Description

Handles saving and restoring Vidalia's settings, such as the location of Tor, the control port, etc.

NOTE: Qt 4.1 documentation states that constructing a QSettings object is "very fast", so we shouldn't need to create a global instance of this class.

Definition at line 30 of file vidaliasettings.h.


Constructor & Destructor Documentation

VidaliaSettings::VidaliaSettings (  ) 

Default constructor.

Definition at line 48 of file vidaliasettings.cpp.

References LanguageSupport::defaultLanguageCode(), VSettings::setDefault(), SETTING_BROWSER_EXECUTABLE, SETTING_IM_EXECUTABLE, SETTING_LANGUAGE, SETTING_PROXY_EXECUTABLE, SETTING_PROXY_EXECUTABLE_ARGUMENTS, SETTING_RUN_PROXY_AT_START, SETTING_RUN_TOR_AT_START, SETTING_SHOW_MAINWINDOW_AT_START, and SETTING_STYLE.


Member Function Documentation

QString VidaliaSettings::getBrowserDirectory (  )  const

Returns a fully-qualified path to the web browser directory

Definition at line 190 of file vidaliasettings.cpp.

References SETTING_BROWSER_DIRECTORY, and VSettings::value().

Referenced by MainWindow::launchBrowserFromDirectory(), MainWindow::onSubprocessFinished(), MainWindow::shutdown(), and MainWindow::startSubprocesses().

QString VidaliaSettings::getBrowserExecutable (  )  const

If browserDirectory is empty, returns a fully-qualified path to the web browser, including the executable name. If browserDirectory is set, then returns the basename of the configured web browser

Definition at line 175 of file vidaliasettings.cpp.

References SETTING_BROWSER_EXECUTABLE, and VSettings::value().

Referenced by MainWindow::launchBrowserFromDirectory(), MainWindow::onCheckForBrowser(), MainWindow::onSubprocessFinished(), MainWindow::shutdown(), and MainWindow::startSubprocesses().

QString VidaliaSettings::getIMExecutable (  )  const

Returns a fully-qualified path to the IM client, including the executable name.

Definition at line 206 of file vidaliasettings.cpp.

References SETTING_IM_EXECUTABLE, and VSettings::value().

Referenced by MainWindow::onSubprocessFinished(), and MainWindow::startSubprocesses().

QString VidaliaSettings::getInterfaceStyle (  ) 

Gets the interface style key (e.g., "windows", "motif", etc.)

Definition at line 93 of file vidaliasettings.cpp.

References SETTING_STYLE, and VSettings::value().

QString VidaliaSettings::getLanguageCode (  ) 

Gets the currently preferred language code for Vidalia.

Definition at line 79 of file vidaliasettings.cpp.

References SETTING_LANGUAGE, and VSettings::value().

Referenced by AppearancePage::load().

QString VidaliaSettings::getProxyExecutable (  )  const

Returns a fully-qualified path to the proxy server, including the executable name.

Definition at line 237 of file vidaliasettings.cpp.

References SETTING_PROXY_EXECUTABLE, and VSettings::value().

Referenced by GeneralPage::load(), and MainWindow::startProxy().

QStringList VidaliaSettings::getProxyExecutableArguments (  )  const

Returns a list containing additional command line arguments to be passed to ProxyExecutable

Definition at line 253 of file vidaliasettings.cpp.

References SETTING_PROXY_EXECUTABLE_ARGUMENTS, and VSettings::value().

Referenced by GeneralPage::load(), and MainWindow::startProxy().

bool VidaliaSettings::runProxyAtStart (  ) 

Returns true if Vidalia should start a proxy application when it starts.

Definition at line 222 of file vidaliasettings.cpp.

References SETTING_RUN_PROXY_AT_START, and VSettings::value().

Referenced by GeneralPage::load(), and MainWindow::running().

bool VidaliaSettings::runTorAtStart (  ) 

Returns true if Vidalia should start Tor when it starts.

Definition at line 107 of file vidaliasettings.cpp.

References SETTING_RUN_TOR_AT_START, and VSettings::value().

Referenced by GeneralPage::load(), and MainWindow::running().

bool VidaliaSettings::runVidaliaOnBoot (  ) 

Returns true if Vidalia should start on system boot.

Definition at line 137 of file vidaliasettings.cpp.

References win32_registry_get_key_value().

Referenced by GeneralPage::load().

void VidaliaSettings::setBrowserDirectory ( const QString &  browserDirectory  ) 

Sets the location and name of the web browser directory to the given string. If set to the empty string, the browser will not be started.

Definition at line 198 of file vidaliasettings.cpp.

References SETTING_BROWSER_DIRECTORY, and VSettings::setValue().

void VidaliaSettings::setBrowserExecutable ( const QString &  browserExecutable  ) 

Sets the location and name of the web browser executable to the given string. If set to the empty string, the browser will not be started.

Definition at line 183 of file vidaliasettings.cpp.

References SETTING_BROWSER_EXECUTABLE, and VSettings::setValue().

void VidaliaSettings::setIMExecutable ( const QString &  IMExecutable  ) 

Sets the location and name of the IM client executable to the given string. If set to the empty string, the client will not be started.

Definition at line 214 of file vidaliasettings.cpp.

References SETTING_IM_EXECUTABLE, and VSettings::setValue().

void VidaliaSettings::setInterfaceStyle ( QString  styleKey  ) 

Sets the interface style key.

Definition at line 100 of file vidaliasettings.cpp.

References SETTING_STYLE, and VSettings::setValue().

Referenced by AppearancePage::save().

void VidaliaSettings::setLanguageCode ( QString  languageCode  ) 

Saves the preferred language code.

Definition at line 86 of file vidaliasettings.cpp.

References SETTING_LANGUAGE, and VSettings::setValue().

Referenced by AppearancePage::save().

void VidaliaSettings::setProxyExecutable ( const QString &  proxyExecutable  ) 

Sets the location and name of the proxy server executable to the given string. If set to the empty string, the proxy will not be started.

Definition at line 245 of file vidaliasettings.cpp.

References SETTING_PROXY_EXECUTABLE, and VSettings::setValue().

Referenced by GeneralPage::save().

void VidaliaSettings::setProxyExecutableArguments ( const QStringList &  proxyExecutableArguments  ) 

Sets the additional arguments to be passed to Proxy Executable

Definition at line 260 of file vidaliasettings.cpp.

References SETTING_PROXY_EXECUTABLE_ARGUMENTS, and VSettings::setValue().

Referenced by GeneralPage::save().

void VidaliaSettings::setRunProxyAtStart ( bool  run  ) 

Set whether to run a proxy application when Vidalia starts.

Definition at line 229 of file vidaliasettings.cpp.

References SETTING_RUN_PROXY_AT_START, and VSettings::setValue().

Referenced by GeneralPage::save().

void VidaliaSettings::setRunTorAtStart ( bool  run  ) 

Set whether to run Tor when Vidalia starts.

Definition at line 114 of file vidaliasettings.cpp.

References SETTING_RUN_TOR_AT_START, and VSettings::setValue().

Referenced by GeneralPage::save().

void VidaliaSettings::setRunVidaliaOnBoot ( bool  run  ) 

Set whether to run Vidalia on system boot.

Definition at line 153 of file vidaliasettings.cpp.

References win32_registry_remove_key(), and win32_registry_set_key_value().

Referenced by GeneralPage::save().

void VidaliaSettings::setShowMainWindowAtStart ( bool  show  ) 

Sets whether to show Vidalia's main window when the application starts.

Definition at line 129 of file vidaliasettings.cpp.

References SETTING_SHOW_MAINWINDOW_AT_START, and VSettings::setValue().

Referenced by MainWindow::toggleShowOnStartup().

bool VidaliaSettings::showMainWindowAtStart (  ) 

Returns true if Vidalia's main window should be visible when the application starts.

Definition at line 122 of file vidaliasettings.cpp.

References SETTING_SHOW_MAINWINDOW_AT_START, and VSettings::value().

Referenced by MainWindow::MainWindow().


The documentation for this class was generated from the following files:
Generated on Tue Jul 7 16:58:12 2009 for Vidalia by  doxygen 1.4.7