Blackboard interface chooser dialog that supports multiple choices. More...

#include <>>

Inheritance diagram for fawkes::MultiInterfaceChooserDialog:

Classes
class	Record
	Blackboard interface record. More...

Public Types
typedef std::pair < Glib::ustring, Glib::ustring >	TypeIdPair
	Pair of type and IDs of interfaces.
typedef std::list< TypeIdPair >	TypeIdPairList
	List of type and ID of an interface.

Public Member Functions
virtual	~MultiInterfaceChooserDialog ()
	Destructor.
TypeIdPairList	get_selected_interfaces () const
	Get selected interface types and their respective IDs.
TypeIdPairList	get_newly_selected_interfaces () const
	Get selected interface types and their respective IDs.
Public Member Functions inherited from fawkes::InterfaceChooserDialog
virtual	~InterfaceChooserDialog ()
	Destructor.
void	get_selected_interface (Glib::ustring &type, Glib::ustring &id)
	Get selected interface type and ID.
fawkes::Interface *	run_and_open_for_reading ()
	Run dialog and try to connect.

Static Public Member Functions
static MultiInterfaceChooserDialog *	create (Gtk::Window &parent, BlackBoard blackboard, const char type_pattern, const char *id_pattern, const TypeIdPairList &loaded_interfaces, const Glib::ustring &title=DEFAULT_TITLE)
	Factory method.
Static Public Member Functions inherited from fawkes::InterfaceChooserDialog
static InterfaceChooserDialog *	create (Gtk::Window &parent, BlackBoard blackboard, const char type_pattern, const char *id_pattern, const Glib::ustring &title=DEFAULT_TITLE)
	Factory method.

Protected Member Functions
	MultiInterfaceChooserDialog (Gtk::Window &parent, const TypeIdPairList &loaded_interfaces, const Glib::ustring &title)
	Constructor for subclasses.
virtual const Record &	record () const
	Returns the Record of this chooser dialog.
virtual int	init_columns ()
	Initializes the columns GUI-wise.
virtual void	init_row (Gtk::TreeModel::Row &row, const InterfaceInfo &ii)
	Initializes a row with the given interface.
Protected Member Functions inherited from fawkes::InterfaceChooserDialog
	InterfaceChooserDialog (Gtk::Window &parent, const Glib::ustring &title)
	Constructor for subclasses.
void	init (BlackBoard blackboard, const char type_pattern, const char *id_pattern)
	Initialization method.

Additional Inherited Members
Static Public Attributes inherited from fawkes::InterfaceChooserDialog
static const char *const	DEFAULT_TITLE = "Select Interfaces"
	Default title of interface chooser dialogs.
Protected Attributes inherited from fawkes::InterfaceChooserDialog
Gtk::TreeView	__treeview
	Tree widget for interfaces.
Glib::RefPtr< Gtk::ListStore >	__model
	Data model of the tree.

Detailed Description

Blackboard interface chooser dialog that supports multiple choices.

Allows to choose multiple blackboard interfaces from a list of interfaces matching given type and ID patterns.

Author:: Christoph Schwering

Definition at line 34 of file multi_interface_chooser_dialog.h.

Member Typedef Documentation

typedef std::pair<Glib::ustring, Glib::ustring> fawkes::MultiInterfaceChooserDialog::TypeIdPair

Pair of type and IDs of interfaces.

Definition at line 38 of file multi_interface_chooser_dialog.h.

typedef std::list<TypeIdPair> fawkes::MultiInterfaceChooserDialog::TypeIdPairList

List of type and ID of an interface.

Definition at line 40 of file multi_interface_chooser_dialog.h.

Constructor & Destructor Documentation

fawkes::MultiInterfaceChooserDialog::~MultiInterfaceChooserDialog ( )

virtual

Destructor.

Definition at line 116 of file multi_interface_chooser_dialog.cpp.

fawkes::MultiInterfaceChooserDialog::MultiInterfaceChooserDialog	(	Gtk::Window &	parent,
		const TypeIdPairList &	loaded_interfaces,
		const Glib::ustring &	title
	)

protected

Constructor for subclasses.

After calling this constructor, the init() method needs to be called.

Parameters:

parent	parent window
loaded_interfaces	list of interfaces which are already loaded
title	title of the dialog

Definition at line 99 of file multi_interface_chooser_dialog.cpp.

References fawkes::InterfaceChooserDialog::__treeview.

Referenced by create().

Member Function Documentation

MultiInterfaceChooserDialog * fawkes::MultiInterfaceChooserDialog::create	(	Gtk::Window &	parent,
		BlackBoard *	blackboard,
		const char *	type_pattern,
		const char *	id_pattern,
		const TypeIdPairList &	loaded_interfaces,
		const Glib::ustring &	title = `DEFAULT_TITLE`
	)

static

Factory method.

Why a factory method instead of a ctor? The factory method calls init(), and init() calls other virtual methods. If this was a ctor, this ctor would not be allowed to be called by subclasses, because then the virtual methods in init() don't dispatch the right way during construction (see Effective C++ #9).

Parameters:

parent	parent window
blackboard	blackboard instance to query interfaces from
type_pattern	pattern with shell like globs (* for any number of characters, ? for exactly one character) to match the interface type.
id_pattern	pattern with shell like globs (* for any number of characters, ? for exactly one character) to match the interface ID.
loaded_interfaces	list of interfaces which are already loaded
title	title of the dialog

Returns:: new MultiInterfaceChooserDialog

Definition at line 76 of file multi_interface_chooser_dialog.cpp.

References fawkes::InterfaceChooserDialog::init(), and MultiInterfaceChooserDialog().

Referenced by LaserGuiGtkWindow::on_select_clicked().

MultiInterfaceChooserDialog::TypeIdPairList fawkes::MultiInterfaceChooserDialog::get_newly_selected_interfaces ( ) const

Get selected interface types and their respective IDs.

Returns:: A list of type + id pairs of interfaces that are to be loaded, and NOT contained in the list of loaded interfaces handed over to create().

Definition at line 220 of file multi_interface_chooser_dialog.cpp.

References fawkes::InterfaceChooserDialog::__model, fawkes::MultiInterfaceChooserDialog::Record::load, and record().

MultiInterfaceChooserDialog::TypeIdPairList fawkes::MultiInterfaceChooserDialog::get_selected_interfaces ( ) const

Get selected interface types and their respective IDs.

Returns:: A list of type + id pairs of interfaces that are to be loaded.

Definition at line 195 of file multi_interface_chooser_dialog.cpp.

References fawkes::InterfaceChooserDialog::__model, fawkes::MultiInterfaceChooserDialog::Record::load, and record().

Referenced by LaserGuiGtkWindow::on_select_clicked().

int fawkes::MultiInterfaceChooserDialog::init_columns ( )

protectedvirtual

Initializes the columns GUI-wise.

Called in the ctor. Subclasses of InterfaceChooserDialog might want to override this method, but should probably still call their super-class's implementation (i.e., this one).

Returns:: The number of columns added.

Reimplemented from fawkes::InterfaceChooserDialog.

Definition at line 155 of file multi_interface_chooser_dialog.cpp.

References fawkes::InterfaceChooserDialog::__treeview, and record().

void fawkes::MultiInterfaceChooserDialog::init_row	(	Gtk::TreeModel::Row &	row,
		const InterfaceInfo &	ii
	)

protectedvirtual

Initializes a row with the given interface.

Called in the ctor. Subclasses of InterfaceChooserDialog might want to override this method, but should probably still call their super-class's implementation (i.e., this one).

Parameters: