obby::jupiter_undo< Document > Class Template Reference

#include <jupiter_undo.hpp>

List of all members.

Public Types

typedef Document document_type
typedef operation< document_typeoperation_type

Public Member Functions

 jupiter_undo (const document_type &doc)
 ~jupiter_undo ()
void client_add (const user &client)
void client_remove (const user &client)
void local_op (const operation_type &op, const user *from)
void remote_op (const operation_type &op, const user *from)
bool can_undo ()
std::auto_ptr< operation_typeundo ()

Protected Attributes

const document_typem_doc


Detailed Description

template<typename Document>
class obby::jupiter_undo< Document >

Undo manager for the jupiter class.

TODO: IMPLEMENT ME!

Definition at line 35 of file jupiter_undo.hpp.


Member Typedef Documentation

template<typename Document>
typedef Document obby::jupiter_undo< Document >::document_type

Definition at line 38 of file jupiter_undo.hpp.

template<typename Document>
typedef operation<document_type> obby::jupiter_undo< Document >::operation_type

Definition at line 39 of file jupiter_undo.hpp.


Constructor & Destructor Documentation

template<typename Document>
obby::jupiter_undo< Document >::jupiter_undo ( const document_type doc  ) 

Definition at line 72 of file jupiter_undo.hpp.

template<typename Document>
obby::jupiter_undo< Document >::~jupiter_undo (  ) 

Definition at line 78 of file jupiter_undo.hpp.


Member Function Documentation

template<typename Document>
void obby::jupiter_undo< Document >::client_add ( const user client  ) 

Adds a new client to the undo manager.

Definition at line 83 of file jupiter_undo.hpp.

Referenced by obby::jupiter_client< Document >::client_add().

template<typename Document>
void obby::jupiter_undo< Document >::client_remove ( const user client  ) 

Removes a client from the undo manager.

Definition at line 88 of file jupiter_undo.hpp.

Referenced by obby::jupiter_client< Document >::client_remove().

template<typename Document>
void obby::jupiter_undo< Document >::local_op ( const operation_type op,
const user from 
)

Operation op has been performed locally by from.

Definition at line 93 of file jupiter_undo.hpp.

Referenced by obby::jupiter_server< Document >::local_op(), and obby::jupiter_client< Document >::local_op().

template<typename Document>
void obby::jupiter_undo< Document >::remote_op ( const operation_type op,
const user from 
)

Operation op has been performed remotely by from.

Definition at line 99 of file jupiter_undo.hpp.

Referenced by obby::jupiter_server< Document >::remote_op(), and obby::jupiter_client< Document >::remote_op().

template<typename Document>
bool obby::jupiter_undo< Document >::can_undo (  ) 

Returns TRUE if the user can undo its last operation.

Definition at line 105 of file jupiter_undo.hpp.

template<typename Document>
std::auto_ptr< typename jupiter_undo< Document >::operation_type > obby::jupiter_undo< Document >::undo (  ) 

Returns an operation that undoes the last operation of this user.

Definition at line 112 of file jupiter_undo.hpp.

Referenced by obby::jupiter_server< Document >::undo_op(), and obby::jupiter_client< Document >::undo_op().


Member Data Documentation

template<typename Document>
const document_type& obby::jupiter_undo< Document >::m_doc [protected]

Definition at line 68 of file jupiter_undo.hpp.


The documentation for this class was generated from the following file:
Generated on Fri Jan 11 10:01:33 2008 for obby by  doxygen 1.5.1