Swiftdiff options
| author | Tobias Markmann <tm@ayena.de> | 2016-12-08 09:22:52 (GMT) |
|---|---|---|
| committer | Edwin Mons <edwin.mons@isode.com> | 2016-12-09 08:30:45 (GMT) |
| commit | 7b34ce22fd646c252791a3eda5005178ab3f19bf (patch) | |
| tree | 79f99ecd31e90d37a2179e0b026eaf691cac0deb | |
| parent | da7162b6e80ed6ce802bece3891fe85f30770c56 (diff) | |
| download | swift-7b34ce22fd646c252791a3eda5005178ab3f19bf.zip swift-7b34ce22fd646c252791a3eda5005178ab3f19bf.tar.bz2 | |
Improve documentation of code related to impromptu chats
Test-Information:
Builds and all tests pass on macOS 10.12.1.
Change-Id: I58ca7ba27736d27426350f636dfe910f4f2f1b17
| -rw-r--r-- | Swift/Controllers/Chat/ChatsManager.cpp | 2 | ||||
| -rw-r--r-- | Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h | 10 | ||||
| -rw-r--r-- | Swift/QtUI/UserSearch/QtUserSearchWindow.h | 52 |
3 files changed, 38 insertions, 26 deletions
diff --git a/Swift/Controllers/Chat/ChatsManager.cpp b/Swift/Controllers/Chat/ChatsManager.cpp index 4f95d71..f55df1e 100644 --- a/Swift/Controllers/Chat/ChatsManager.cpp +++ b/Swift/Controllers/Chat/ChatsManager.cpp @@ -587,7 +587,7 @@ void ChatsManager::handleUIEvent(std::shared_ptr<UIEvent> event) { std::shared_ptr<CreateImpromptuMUCUIEvent> createImpromptuMUCEvent = std::dynamic_pointer_cast<CreateImpromptuMUCUIEvent>(event); if (createImpromptuMUCEvent) { assert(!localMUCServiceJID_.toString().empty()); - // create new muc + // The room JID is random for new impromptu rooms, or a predefined JID for impromptu rooms resumed from the 'Recent chats' list. JID roomJID = createImpromptuMUCEvent->getRoomJID().toString().empty() ? JID(idGenerator_.generateID(), localMUCServiceJID_) : createImpromptuMUCEvent->getRoomJID(); // join muc diff --git a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h index 22ce926..e420bad 100644 --- a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h +++ b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h @@ -23,11 +23,21 @@ namespace Swift { class CreateImpromptuMUCUIEvent : public UIEvent { public: + /** + * @brief CreateImpromptuMUCUIEvent + * @param jids A vector of JIDs that are invited to the imprompto MUC. + * Useful when the event is used to recreate an old impromptu + * chat room. + * @param roomJID The full JID of the impromtu MUC. Useful when the event + * is used to recreate an old impromptu chat room. + * @param reason + */ CreateImpromptuMUCUIEvent(const std::vector<JID>& jids, const JID& roomJID = JID(), const std::string reason = "") : jids_(jids), roomJID_(roomJID), reason_(reason) { } std::vector<JID> getJIDs() const { return jids_; } JID getRoomJID() const { return roomJID_; } std::string getReason() const { return reason_; } + private: std::vector<JID> jids_; JID roomJID_; diff --git a/Swift/QtUI/UserSearch/QtUserSearchWindow.h b/Swift/QtUI/UserSearch/QtUserSearchWindow.h index b9d4698..0714ac1 100644 --- a/Swift/QtUI/UserSearch/QtUserSearchWindow.h +++ b/Swift/QtUI/UserSearch/QtUserSearchWindow.h @@ -10,6 +10,8 @@ #include <QWizard> +#include <Swiften/Base/Override.h> + #include <Swift/Controllers/UIInterfaces/UserSearchWindow.h> #include <Swift/QtUI/UserSearch/ui_QtUserSearchWizard.h> @@ -33,37 +35,37 @@ namespace Swift { QtUserSearchWindow(UIEventStream* eventStream, UserSearchWindow::Type type, const std::set<std::string>& groups, SettingsProvider* settingsProvider); virtual ~QtUserSearchWindow(); - virtual void addSavedServices(const std::vector<JID>& services); + virtual void addSavedServices(const std::vector<JID>& services) SWIFTEN_OVERRIDE; - virtual void clear(); - virtual void show(); - virtual void setResults(const std::vector<UserSearchResult>& results); - virtual void setResultsForm(Form::ref results); - virtual void setSelectedService(const JID& jid); - virtual void setServerSupportsSearch(bool error); - virtual void setSearchError(bool error); - virtual void setSearchFields(std::shared_ptr<SearchPayload> fields); - virtual void setNameSuggestions(const std::vector<std::string>& suggestions); - virtual void prepopulateJIDAndName(const JID& jid, const std::string& name); - virtual void setContactSuggestions(const std::vector<Contact::ref>& suggestions); - virtual void setJIDs(const std::vector<JID> &jids); - virtual void setOriginator(const JID& originator); - virtual void setRoomJID(const JID &roomJID); - virtual std::string getReason() const; - virtual std::vector<JID> getJIDs() const; - virtual void setCanStartImpromptuChats(bool supportsImpromptu); - virtual void updateContacts(const std::vector<Contact::ref> &contacts); - virtual void addContacts(const std::vector<Contact::ref>& contacts); - virtual void setCanSupplyDescription(bool allowed); - virtual void setWarning(const boost::optional<std::string>& message); + virtual void clear() SWIFTEN_OVERRIDE; + virtual void show() SWIFTEN_OVERRIDE; + virtual void setResults(const std::vector<UserSearchResult>& results) SWIFTEN_OVERRIDE; + virtual void setResultsForm(Form::ref results) SWIFTEN_OVERRIDE; + virtual void setSelectedService(const JID& jid) SWIFTEN_OVERRIDE; + virtual void setServerSupportsSearch(bool error) SWIFTEN_OVERRIDE; + virtual void setSearchError(bool error) SWIFTEN_OVERRIDE; + virtual void setSearchFields(std::shared_ptr<SearchPayload> fields) SWIFTEN_OVERRIDE; + virtual void setNameSuggestions(const std::vector<std::string>& suggestions) SWIFTEN_OVERRIDE; + virtual void prepopulateJIDAndName(const JID& jid, const std::string& name) SWIFTEN_OVERRIDE; + virtual void setContactSuggestions(const std::vector<Contact::ref>& suggestions) SWIFTEN_OVERRIDE; + virtual void setJIDs(const std::vector<JID> &jids) SWIFTEN_OVERRIDE; + virtual void setOriginator(const JID& originator) SWIFTEN_OVERRIDE; + virtual void setRoomJID(const JID &roomJID) SWIFTEN_OVERRIDE; + virtual std::string getReason() const SWIFTEN_OVERRIDE; + virtual std::vector<JID> getJIDs() const SWIFTEN_OVERRIDE; + virtual void setCanStartImpromptuChats(bool supportsImpromptu) SWIFTEN_OVERRIDE; + virtual void updateContacts(const std::vector<Contact::ref> &contacts) SWIFTEN_OVERRIDE; + virtual void addContacts(const std::vector<Contact::ref>& contacts) SWIFTEN_OVERRIDE; + virtual void setCanSupplyDescription(bool allowed) SWIFTEN_OVERRIDE; + virtual void setWarning(const boost::optional<std::string>& message) SWIFTEN_OVERRIDE; protected: - virtual int nextId() const; + virtual int nextId() const SWIFTEN_OVERRIDE; private slots: void handleFirstPageRadioChange(); - virtual void handleCurrentChanged(int); - virtual void handleAccepted(); + void handleCurrentChanged(int); + void handleAccepted(); void handleContactSuggestionRequested(const QString& text); void addContact(); void handleAddViaSearch(); |