From 2bb73133df604f44dfe7904c42bbc37827f3fd4c Mon Sep 17 00:00:00 2001 From: Matúš Kukan Date: Mon, 20 Aug 2012 12:05:50 +0200 Subject: tubes: add few more comments Change-Id: I263443d341805583f8ecedf0da738b75249b5d97 --- tubes/inc/tubes/collaboration.hxx | 4 ++++ tubes/inc/tubes/manager.hxx | 13 ++++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) (limited to 'tubes') diff --git a/tubes/inc/tubes/collaboration.hxx b/tubes/inc/tubes/collaboration.hxx index e3f765c1eeea..3f32d4188dbe 100644 --- a/tubes/inc/tubes/collaboration.hxx +++ b/tubes/inc/tubes/collaboration.hxx @@ -27,14 +27,18 @@ public: Collaboration(); virtual ~Collaboration(); + /** Returns to normal editing mode */ virtual void EndCollaboration() 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; + /** Prepares document for collaboration and should call SetConference() */ virtual void StartCollaboration( TeleConference* pConference ) = 0; TUBES_DLLPRIVATE sal_uInt64 GetId() const; TUBES_DLLPRIVATE void Invite( TpContact* pContact ) const; + /** Application calls this to display contacts dialog from where can the collaboration start */ void DisplayContacts(); void SendFile( TpContact* pContact, const OUString& rURL ) const; void SendPacket( const OString& rPacket ) const; diff --git a/tubes/inc/tubes/manager.hxx b/tubes/inc/tubes/manager.hxx index 27dcec7bb585..6a73cd54149a 100644 --- a/tubes/inc/tubes/manager.hxx +++ b/tubes/inc/tubes/manager.hxx @@ -61,9 +61,6 @@ typedef ::std::vector< AccountContactPair > AccountContactPairV; class TeleManager { - TeleManager(); - ~TeleManager(); - public: /** Prepare tube manager with account and service to be offered/listened to. @@ -124,6 +121,8 @@ public: static void registerCollaboration( 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 ); /** Display contact list dialog for all documents. */ static void displayAllContacts(); @@ -133,11 +132,15 @@ public: /** Broadcast packet to all conferences. Used for demo mode. */ static void broadcastPacket( const OString& rPacket ); - static void setCurrentUuid( const OString& rUuid ); - static rtl::OString createUuid(); // Only for callbacks. 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" static rtl::OString getFullClientName(); -- cgit v1.2.3