Vidalia  0.2.17
Public Types | Public Member Functions
VidaliaSettings Class Reference

#include <VidaliaSettings.h>

Inheritance diagram for VidaliaSettings:
VSettings ServiceSettings

List of all members.

Public Types

enum  IconPosition { Tray, Dock, Both }

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)
QString getProxyExecutableArguments () const
void setProxyExecutableArguments (const QString &proxyExecutableArguments)
bool isAutoUpdateEnabled () const
void setAutoUpdateEnabled (bool enabled)
QDateTime lastCheckedForUpdates () const
void setLastCheckedForUpdates (const QDateTime &checkedAt)
bool useLocalGeoIpDatabase () const
void setUseLocalGeoIpDatabase (bool enabled)
QString localGeoIpDatabase () const
void setLocalGeoIpDatabase (const QString &databaseFile)
IconPosition getIconPref ()
void setIconPref (const IconPosition iconPref)
QString toString (const IconPosition iconPref)
IconPosition fromString (QString iconPref)
bool skipVersionCheck () const

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 31 of file VidaliaSettings.h.


Member Enumeration Documentation

Enumerator:
Tray 
Dock 
Both 

Definition at line 36 of file VidaliaSettings.h.


Constructor & Destructor Documentation


Member Function Documentation

Definition at line 353 of file VidaliaSettings.cpp.

References Both, Dock, and Tray.

Referenced by getIconPref().

Returns a fully-qualified path to the web browser directory

Definition at line 204 of file VidaliaSettings.cpp.

References SETTING_BROWSER_DIRECTORY, toString(), and VSettings::value().

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

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 189 of file VidaliaSettings.cpp.

References SETTING_BROWSER_EXECUTABLE, toString(), and VSettings::value().

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

Get the icon preference

Definition at line 330 of file VidaliaSettings.cpp.

References fromString(), SETTING_ICON_PREF, toString(), and VSettings::value().

Referenced by AppearancePage::load(), MainWindow::MainWindow(), and MainWindow::setTrayIcon().

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

Definition at line 220 of file VidaliaSettings.cpp.

References SETTING_IM_EXECUTABLE, toString(), and VSettings::value().

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

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

Definition at line 107 of file VidaliaSettings.cpp.

References SETTING_STYLE, and VSettings::value().

Referenced by Vidalia::setStyle().

Gets the currently preferred language code for Vidalia.

Definition at line 93 of file VidaliaSettings.cpp.

References SETTING_LANGUAGE, and VSettings::value().

Referenced by AppearancePage::load(), AppearancePage::save(), and Vidalia::setLanguage().

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

Definition at line 251 of file VidaliaSettings.cpp.

References SETTING_PROXY_EXECUTABLE, toString(), and VSettings::value().

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

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

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

Definition at line 267 of file VidaliaSettings.cpp.

References SETTING_PROXY_EXECUTABLE_ARGUMENTS, and VSettings::value().

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

Returns true if Vidalia should automatically check for software updates.

Definition at line 281 of file VidaliaSettings.cpp.

References SETTING_CHECK_FOR_UPDATES, and VSettings::value().

Referenced by MainWindow::circuitEstablished(), and MainWindow::running().

Returns the time at which Vidalia last checked for software updates.

Definition at line 293 of file VidaliaSettings.cpp.

References SETTING_LAST_UPDATE_CHECK, and VSettings::value().

Referenced by MainWindow::circuitEstablished(), and MainWindow::running().

Returns the file, if set, to be used as the local GeoIP database.

Definition at line 317 of file VidaliaSettings.cpp.

References SETTING_LOCAL_GEOIP_DATABASE, toString(), and VSettings::value().

Referenced by NetViewer::setupGeoIpResolver().

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

Definition at line 236 of file VidaliaSettings.cpp.

References SETTING_RUN_PROXY_AT_START, and VSettings::value().

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

Returns true if Vidalia should start Tor when it starts.

Returns true if Tor is to be run when Vidalia starts.

Definition at line 121 of file VidaliaSettings.cpp.

References SETTING_RUN_TOR_AT_START, and VSettings::value().

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

Returns true if Vidalia should start on system boot.

Returns true if Vidalia is set to run on system boot.

Definition at line 151 of file VidaliaSettings.cpp.

References win32_registry_get_key_value().

Referenced by GeneralPage::load().

void VidaliaSettings::setAutoUpdateEnabled ( bool  enabled)

Sets to enabled whether Vidalia should automatically check for software updates or not.

Definition at line 287 of file VidaliaSettings.cpp.

References SETTING_CHECK_FOR_UPDATES, and VSettings::setValue().

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 212 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 197 of file VidaliaSettings.cpp.

References SETTING_BROWSER_EXECUTABLE, and VSettings::setValue().

void VidaliaSettings::setIconPref ( const IconPosition  iconPref)

Set the icon preference

Definition at line 337 of file VidaliaSettings.cpp.

References SETTING_ICON_PREF, VSettings::setValue(), and toString().

Referenced by AppearancePage::save().

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 228 of file VidaliaSettings.cpp.

References SETTING_IM_EXECUTABLE, and VSettings::setValue().

void VidaliaSettings::setInterfaceStyle ( QString  styleKey)

Sets the interface style key.

Definition at line 114 of file VidaliaSettings.cpp.

References SETTING_STYLE, and VSettings::setValue().

Referenced by AppearancePage::save().

void VidaliaSettings::setLanguageCode ( QString  languageCode)

Saves the preferred language code.

Sets the preferred language code.

Definition at line 100 of file VidaliaSettings.cpp.

References SETTING_LANGUAGE, and VSettings::setValue().

Referenced by AppearancePage::save().

void VidaliaSettings::setLastCheckedForUpdates ( const QDateTime &  checkedAt)

Sets to checkedAt the time at which Vidalia last checked for available software updates.

Definition at line 299 of file VidaliaSettings.cpp.

References SETTING_LAST_UPDATE_CHECK, and VSettings::setValue().

void VidaliaSettings::setLocalGeoIpDatabase ( const QString &  databaseFile)

Sets the file to use as a local GeoIP database.

Definition at line 323 of file VidaliaSettings.cpp.

References SETTING_LOCAL_GEOIP_DATABASE, and VSettings::setValue().

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 259 of file VidaliaSettings.cpp.

References SETTING_PROXY_EXECUTABLE, and VSettings::setValue().

Referenced by GeneralPage::save().

void VidaliaSettings::setProxyExecutableArguments ( const QString &  proxyExecutableArguments)

Sets the additional arguments to be passed to Proxy Executable

Definition at line 274 of file VidaliaSettings.cpp.

References SETTING_PROXY_EXECUTABLE_ARGUMENTS, and VSettings::setValue().

Referenced by GeneralPage::save().

Set whether to run a proxy application when Vidalia starts.

Definition at line 243 of file VidaliaSettings.cpp.

References SETTING_RUN_PROXY_AT_START, and VSettings::setValue().

Referenced by GeneralPage::save().

Set whether to run Tor when Vidalia starts.

If run is set to true, then Tor will be run when Vidalia starts.

Definition at line 128 of file VidaliaSettings.cpp.

References SETTING_RUN_TOR_AT_START, and VSettings::setValue().

Referenced by GeneralPage::save().

Set whether to run Vidalia on system boot.

If run is set to true, then Vidalia will run on system boot.

Definition at line 167 of file VidaliaSettings.cpp.

References win32_registry_remove_key(), and win32_registry_set_key_value().

Referenced by GeneralPage::save().

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

Definition at line 143 of file VidaliaSettings.cpp.

References SETTING_SHOW_MAINWINDOW_AT_START, and VSettings::setValue().

Referenced by MainWindow::toggleShowOnStartup().

Enables or disables use of a local GeoIP database.

Definition at line 311 of file VidaliaSettings.cpp.

References SETTING_USE_LOCAL_GEOIP_DATABASE, and VSettings::setValue().

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

Definition at line 136 of file VidaliaSettings.cpp.

References SETTING_SHOW_MAINWINDOW_AT_START, and VSettings::value().

Referenced by MainWindow::MainWindow().

Returns true if Vidalia should skip the version check for tor

Definition at line 362 of file VidaliaSettings.cpp.

References SETTING_SKIP_VERSION_CHECK, and VSettings::value().

Referenced by MainWindow::checkTorVersion().

QString VidaliaSettings::toString ( const IconPosition  iconPref)

Returns true if Vidalia is currently configured to use a local GeoIP database.

Definition at line 305 of file VidaliaSettings.cpp.

References SETTING_USE_LOCAL_GEOIP_DATABASE, and VSettings::value().

Referenced by NetViewer::setupGeoIpResolver().


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