Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
RetrieverConfigPlugin Class Reference

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

#include <tools/config_editor/retriever_config_plugin.h>

Inheritance diagram for RetrieverConfigPlugin:

Public Member Functions

 RetrieverConfigPlugin (std::string ui_path)
 Constructor. More...
 
virtual ~RetrieverConfigPlugin ()
 Destructor. More...
 
- Public Member Functions inherited from ConfigEditorPlugin
 ConfigEditorPlugin (std::string config_path, std::string ui_file)
 Constructor. More...
 
virtual ~ConfigEditorPlugin ()
 Destructor. More...
 
void initialize ()
 Initialize the plugin. More...
 
void run ()
 Run the plugin. More...
 
std::string get_config_path () const
 Get the config prefix specified for this config editor plugin. More...
 
void set_config (fawkes::Configuration *config)
 Set the configuration for the plugin to work on. More...
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ConfigEditorPlugin
Gtk::Dialog * m_dialog
 The (main-) dialog of the plugin. More...
 
Glib::RefPtr< Gtk::Builder > m_builder
 Gtk Builder created from the UI file of the plugin. More...
 
std::string m_config_path
 The config prefix the plugin is attached to. More...
 
fawkes::Configurationm_config
 The fawkes::Configuration. More...
 

Detailed Description

Config editor plugin for the fvretriever plugin.

Author
Daniel Beck

Definition at line 82 of file retriever_config_plugin.h.

Constructor & Destructor Documentation

RetrieverConfigPlugin::RetrieverConfigPlugin ( std::string  ui_path)

Constructor.

Parameters
ui_pathpath to the UI 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 ( )
protectedvirtual

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_builder.

void RetrieverConfigPlugin::post_run ( int  response)
protectedvirtual

This method is called after the dialog is closed.

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

Parameters
responsethe 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 ( )
protectedvirtual

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