Fawkes API  Fawkes Development Version
firevision::FuseImageListWidget Class Reference

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

#include <>>

Inheritance diagram for firevision::FuseImageListWidget:

Public Member Functions

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

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 36 of file fuse_image_list_widget.h.

Constructor & Destructor Documentation

◆ FuseImageListWidget()

firevision::FuseImageListWidget::FuseImageListWidget ( )

Constructor.

Definition at line 43 of file fuse_image_list_widget.cpp.

◆ ~FuseImageListWidget()

firevision::FuseImageListWidget::~FuseImageListWidget ( )
virtual

Member Function Documentation

◆ add_fountain_service()

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
namethe name of the service
host_namethe host the service is running on
portthe port the service is running on

Definition at line 102 of file fuse_image_list_widget.cpp.

◆ auto_update()

bool firevision::FuseImageListWidget::auto_update ( )

Get auto-update status.

Returns
true if auto-update is activated

Definition at line 214 of file fuse_image_list_widget.cpp.

◆ fuse_connection_died()

void firevision::FuseImageListWidget::fuse_connection_died ( )
virtualnoexcept

Connection died.

Implements firevision::FuseClientHandler.

Definition at line 432 of file fuse_image_list_widget.cpp.

◆ fuse_connection_established()

void firevision::FuseImageListWidget::fuse_connection_established ( )
virtualnoexcept

Connection has been established.

Implements firevision::FuseClientHandler.

Definition at line 427 of file fuse_image_list_widget.cpp.

◆ fuse_inbound_received()

void firevision::FuseImageListWidget::fuse_inbound_received ( FuseNetworkMessage m)
virtualnoexcept

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
mmessage to handle

Implements firevision::FuseClientHandler.

Definition at line 443 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.

◆ fuse_invalid_server_version()

void firevision::FuseImageListWidget::fuse_invalid_server_version ( uint32_t  local_version,
uint32_t  remote_version 
)
virtualnoexcept

Invalid version string received.

The remote end has a different incompatible FUSE version.

Parameters
local_versionversion that the FuseClient speaks
remote_versionversion that the remote FUSE server speaks.

Implements firevision::FuseClientHandler.

Definition at line 420 of file fuse_image_list_widget.cpp.

◆ get_selected_image()

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_namethe host name of the selected image
portthe port of the selected image
image_idthe id of the selected image
compressiontrue if compression shall be switched on
Returns
true if references could be assigned

Definition at line 250 of file fuse_image_list_widget.cpp.

◆ image_selected()

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 205 of file fuse_image_list_widget.cpp.

Referenced by FuseViewerGtkWindow::FuseViewerGtkWindow().

◆ remove_fountain_service()

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

Call this method when a Fountain service vanishes.

Parameters
namethe name of the service

Definition at line 142 of file fuse_image_list_widget.cpp.

◆ set_auto_update()

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_secthe update interval in seconds

Definition at line 224 of file fuse_image_list_widget.cpp.

◆ set_auto_update_chk()

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

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

Parameters
chka Gtk::CheckButton

Definition at line 192 of file fuse_image_list_widget.cpp.

◆ set_image_list_trv()

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

Assign the TreeView widget to hold the list of images.

Parameters
trva Gtk::TreeView

Definition at line 163 of file fuse_image_list_widget.cpp.

◆ set_toggle_compression_chk()

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

Assign the CheckButton to toggle the compression.

Parameters
chka Gtk::CheckButton

Definition at line 181 of file fuse_image_list_widget.cpp.


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