k3d::iapplication Class Reference

Abstract interface for the global K-3D Application object. More...

#include <iapplication.h>

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

List of all members.

Public Types

typedef std::vector< idocument * > document_collection_t
 A collection of idocument objects.
typedef sigc::signal< void,
const std::string & > 
startup_message_signal_t
 Defines a signal emitted to display progress messages to the user during application startup.

Public Member Functions

virtual bool exit ()=0
 Exit K-3D if safe to do so.
virtual idocumentcreate_document ()=0
 Creates a new K-3D document (could return NULL).
virtual void close_document (idocument &Document)=0
 Closes an open K-3D document.
virtual const document_collection_t documents ()=0
 Returns the collection of open documents.
virtual startup_message_signal_tstartup_message_signal ()=0
virtual sigc::connection connect_close_signal (const sigc::slot< void > &Slot)=0
 Connects a slot to a signal emitted when the application is closing.
virtual sigc::connection connect_close_document_signal (const sigc::slot< void, idocument & > &Slot)=0
 Connects a slot to a signal emitted when an existing document is closed.

Protected Member Functions

 iapplication ()
 iapplication (const iapplication &Other)
iapplicationoperator= (const iapplication &)
virtual ~iapplication ()

Detailed Description

Abstract interface for the global K-3D Application object.


Member Typedef Documentation

A collection of idocument objects.

typedef sigc::signal<void, const std::string&> k3d::iapplication::startup_message_signal_t

Defines a signal emitted to display progress messages to the user during application startup.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual void k3d::iapplication::close_document ( idocument Document  )  [pure virtual]
virtual sigc::connection k3d::iapplication::connect_close_document_signal ( const sigc::slot< void, idocument & > &  Slot  )  [pure virtual]

Connects a slot to a signal emitted when an existing document is closed.

Implemented in k3d::application_implementation::implementation.

virtual sigc::connection k3d::iapplication::connect_close_signal ( const sigc::slot< void > &  Slot  )  [pure virtual]
virtual idocument* k3d::iapplication::create_document (  )  [pure virtual]

Creates a new K-3D document (could return NULL).

Implemented in k3d::application_implementation::implementation.

Referenced by k3d::ngui::main_document_window::file_revert(), and k3d::python::module_open_document().

virtual const document_collection_t k3d::iapplication::documents (  )  [pure virtual]

Returns the collection of open documents.

Implemented in k3d::application_implementation::implementation.

Referenced by k3d::python::module_documents().

virtual bool k3d::iapplication::exit (  )  [pure virtual]
iapplication& k3d::iapplication::operator= ( const iapplication  )  [inline, protected]
virtual startup_message_signal_t& k3d::iapplication::startup_message_signal (  )  [pure virtual]

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

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