tubes: add few more comments

Change-Id: I263443d341805583f8ecedf0da738b75249b5d97
This commit is contained in:
Matúš Kukan
2012-08-20 12:05:50 +02:00
parent 24209be305
commit 2bb73133df
2 changed files with 12 additions and 5 deletions

View File

@@ -27,14 +27,18 @@ public:
Collaboration(); Collaboration();
virtual ~Collaboration(); virtual ~Collaboration();
/** Returns to normal editing mode */
virtual void EndCollaboration() const = 0; virtual void EndCollaboration() const = 0;
virtual void PacketReceived( const OString& rPacket ) const = 0; virtual void PacketReceived( const OString& rPacket ) const = 0;
/** Saves current document and then calls SendFile() with the file URL */
virtual void SaveAndSendFile( TpContact* pContact ) const = 0; virtual void SaveAndSendFile( TpContact* pContact ) const = 0;
/** Prepares document for collaboration and should call SetConference() */
virtual void StartCollaboration( TeleConference* pConference ) = 0; virtual void StartCollaboration( TeleConference* pConference ) = 0;
TUBES_DLLPRIVATE sal_uInt64 GetId() const; TUBES_DLLPRIVATE sal_uInt64 GetId() const;
TUBES_DLLPRIVATE void Invite( TpContact* pContact ) const; TUBES_DLLPRIVATE void Invite( TpContact* pContact ) const;
/** Application calls this to display contacts dialog from where can the collaboration start */
void DisplayContacts(); void DisplayContacts();
void SendFile( TpContact* pContact, const OUString& rURL ) const; void SendFile( TpContact* pContact, const OUString& rURL ) const;
void SendPacket( const OString& rPacket ) const; void SendPacket( const OString& rPacket ) const;

View File

@@ -61,9 +61,6 @@ typedef ::std::vector< AccountContactPair > AccountContactPairV;
class TeleManager class TeleManager
{ {
TeleManager();
~TeleManager();
public: public:
/** Prepare tube manager with account and service to be offered/listened /** Prepare tube manager with account and service to be offered/listened
to. to.
@@ -124,6 +121,8 @@ public:
static void registerCollaboration( Collaboration* pCollaboration ); static void registerCollaboration( Collaboration* pCollaboration );
static void unregisterCollaboration( Collaboration* pCollaboration ); static void unregisterCollaboration( Collaboration* pCollaboration );
/** Used to determine whether we are closing the channel by ourselves.
* @return true if the Collaboration is still registered */
static bool existsCollaboration( Collaboration* pCollaboration ); static bool existsCollaboration( Collaboration* pCollaboration );
/** Display contact list dialog for all documents. */ /** Display contact list dialog for all documents. */
static void displayAllContacts(); static void displayAllContacts();
@@ -133,11 +132,15 @@ public:
/** Broadcast packet to all conferences. Used for demo mode. */ /** Broadcast packet to all conferences. Used for demo mode. */
static void broadcastPacket( const OString& rPacket ); static void broadcastPacket( const OString& rPacket );
static void setCurrentUuid( const OString& rUuid );
static rtl::OString createUuid();
// Only for callbacks. // Only for callbacks.
static void addConference( TeleConference* pConference ); static void addConference( TeleConference* pConference );
static rtl::OString createUuid();
/** @param rUuid
is stored so that accepted conference with this UUID could be
then retrieved by getConference() when loading new document
*/
static void setCurrentUuid( const OString& rUuid );
/// "LibreOfficeWhatEver" /// "LibreOfficeWhatEver"
static rtl::OString getFullClientName(); static rtl::OString getFullClientName();