Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions
fawkes::LogView Class Reference

Log View widget. More...

#include <>>

List of all members.

Classes

class  LogRecord
 TreeView record for LogView.

Public Member Functions

 LogView ()
 Constructor.
 LogView (const char *hostname, unsigned short int port)
 Constructor.
 LogView (BaseObjectType *cobject, const Glib::RefPtr< Gtk::Builder > &builder)
 Constructor.
 ~LogView ()
 Destructor.
void set_client (FawkesNetworkClient *client)
 Set FawkesNetworkClient instance.
FawkesNetworkClient * get_client ()
 Get the used FawkesNetworkClient.
void append_message (Logger::LogLevel log_level, struct timeval t, const char *component, bool is_exception, const char *message)
 Append a single message.
void clear ()
 Clear all records.
ConnectionDispatcher * get_connection_dispatcher () const
 Get ConnectionDispatcher instance that is used internally.

Detailed Description

Log View widget.

This widget derives a Gtk::TreeView and provides an easy way to show log messages in a GUI application.

Author:
Tim Niemueller

Definition at line 40 of file logview.h.

Constructor & Destructor Documentation

fawkes::LogView::LogView ( )

Constructor.

Definition at line 46 of file logview.cpp.

fawkes::LogView::LogView ( const char *  hostname,
unsigned short int  port 
)

Constructor.

Parameters:
hostnamehostname to set for the FawkesNetworkClient.
portport to set for the FawkesNetworkClient.

Definition at line 56 of file logview.cpp.

fawkes::LogView::LogView ( BaseObjectType *  cobject,
const Glib::RefPtr< Gtk::Builder > &  builder 
)

Constructor.

Special ctor to be used with Gtk::Builder's get_widget_derived().

Parameters:
cobjectGtk C object
builderGtk builder

Definition at line 67 of file logview.cpp.

fawkes::LogView::~LogView ( )

Destructor.

Definition at line 76 of file logview.cpp.

References fawkes::FawkesNetworkClient::connected(), fawkes::FawkesNetworkClient::enqueue(), fawkes::ConnectionDispatcher::get_client(), and fawkes::NetworkLogger::MSGTYPE_UNSUBSCRIBE.

Member Function Documentation

void fawkes::LogView::append_message ( Logger::LogLevel  log_level,
struct timeval  t,
const char *  component,
bool  is_exception,
const char *  message 
)

Append a single message.

Parameters:
log_levellog level
ttime of the message
componentcomponent string for the message
is_exceptiontrue if essage was produced via an exception
messagelog message

Definition at line 279 of file logview.cpp.

References fawkes::Logger::LL_DEBUG, fawkes::Logger::LL_ERROR, fawkes::Logger::LL_INFO, and fawkes::Logger::LL_WARN.

void fawkes::LogView::clear ( void  )

Clear all records.

Definition at line 200 of file logview.cpp.

FawkesNetworkClient * fawkes::LogView::get_client ( )

Get the used FawkesNetworkClient.

Returns:
Fawkes network client instance

Definition at line 182 of file logview.cpp.

References fawkes::ConnectionDispatcher::get_client().

ConnectionDispatcher * fawkes::LogView::get_connection_dispatcher ( ) const

Get ConnectionDispatcher instance that is used internally.

Returns:
connection dispatcher

Definition at line 192 of file logview.cpp.

void fawkes::LogView::set_client ( FawkesNetworkClient *  client)

Set FawkesNetworkClient instance.

Parameters:
clientFawkes network client to use

Definition at line 161 of file logview.cpp.

References fawkes::FawkesNetworkClient::connected(), fawkes::FawkesNetworkClient::enqueue(), fawkes::ConnectionDispatcher::get_client(), fawkes::NetworkLogger::MSGTYPE_SUBSCRIBE, fawkes::NetworkLogger::MSGTYPE_UNSUBSCRIBE, and fawkes::ConnectionDispatcher::set_client().

Referenced by SkillGuiGtkWindow::~SkillGuiGtkWindow().

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