home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / iapplication.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.6 KB  |  84 lines

  1. #ifndef K3DSDK_IAPPLICATION_H
  2. #define K3DSDK_IAPPLICATION_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2005, 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 "iplugin_factory_collection.h"
  28. #include "iunknown.h"
  29. #include "signal_system.h"
  30.  
  31. #include <string>
  32. #include <vector>
  33.  
  34. namespace k3d
  35. {
  36.  
  37. class idocument;
  38.  
  39. /// Abstract interface for the global K-3D Application object
  40. class iapplication :
  41.     public virtual iunknown
  42. {
  43. public:
  44.     /// Exit K-3D if safe to do so
  45.     virtual bool exit() = 0;
  46.  
  47.     /// Creates a new K-3D document (could return NULL)
  48.     virtual idocument* create_document() = 0;
  49.     /// Closes an open K-3D document
  50.     virtual void close_document(idocument& Document) = 0;
  51.  
  52.     /// A collection of idocument objects
  53.     typedef std::vector<idocument*> document_collection_t;
  54.     /// Returns the collection of open documents
  55.     virtual const document_collection_t documents() = 0;
  56.  
  57.     /// Returns the collection of available plugin factories
  58.     /** \deprecated Use k3d::plugin::factory::lookup() instead. */
  59.     virtual const iplugin_factory_collection::factories_t& plugins() = 0;
  60.  
  61.     // Signals
  62.  
  63.     /// Defines a signal emitted to display progress messages to the user during application startup
  64.     typedef sigc::signal<void, const std::string&> startup_message_signal_t;
  65.     virtual startup_message_signal_t& startup_message_signal() = 0;
  66.  
  67.     /// Connects a slot to a signal emitted when the application is closing
  68.     virtual sigc::connection connect_close_signal(const sigc::slot<void>& Slot) = 0;
  69.  
  70.     /// Connects a slot to a signal emitted when an existing document is closed
  71.     virtual sigc::connection connect_close_document_signal(const sigc::slot<void, idocument&>& Slot) = 0;
  72.  
  73. protected:
  74.     iapplication() {}
  75.     iapplication(const iapplication&) {}
  76.     iapplication& operator = (const iapplication&) { return *this; }
  77.     virtual ~iapplication() {}
  78. };
  79.  
  80. } // namespace k3d
  81.  
  82. #endif // !K3DSDK_IAPPLICATION_H
  83.  
  84.