Fawkes API  Fawkes Development Version
fawkes::ServiceSelectorCBE Class Reference

This widget consists of a Gtk::ComboBox and a Gtk::Button. More...

#include <gui_utils/service_selector_cbe.h>

Public Member Functions

 ServiceSelectorCBE (Gtk::ComboBoxEntry *services, Gtk::Button *connect, Gtk::Window *parent, const char *service="_fawkes._tcp")
 Construtor. More...
 
 ServiceSelectorCBE (Gtk::ComboBoxEntry *services, Gtk::ToolButton *connect, Gtk::Window *parent, const char *service="_fawkes._tcp")
 Construtor. More...
 
 ServiceSelectorCBE (Glib::RefPtr< Gtk::Builder > builder, const char *cbe_name="cbeServices", const char *btn_name="btnConnect", const char *wnd_name="wndMain", const char *service="_fawkes._tcp")
 Constructor. More...
 
virtual ~ServiceSelectorCBE ()
 Destructor. More...
 
FawkesNetworkClientget_network_client ()
 Access the current network client. More...
 
Glib::ustring get_hostname ()
 Returns the currently selected hostname (after connect) More...
 
Glib::ustring get_name ()
 Returns the currently selected service name (after connect) More...
 
unsigned int get_port ()
 Returns the currently used port (after connect) More...
 
sigc::signal< void > signal_connected ()
 This signal is emitted whenever a network connection is established. More...
 
sigc::signal< void > signal_disconnected ()
 This signal is emitted whenever a network connection is terminated. More...
 

Protected Member Functions

void initialize ()
 Initializer method. More...
 
void on_btn_connect_clicked ()
 Signal handler that is called whenever the connect button is clicked or an entry in the combo box is selected. More...
 
void on_service_selected ()
 Signal handler that is called whenever an entry is selected from the combo box. More...
 
void on_connected ()
 Signal handler for the connection established signal. More...
 
void on_disconnected ()
 Signal handler for the connection terminated signal. More...
 

Protected Attributes

Gtk::ComboBoxEntry * m_cbe_services
 A Gtk::ComboBox that lists all available services. More...
 
Gtk::Button * m_btn_connect
 A Gtk::Button that triggers the connection. More...
 
Gtk::ToolButton * m_tbtn_connect
 A Gtk::ToolButton that triggers the connection. More...
 
Gtk::Window * m_parent
 The parent Gtk::Window. More...
 
ConnectionDispatcherm_dispatcher
 A ConnectionDispatcher which dispatches connection signals. More...
 
ServiceModelm_service_model
 A liststore which contains information about detected services. More...
 

Detailed Description

This widget consists of a Gtk::ComboBox and a Gtk::Button.

The combo box contains all detected services of a given type; upon click the button opens a network connection to the selected service.

Author
Daniel Beck
Tim Niemueller

Definition at line 44 of file service_selector_cbe.h.

Constructor & Destructor Documentation

◆ ServiceSelectorCBE() [1/3]

ServiceSelectorCBE::ServiceSelectorCBE ( Gtk::ComboBoxEntry *  services,
Gtk::Button *  connect,
Gtk::Window *  parent,
const char *  service = "_fawkes._tcp" 
)

Construtor.

Parameters
servicesthe combo box to hold the list of services
connectthe button to trigger the network connection
parentthe parent window. Used for error dialogs.
servicea service identifier

Definition at line 76 of file service_selector_cbe.cpp.

◆ ServiceSelectorCBE() [2/3]

ServiceSelectorCBE::ServiceSelectorCBE ( Gtk::ComboBoxEntry *  services,
Gtk::ToolButton *  connect,
Gtk::Window *  parent,
const char *  service = "_fawkes._tcp" 
)

Construtor.

Parameters
servicesthe combo box to hold the list of services
connectthe button to trigger the network connection
parentthe parent window. Used for error dialogs.
servicea service identifier

Definition at line 101 of file service_selector_cbe.cpp.

◆ ServiceSelectorCBE() [3/3]

ServiceSelectorCBE::ServiceSelectorCBE ( Glib::RefPtr< Gtk::Builder >  builder,
const char *  cbe_name = "cbeServices",
const char *  btn_name = "btnConnect",
const char *  wnd_name = "wndMain",
const char *  service = "_fawkes._tcp" 
)

Constructor.

Parameters
builderGtk builder
cbe_namename of the combo box
btn_namename of the button
wnd_namename of the parent window
serviceservice identifier

Definition at line 124 of file service_selector_cbe.cpp.

References initialize(), m_btn_connect, m_cbe_services, m_parent, and m_service_model.

◆ ~ServiceSelectorCBE()

ServiceSelectorCBE::~ServiceSelectorCBE ( )
virtual

Destructor.

Definition at line 188 of file service_selector_cbe.cpp.

References m_dispatcher, and m_service_model.

Member Function Documentation

◆ get_hostname()

Glib::ustring ServiceSelectorCBE::get_hostname ( )

Returns the currently selected hostname (after connect)

Returns
the hostname

Definition at line 208 of file service_selector_cbe.cpp.

◆ get_name()

Glib::ustring ServiceSelectorCBE::get_name ( void  )

Returns the currently selected service name (after connect)

Returns
the service name

Definition at line 218 of file service_selector_cbe.cpp.

Referenced by PluginGuiGtkWindow::~PluginGuiGtkWindow().

◆ get_network_client()

FawkesNetworkClient * ServiceSelectorCBE::get_network_client ( )

Access the current network client.

Returns
the current network client

Definition at line 198 of file service_selector_cbe.cpp.

References fawkes::ConnectionDispatcher::get_client(), and m_dispatcher.

Referenced by PluginGuiGtkWindow::PluginGuiGtkWindow().

◆ get_port()

unsigned int ServiceSelectorCBE::get_port ( )

Returns the currently used port (after connect)

Returns
the port

Definition at line 228 of file service_selector_cbe.cpp.

◆ initialize()

◆ on_btn_connect_clicked()

◆ on_connected()

void ServiceSelectorCBE::on_connected ( )
protected

Signal handler for the connection established signal.

Definition at line 354 of file service_selector_cbe.cpp.

References m_btn_connect, and m_tbtn_connect.

Referenced by initialize().

◆ on_disconnected()

void ServiceSelectorCBE::on_disconnected ( )
protected

Signal handler for the connection terminated signal.

Definition at line 364 of file service_selector_cbe.cpp.

References m_btn_connect, and m_tbtn_connect.

Referenced by initialize().

◆ on_service_selected()

◆ signal_connected()

sigc::signal< void > ServiceSelectorCBE::signal_connected ( )

This signal is emitted whenever a network connection is established.

Returns
reference to the corresponding dispatcher

Definition at line 237 of file service_selector_cbe.cpp.

References m_dispatcher, and fawkes::ConnectionDispatcher::signal_connected().

Referenced by PluginGuiGtkWindow::PluginGuiGtkWindow().

◆ signal_disconnected()

sigc::signal< void > ServiceSelectorCBE::signal_disconnected ( )

This signal is emitted whenever a network connection is terminated.

Returns
reference to the corresponding dispatcher

Definition at line 246 of file service_selector_cbe.cpp.

References m_dispatcher, and fawkes::ConnectionDispatcher::signal_disconnected().

Referenced by PluginGuiGtkWindow::PluginGuiGtkWindow().

Member Data Documentation

◆ m_btn_connect

fawkes::ServiceSelectorCBE::m_btn_connect
protected

A Gtk::Button that triggers the connection.

Definition at line 94 of file service_selector_cbe.h.

Referenced by initialize(), on_btn_connect_clicked(), on_connected(), on_disconnected(), and ServiceSelectorCBE().

◆ m_cbe_services

fawkes::ServiceSelectorCBE::m_cbe_services
protected

A Gtk::ComboBox that lists all available services.

Definition at line 92 of file service_selector_cbe.h.

Referenced by initialize(), on_btn_connect_clicked(), on_service_selected(), and ServiceSelectorCBE().

◆ m_dispatcher

fawkes::ServiceSelectorCBE::m_dispatcher
protected

◆ m_parent

fawkes::ServiceSelectorCBE::m_parent
protected

The parent Gtk::Window.

Definition at line 96 of file service_selector_cbe.h.

Referenced by on_btn_connect_clicked(), on_service_selected(), and ServiceSelectorCBE().

◆ m_service_model

fawkes::ServiceSelectorCBE::m_service_model
protected

A liststore which contains information about detected services.

Definition at line 99 of file service_selector_cbe.h.

Referenced by initialize(), on_btn_connect_clicked(), on_service_selected(), ServiceSelectorCBE(), and ~ServiceSelectorCBE().

◆ m_tbtn_connect

fawkes::ServiceSelectorCBE::m_tbtn_connect
protected

A Gtk::ToolButton that triggers the connection.

Definition at line 95 of file service_selector_cbe.h.

Referenced by initialize(), on_btn_connect_clicked(), on_connected(), and on_disconnected().


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