firevision::FuseImageListWidget Class Reference

This widget displays all available Fuse images in a tree view. More...

#include <fvwidgets/fuse_image_list_widget.h>

Inheritance diagram for firevision::FuseImageListWidget:
Inheritance graph
[legend]

List of all members.

Classes

struct  ClientData
class  ImageRecord

Public Member Functions

 FuseImageListWidget ()
 Constructor.
virtual ~FuseImageListWidget ()
 Destructor.
void add_fountain_service (const char *name, const char *host_name, uint32_t port)
 Call this method when new Fountain services are discovered.
void remove_fountain_service (const char *name)
 Call this method when a Fountain service vanishes.
void set_toggle_compression_chk (Gtk::CheckButton *chk)
 Assign the CheckButton to toggle the compression.
void set_auto_update_chk (Gtk::CheckButton *chk)
 Assign the CheckButton that enables/disables the auto update function.
void set_image_list_trv (Gtk::TreeView *trv)
 Assign the TreeView widget to hold the list of images.
Glib::Dispatcher & image_selected ()
 Access the Dispatcher that is signalled when a new image is selected in the list of images.
bool auto_update ()
 Get auto-update status.
void set_auto_update (bool active, unsigned int interval_sec=5)
 Set the auto-update status.
bool get_selected_image (std::string &host_name, unsigned short &port, std::string &image_id, bool &compression)
 Get the host name, port, and image id of the selected image.
void fuse_invalid_server_version (uint32_t local_version, uint32_t remote_version) throw ()
 Invalid version string received.
void fuse_connection_established () throw ()
 Connection has been established.
void fuse_connection_died () throw ()
 Connection died.
void fuse_inbound_received (FuseNetworkMessage *m) throw ()
 Message received.

Detailed Description

This widget displays all available Fuse images in a tree view.

It also can check the registered host for new images, regularly.

Author:
Daniel Beck

Definition at line 40 of file fuse_image_list_widget.h.


Constructor & Destructor Documentation

firevision::FuseImageListWidget::FuseImageListWidget (  ) 

Constructor.

Definition at line 46 of file fuse_image_list_widget.cpp.

References fawkes::LockQueue< Type >::clear(), and set_image_list_trv().

firevision::FuseImageListWidget::~FuseImageListWidget (  )  [virtual]

Member Function Documentation

void firevision::FuseImageListWidget::add_fountain_service ( const char *  name,
const char *  host_name,
uint32_t  port 
)

Call this method when new Fountain services are discovered.

Parameters:
name the name of the service
host_name the host the service is running on
port the port the service is running on

Definition at line 101 of file fuse_image_list_widget.cpp.

References fawkes::LockList< Type >::lock(), fawkes::Mutex::lock(), fawkes::LockList< Type >::push_back_locked(), fawkes::LockList< Type >::unlock(), and fawkes::Mutex::unlock().

bool firevision::FuseImageListWidget::auto_update (  ) 

Get auto-update status.

Returns:
true if auto-update is activated

Definition at line 220 of file fuse_image_list_widget.cpp.

void firevision::FuseImageListWidget::fuse_connection_died (  )  throw () [virtual]

Connection died.

Implements firevision::FuseClientHandler.

Definition at line 441 of file fuse_image_list_widget.cpp.

References fawkes::LockQueue< Type >::push_locked().

void firevision::FuseImageListWidget::fuse_connection_established (  )  throw () [virtual]

Connection has been established.

Implements firevision::FuseClientHandler.

Definition at line 436 of file fuse_image_list_widget.cpp.

void firevision::FuseImageListWidget::fuse_inbound_received ( FuseNetworkMessage m  )  throw () [virtual]

Message received.

An incoming message has been received and can now be processed. Note that if you want to work on the message after this method has finished you have to reference the message by calling FuseMessage::ref()!

Parameters:
m message to handle

Implements firevision::FuseClientHandler.

Definition at line 453 of file fuse_image_list_widget.cpp.

References firevision::FUSE_imageinfo_t::buffer_size, firevision::FUSE_imageinfo_t::colorspace, firevision::FuseImageListContent::has_next(), firevision::FUSE_imageinfo_t::height, firevision::FUSE_imageinfo_t::image_id, firevision::FuseImageListContent::next(), fawkes::Exception::print_trace(), and firevision::FUSE_imageinfo_t::width.

void firevision::FuseImageListWidget::fuse_invalid_server_version ( uint32_t  local_version,
uint32_t  remote_version 
) throw () [virtual]

Invalid version string received.

The remote end has a different incompatible FUSE version.

Parameters:
local_version version that the FuseClient speaks
remote_version version that the remote FUSE server speaks.

Implements firevision::FuseClientHandler.

Definition at line 429 of file fuse_image_list_widget.cpp.

bool firevision::FuseImageListWidget::get_selected_image ( std::string &  host_name,
unsigned short &  port,
std::string &  image_id,
bool &  compression 
)

Get the host name, port, and image id of the selected image.

Parameters:
host_name the host name of the selected image
port the port of the selected image
image_id the id of the selected image
compression true if compression shall be switched on
Returns:
true if references could be assigned

Definition at line 255 of file fuse_image_list_widget.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Glib::Dispatcher & firevision::FuseImageListWidget::image_selected (  ) 

Access the Dispatcher that is signalled when a new image is selected in the list of images.

Returns:
reference to the Dispatcher that is activated when an image is selected in the list of images

Definition at line 211 of file fuse_image_list_widget.cpp.

Referenced by Firestation::Firestation(), and FuseViewerGtkWindow::FuseViewerGtkWindow().

void firevision::FuseImageListWidget::remove_fountain_service ( const char *  name  ) 

Call this method when a Fountain service vanishes.

Parameters:
name the name of the service

Definition at line 148 of file fuse_image_list_widget.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

void firevision::FuseImageListWidget::set_auto_update ( bool  active,
unsigned int  interval_sec = 5 
)

Set the auto-update status.

Parameters:
active (de-)activate auto-update
interval_sec the update interval in seconds

Definition at line 230 of file fuse_image_list_widget.cpp.

void firevision::FuseImageListWidget::set_auto_update_chk ( Gtk::CheckButton *  chk  ) 

Assign the CheckButton that enables/disables the auto update function.

Parameters:
chk a Gtk::CheckButton

Definition at line 199 of file fuse_image_list_widget.cpp.

Referenced by Firestation::Firestation().

void firevision::FuseImageListWidget::set_image_list_trv ( Gtk::TreeView *  trv  ) 

Assign the TreeView widget to hold the list of images.

Parameters:
trv a Gtk::TreeView

Definition at line 173 of file fuse_image_list_widget.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by Firestation::Firestation(), and FuseImageListWidget().

void firevision::FuseImageListWidget::set_toggle_compression_chk ( Gtk::CheckButton *  chk  ) 

Assign the CheckButton to toggle the compression.

Parameters:
chk a Gtk::CheckButton

Definition at line 189 of file fuse_image_list_widget.cpp.

Referenced by Firestation::Firestation().


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1