home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / ievent_loop.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.8 KB  |  74 lines
  1. #ifndef K3DSDK_IEVENT_LOOP_H
  2. #define K3DSDK_IEVENT_LOOP_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2006, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "iunknown.h"
  28.  
  29. #include <boost/program_options/parsers.hpp>
  30.  
  31. #include <string>
  32. #include <vector>
  33.  
  34. namespace boost { namespace filesystem { class path; } }
  35. namespace boost { namespace program_options { class options_description; } }
  36.  
  37. namespace k3d
  38. {
  39.  
  40. /// Abstract interface for event loop (user interface) plugins
  41. class ievent_loop :
  42.     public virtual iunknown
  43. {
  44. public:
  45.     virtual ~ievent_loop() {}
  46.  
  47.     /// Called by the host application to retrieve descriptions of command-line arguments for this plugin
  48.     virtual void get_command_line_arguments(boost::program_options::options_description& Description) = 0;
  49.     /// Defines storage for parsed command-line arguments
  50.     typedef std::vector<boost::program_options::basic_option<char> > arguments_t;
  51.     /// Called by the host application so the plugin can handle command-line arguments during startup
  52.     virtual const arguments_t parse_startup_arguments(const arguments_t& Arguments, bool& Quit, bool& Error) = 0;
  53.     /// Called by the host application to display informational messages during startup
  54.     virtual void startup_message_handler(const std::string& Message) = 0;
  55.     /// Called by the host application to display the "normal" user interface (and hide any startup / splash screens, etc)
  56.     virtual void display_user_interface() = 0;
  57.     /// Called by the host application so the plugin can handle command-line arguments after startup is complete
  58.     virtual const arguments_t parse_runtime_arguments(const arguments_t& Arguments, bool& Quit, bool& Error) = 0;
  59.     /// Called by the host application to start the main event-loop (if any)
  60.     virtual void start_event_loop() = 0;
  61.     /// Called by the host application to stop the main event-loop (if any)
  62.     virtual void stop_event_loop() = 0;
  63.  
  64. protected:
  65.     ievent_loop() {}
  66.     ievent_loop(const ievent_loop&) {}
  67.     ievent_loop& operator = (const ievent_loop&) { return *this; }
  68. };
  69.  
  70. } // namespace k3d
  71.  
  72. #endif // !K3DSDK_IEVENT_LOOP_H
  73.  
  74.