RetrieverConfigPlugin Class Reference

Config editor plugin for the fvretriever plugin. More...

#include <tools/config_editor/retriever_config_plugin.h>

Inheritance diagram for RetrieverConfigPlugin:

[legend]
List of all members.

Public Member Functions

 RetrieverConfigPlugin (std::string glade_path)
 Constructor.
virtual ~RetrieverConfigPlugin ()
 Destructor.

Protected Member Functions

virtual void pre_run ()
 Config editor plugins need to implement this function.
virtual void post_run (int response)
 This method is called after the dialog is closed.
virtual Gtk::Dialog * load_dialog ()
 In this function the (custom) dialog of the plugin needs to be initialized.

Detailed Description

Config editor plugin for the fvretriever plugin.

Author:
Daniel Beck

Definition at line 81 of file retriever_config_plugin.h.


Constructor & Destructor Documentation

RetrieverConfigPlugin::RetrieverConfigPlugin ( std::string  glade_path  ) 

Constructor.

Parameters:
glade_path path to the Glade file for the plugin's dialog

Definition at line 168 of file retriever_config_plugin.cpp.

RetrieverConfigPlugin::~RetrieverConfigPlugin (  )  [virtual]

Destructor.

Definition at line 174 of file retriever_config_plugin.cpp.


Member Function Documentation

Gtk::Dialog * RetrieverConfigPlugin::load_dialog (  )  [protected, virtual]

In this function the (custom) dialog of the plugin needs to be initialized.

Returns:
pointer to the loaded dialog

Implements ConfigEditorPlugin.

Definition at line 237 of file retriever_config_plugin.cpp.

References ConfigEditorPlugin::m_ref_xml.

void RetrieverConfigPlugin::post_run ( int  response  )  [protected, virtual]

This method is called after the dialog is closed.

Here, the input the user has made needs to be handled.

Parameters:
response the response obtained from the run() method of the dialog (Gtk::RESPONSE_OK or Gtk::RESPONSE_CANCEL)

Implements ConfigEditorPlugin.

Definition at line 206 of file retriever_config_plugin.cpp.

References RetrieverConfigDialog::get_cameras(), ConfigEditorPlugin::m_config, ConfigEditorPlugin::m_config_path, ConfigEditorPlugin::m_dialog, and fawkes::Configuration::set_string().

void RetrieverConfigPlugin::pre_run (  )  [protected, virtual]

Config editor plugins need to implement this function.

It is called before the actual dialog is opened. Ususally, plugins want to parse the configuration, here, and initialize the GUI elements of the dialog.

Implements ConfigEditorPlugin.

Definition at line 179 of file retriever_config_plugin.cpp.

References fawkes::Configuration::ValueIterator::get_string(), fawkes::Configuration::ValueIterator::is_string(), fawkes::Configuration::lock(), ConfigEditorPlugin::m_config, ConfigEditorPlugin::m_config_path, ConfigEditorPlugin::m_dialog, fawkes::Configuration::ValueIterator::next(), fawkes::Configuration::ValueIterator::path(), fawkes::Configuration::search(), fawkes::Configuration::ValueIterator::type(), and fawkes::Configuration::unlock().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:33 2011 for Fawkes API by  doxygen 1.4.7