backup before review

[situare] / src / ui / userinfo.h

diff --git a/src/ui/userinfo.h b/src/ui/userinfo.h
index 45d8877..bdb45e2 100644 (file)
--- a/src/ui/userinfo.h
+++ b/src/ui/userinfo.h
@@ -6,6 +6,7 @@
        Jussi Laitinen - jussi.laitinen@ixonos.com
        Katri Kaikkonen - katri.kaikkonen@ixonos.com
        Henri Lampela - henri.lampela@ixonos.com
+       Ville Tiensuu - ville.tiensuu@ixonos.com
 
    Situare is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
@@ -113,18 +114,45 @@ public:
     void setUserName(const QString &name);
 
 public slots:
+
+    /**
+    * @brief Clears backups of message and publish on Facebook setting
+    */
     void clearUpdateLocationDialogData();
+
+    /**
+    * @brief Saves status message and Facebook publish setting
+    *
+    * @param status message that user sends. Message is stored to m_backupMessage data member
+    * @param publish setting that determines whether the user status message is published on
+    *        Facebook. Value of this bool is stored to m_backupFacebookPublishPolicity data member
+    */
+    void backupUpdateLocationDialogData(const QString &status, const bool &publish);
+
     /**
     * @brief Sets the message text
     *
     * @param text Reference to user message
     */
     void setMessageText(const QString &text);
-    void backupUpdateLocationDialogData(const QString &status, const bool &publish);
-    void verifyMessageUpdateToServer(const QString errorMessage);
+
+
+    /**
+    * @brief Emits signal to inform user about failed message/location update.
+    *        Contains logic to send signal only after failed message/location update.
+    *
+    * @param errorMessage from Situare server. Message is not used in this function
+    */
+    void verifyMessageUpdateToServer(const QString &errorMessage);
 
 private:
+
+    /**
+    * @brief reads Unsend message from settings at startup
+    *
+    */
     void restoreUnsendMessage();
+
     /**
     * @brief Set shortened or full-length text to labels.
     *
@@ -163,6 +191,20 @@ signals:
     void findUser(const QPointF &coordinates);
 
     /**
+    * @brief Signal that informs that user's message/location failed to update on Situare server
+    *        This signal is originally sended from SituareService with name error
+    *        Signal is renamed on MainWindow
+    */
+    void messageSendingFailed(const QString &error);
+
+    /**
+    * @brief Signal that used to inform user that his message/location update tp Situare server
+    *        was failed.
+    *        This signal is originally sended from UserInfo
+    */
+    void notificateUpdateFailing(const QString &message);
+
+    /**
     * @brief Signal for refreshing user data.
     *
     */
@@ -188,17 +230,13 @@ signals:
     * @param publish Publish on Facebook
     */
     void statusUpdate(const QString &status, const bool &publish);
-    void messageUpdatedToSituare();
-    void messageSendingFailed(const QString &error);
-    void notificateUpdateFailing(const QString &message);
-
 /******************************************************************************
 * DATA MEMBERS
 ******************************************************************************/
 private:
-    bool m_expanded;                    ///< Item expanded state
     bool m_backupFacebookPublishPolicity; ///< Backup of publish on Facebook checkbox value
-    bool m_messageUpdateVerified;
+    bool m_expanded;                    ///< Item expanded state   
+    bool m_messageUpdateVerified;       ///< Place for message/location update check
     QLabel *m_locationLabel;            ///< Location label
     QLabel *m_nameLabel;                ///< Name label
     QLabel *m_statusTextLabel;          ///< Status text label