k3d::ievent_loop Class Reference

Abstract interface for event loop (user interface) plugins. More...

#include <ievent_loop.h>

Inheritance diagram for k3d::ievent_loop:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< boost::program_options::basic_option
< char > > 
arguments_t
 Defines storage for parsed command-line arguments.

Public Member Functions

virtual ~ievent_loop ()
virtual void get_command_line_arguments (boost::program_options::options_description &Description)=0
 Called by the host application to retrieve descriptions of command-line arguments for this plugin.
virtual const arguments_t parse_startup_arguments (const arguments_t &Arguments, bool &Quit, bool &Error)=0
 Called by the host application so the plugin can handle command-line arguments during startup.
virtual void startup_message_handler (const std::string &Message)=0
 Called by the host application to display informational messages during startup.
virtual void display_user_interface ()=0
 Called by the host application to display the "normal" user interface (and hide any startup / splash screens, etc).
virtual const arguments_t parse_runtime_arguments (const arguments_t &Arguments, bool &Quit, bool &Error)=0
 Called by the host application so the plugin can handle command-line arguments after startup is complete.
virtual void start_event_loop ()=0
 Called by the host application to start the main event-loop (if any).
virtual void stop_event_loop ()=0
 Called by the host application to stop the main event-loop (if any).

Protected Member Functions

 ievent_loop ()
 ievent_loop (const ievent_loop &)
ievent_loopoperator= (const ievent_loop &)

Detailed Description

Abstract interface for event loop (user interface) plugins.


Member Typedef Documentation

typedef std::vector<boost::program_options::basic_option<char> > k3d::ievent_loop::arguments_t

Defines storage for parsed command-line arguments.


Constructor & Destructor Documentation

virtual k3d::ievent_loop::~ievent_loop (  )  [inline, virtual]
k3d::ievent_loop::ievent_loop (  )  [inline, protected]
k3d::ievent_loop::ievent_loop ( const ievent_loop  )  [inline, protected]

Member Function Documentation

virtual void k3d::ievent_loop::display_user_interface (  )  [pure virtual]

Called by the host application to display the "normal" user interface (and hide any startup / splash screens, etc).

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

Referenced by k3d_main().

virtual void k3d::ievent_loop::get_command_line_arguments ( boost::program_options::options_description &  Description  )  [pure virtual]

Called by the host application to retrieve descriptions of command-line arguments for this plugin.

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

Referenced by k3d_main().

ievent_loop& k3d::ievent_loop::operator= ( const ievent_loop  )  [inline, protected]
virtual const arguments_t k3d::ievent_loop::parse_runtime_arguments ( const arguments_t Arguments,
bool &  Quit,
bool &  Error 
) [pure virtual]

Called by the host application so the plugin can handle command-line arguments after startup is complete.

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

Referenced by k3d_main().

virtual const arguments_t k3d::ievent_loop::parse_startup_arguments ( const arguments_t Arguments,
bool &  Quit,
bool &  Error 
) [pure virtual]

Called by the host application so the plugin can handle command-line arguments during startup.

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

Referenced by k3d_main().

virtual void k3d::ievent_loop::start_event_loop (  )  [pure virtual]

Called by the host application to start the main event-loop (if any).

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

Referenced by k3d_main().

virtual void k3d::ievent_loop::startup_message_handler ( const std::string &  Message  )  [pure virtual]

Called by the host application to display informational messages during startup.

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.

virtual void k3d::ievent_loop::stop_event_loop (  )  [pure virtual]

Called by the host application to stop the main event-loop (if any).

Implemented in module::ngui::user_interface, module::nui::user_interface, module::pyui::user_interface, and module::qtui::user_interface.


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

Generated on Mon Mar 21 07:41:44 2011 for K-3D by doxygen 1.6.3