Vidalia 0.2.12
Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes

MessageLog Class Reference

#include <MessageLog.h>

Inheritance diagram for MessageLog:
VidaliaWindow

List of all members.

Public Member Functions

 MessageLog (QWidget *parent=0, Qt::WFlags flags=0)
 ~MessageLog ()

Protected Member Functions

virtual void retranslateUi ()

Private Slots

void log (tc::Severity severity, const QString &msg)
void saveAll ()
void saveSelected ()
void selectAll ()
void copy ()
void clear ()
void find ()
void saveSettings ()
void cancelChanges ()
void browse ()
void help ()

Private Member Functions

void createActions ()
void setToolTips ()
void loadSettings ()
void registerLogEvents ()
void save (const QStringList &messages)
bool rotateLogFile (const QString &filename)

Private Attributes

TorControl_torControl
VidaliaSettings_settings
uint _filter
bool _enableLogging
LogFile _logFile
Ui::MessageLog ui

Detailed Description

Definition at line 28 of file MessageLog.h.


Constructor & Destructor Documentation

MessageLog::MessageLog ( QWidget *  parent = 0,
Qt::WFlags  flags = 0 
)

Default constructor

Constructor. The constructor will load the message log's settings from VidaliSettings and register for log events according to the most recently set severity filter.

Parameters:
torControlA TorControl object used to register for log events.
parentThe parent widget of this MessageLog object.
flagsAny desired window creation flags.

Definition at line 57 of file MessageLog.cpp.

References _torControl, createActions(), loadSettings(), log(), setToolTips(), LogTreeWidget::TimeColumn, Vidalia::torControl(), and ui.

MessageLog::~MessageLog ( )

Default destructor

Default Destructor. Simply frees up any memory allocated for member variables.

Definition at line 85 of file MessageLog.cpp.

References _logFile, and LogFile::close().


Member Function Documentation

void MessageLog::browse ( ) [private, slot]

Called when the user clicks "Browse" to select a new log file.

Definition at line 299 of file MessageLog.cpp.

References ui.

Referenced by createActions().

void MessageLog::cancelChanges ( ) [private, slot]

Called when user cancels changed settings

Simply restores the previously saved settings and hides the settings frame.

Definition at line 289 of file MessageLog.cpp.

References loadSettings(), and ui.

Referenced by createActions().

void MessageLog::clear ( ) [private, slot]

Called when the user triggers the "Clear" action.

Clears all log messages or status notifications, depending on which tab is currently visible.

Definition at line 399 of file MessageLog.cpp.

References ui.

Referenced by createActions().

void MessageLog::copy ( ) [private, slot]

Called when the user triggers the "Copy" action.

Copies contents of currently selected messages to the 'clipboard'.

Definition at line 381 of file MessageLog.cpp.

References ui.

Referenced by createActions().

void MessageLog::createActions ( ) [private]

Create and bind actions to events

Binds events (signals) to actions (slots).

Definition at line 92 of file MessageLog.cpp.

References browse(), cancelChanges(), clear(), copy(), Vidalia::createShortcut(), find(), help(), saveAll(), saveSelected(), saveSettings(), selectAll(), and ui.

Referenced by MessageLog().

void MessageLog::find ( ) [private, slot]

Called when the user triggers the "Find" action. This will search through all currently displayed log entries for text specified by the user, highlighting the entries that contain a match.

Prompts the user for a search string. If the search string is not found in any of the currently displayed log entires, then a message will be displayed for the user informing them that no matches were found.

See also:
search()

Definition at line 413 of file MessageLog.cpp.

References VMessageBox::information(), VMessageBox::Ok, p(), and ui.

Referenced by createActions().

void MessageLog::help ( ) [private, slot]

Called when the user clicks "Help" to see help info about the log.

Displays help information about the message log.

Definition at line 480 of file MessageLog.cpp.

References VidaliaWindow::helpRequested().

Referenced by createActions().

void MessageLog::loadSettings ( ) [private]
void MessageLog::log ( tc::Severity  type,
const QString &  message 
) [private, slot]

Adds the passed message to the message log as the specified type

Writes a message to the Message History and tags it with the proper date, time and type.

Parameters:
typeThe message's severity type.
messageThe log message to be added.

Definition at line 454 of file MessageLog.cpp.

References _enableLogging, _filter, _logFile, LogTreeItem::toString(), and ui.

Referenced by MessageLog().

void MessageLog::registerLogEvents ( ) [private]
void MessageLog::retranslateUi ( ) [protected, virtual]

Called when the user changes the UI translation.

Reimplemented from VidaliaWindow.

Definition at line 152 of file MessageLog.cpp.

References setToolTips(), and ui.

bool MessageLog::rotateLogFile ( const QString &  filename) [private]

Rotates the log file based on the filename and the current logging status.

Opens a log file if necessary, or closes it if logging is disabled. If a log file is already opened and a new filename is specified, then the log file will be rotated to the new filename. In the case that the new filename can not be openend, the old file will remain open and writable.

Definition at line 223 of file MessageLog.cpp.

References _enableLogging, _logFile, LogFile::close(), VMessageBox::Ok, LogFile::open(), p(), and VMessageBox::warning().

Referenced by loadSettings(), and saveSettings().

void MessageLog::save ( const QStringList &  messages) [private]

Saves the given list of items to a file

Saves the given list of items to a file.

Parameters:
itemsA list of log message items to save.

Definition at line 314 of file MessageLog.cpp.

References VMessageBox::Ok, LogFile::open(), p(), and VMessageBox::warning().

Referenced by saveAll(), and saveSelected().

void MessageLog::saveAll ( ) [private, slot]

Called when the user triggers the "Save All" action.

Saves all shown messages to a file.

Definition at line 362 of file MessageLog.cpp.

References save(), and ui.

Referenced by createActions().

void MessageLog::saveSelected ( ) [private, slot]

Called when the user triggers "Save Selected" action.

Saves currently selected messages to a file.

Definition at line 352 of file MessageLog.cpp.

References save(), and ui.

Referenced by createActions().

void MessageLog::saveSettings ( ) [private, slot]
void MessageLog::selectAll ( ) [private, slot]

Called when the user triggers the "Select All" action.

Definition at line 371 of file MessageLog.cpp.

References ui.

Referenced by createActions().

void MessageLog::setToolTips ( ) [private]

Set Tool Tips for various widgets

Set tooltips for Message Filter checkboxes in code because they are long and Designer wouldn't let us insert newlines into the text.

Definition at line 134 of file MessageLog.cpp.

References ui.

Referenced by MessageLog(), and retranslateUi().


Member Data Documentation

Set to true if we will log all messages to a file.

Definition at line 89 of file MessageLog.h.

Referenced by loadSettings(), log(), rotateLogFile(), and saveSettings().

uint MessageLog::_filter [private]

Stores the current message filter

Definition at line 87 of file MessageLog.h.

Referenced by loadSettings(), log(), registerLogEvents(), and saveSettings().

Definition at line 91 of file MessageLog.h.

Referenced by loadSettings(), log(), rotateLogFile(), saveSettings(), and ~MessageLog().

A VidaliaSettings object that handles getting/saving settings

Reimplemented from VidaliaWindow.

Definition at line 85 of file MessageLog.h.

A pointer to a TorControl object, used to register for log events

Definition at line 83 of file MessageLog.h.

Referenced by MessageLog(), and registerLogEvents().

Ui::MessageLog MessageLog::ui [private]

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