From: Ville Tiensuu Date: Mon, 19 Apr 2010 11:44:58 +0000 (+0300) Subject: changed order of methods and variables to match with common style X-Git-Tag: v0.2^2^2 X-Git-Url: http://git.maemo.org/git/?a=commitdiff_plain;h=c998596a681c09f2b9c01111be1aacd44d712c47;p=situare changed order of methods and variables to match with common style --- diff --git a/src/facebookservice/facebookauthentication.h b/src/facebookservice/facebookauthentication.h index dc0f947..0d07323 100644 --- a/src/facebookservice/facebookauthentication.h +++ b/src/facebookservice/facebookauthentication.h @@ -77,40 +77,16 @@ public slots: */ void start(); -private slots: - /** - * @brief Search credentials from URL that is given as parameter. - * If credentials are found thay are stored to loginCredentials variable. - * - * @param url URL where this method tries to find credentials. - * @return bool if credentials are found returns true, - * if credentials are not found returns false. - */ - bool updateCredentials(const QUrl & url); - -signals: - - /** - * @brief This signal is emitted if user exits logging in by pressing X - * - */ - void userExit(); - - /** - * @brief This signal is emitted if updateCredentials method finds credentials from URL. - * Signal is also emitted at the beginning of the program if there is valid credentials - * in the file. - * - */ - void credentialsReady(); +private: /** - * @brief This signal is emitted if updateCredentials method can't find credentials from URL + * @brief Program cames to this method when user closes login screen by pressing X. + * method sends userExit() signal in this function * + * @param event without parameter program does not come to this function when user exits by + * pressing X. */ - void loginFailure(); - -private: + void closeEvent(QCloseEvent *event); /** * @brief Appends given parts to returned string. Method is used to form facebook login page @@ -129,13 +105,12 @@ private: const QString & part7) const; /** - * @brief Program cames to this method when user closes login screen by pressing X. - * method sends userExit() signal in this function + * @brief Reads previous stored credentials from file. * - * @param event without parameter program does not come to this function when user exits by - * pressing X. + * @param credentialsFromFile This dataclass is the place where method stores credentials. + * Corrent parameter here is m_loginCredentials */ - void closeEvent(QCloseEvent *event); + void readCredentials(FacebookCredentials &credentialsFromFile); /** * @brief Checks expiration time of credentials and compares it to current time. @@ -144,36 +119,49 @@ private: * @return bool returns true if expiration time is after current time. in other cases returns * false. */ - bool verifyCredentials(const FacebookCredentials &credentials) const; + bool verifyCredentials(const FacebookCredentials &credentials) const; /** - * @brief Reads previous stored credentials from file. + * @brief Writes credentials to File * - * @param credentialsFromFile This dataclass is the place where method stores credentials. - * Corrent parameter here is m_loginCredentials + * @param credentials Contents of this dataclass is stored to file */ - void readCredentials(FacebookCredentials &credentialsFromFile); + void writeCredentials(const FacebookCredentials &credentials); +private slots: /** - * @brief Writes credentials to File + * @brief Search credentials from URL that is given as parameter. + * If credentials are found thay are stored to loginCredentials variable. * - * @param credentials Contents of this dataclass is stored to file + * @param url URL where this method tries to find credentials. + * @return bool if credentials are found returns true, + * if credentials are not found returns false. */ - void writeCredentials(const FacebookCredentials &credentials); + bool updateCredentials(const QUrl & url); + +signals: /** - * @brief Shows facebook login page. + * @brief This signal is emitted if updateCredentials method finds credentials from URL. + * Signal is also emitted at the beginning of the program if there is valid credentials + * in the file. * - * @var m_webView */ - QWebView *m_webView; + void credentialsReady(); /** - * @brief Lays out m_webView in window. + * @brief This signal is emitted if updateCredentials method can't find credentials from URL * - * @var m_mainlayout */ - QHBoxLayout *m_mainlayout; + void loginFailure(); + + /** + * @brief This signal is emitted if user exits logging in by pressing X + * + */ + void userExit(); + +private: /** * @brief String that contantains URL of facebook loginpage. @@ -189,6 +177,20 @@ private: * @var m_loginCredentials */ FacebookCredentials m_loginCredentials; + + /** + * @brief Lays out m_webView in window. + * + * @var m_mainlayout + */ + QHBoxLayout *m_mainlayout; + + /** + * @brief Shows facebook login page. + * + * @var m_webView + */ + QWebView *m_webView; }; #endif // FACEBOOKAUTHENTICATION_H diff --git a/src/facebookservice/facebookcredentials.h b/src/facebookservice/facebookcredentials.h index 52cfdbc..08f48e1 100644 --- a/src/facebookservice/facebookcredentials.h +++ b/src/facebookservice/facebookcredentials.h @@ -40,6 +40,13 @@ public: FacebookCredentials(); /** + * @brief Set funtion for m_expires member + * + * @param expiresParameter value of parameter is set to m_expires member + */ + void setExpires (const QString & expiresParameter); + + /** * @brief Set function for m_sessionKey member * * @param sessionKeyParameter value of parameter is set to m_sessionKey member @@ -54,11 +61,11 @@ public: void setSessionSecret(const QString & sessionSecretParameter); /** - * @brief Set funtion for m_expires member + * @brief Set funtion for m_sig member * - * @param expiresParameter value of parameter is set to m_expires member + * @param sigParameter value of parameter is set to m_sig member */ - void setExpires (const QString & expiresParameter); + void setSig(const QString & sigParameter); /** * @brief Set function for m_userID member @@ -68,11 +75,11 @@ public: void setUserID(const QString & userIDParameter); /** - * @brief Set funtion for m_sig member + * @brief Get function for m_expires member * - * @param sigParameter value of parameter is set to m_sig member + * @return QString m_expires */ - void setSig(const QString & sigParameter); + QString expires() const; /** * @brief Get function for m_sessionKey member @@ -89,25 +96,18 @@ public: QString sessionSecret() const; /** - * @brief Get function for m_expires member + * @brief Get function for m_sig member * - * @return QString m_expires + * @return QString m_sig */ - QString expires() const; + QString sig() const; /** * @brief Get function for m_userID member * * @return QString m_userID */ - QString userID() const; - - /** - * @brief Get function for m_sig member - * - * @return QString m_sig - */ - QString sig() const; + QString userID() const; /** * @brief Overloaded operator == is used to compare two FacebookCredentials. @@ -118,6 +118,14 @@ public: bool operator==(const FacebookCredentials& credentials); private: + + /** + * @brief String for storing expires + * + * @var m_expires + */ + QString m_expires; + /** * @brief String for storing sessionKey * @@ -133,25 +141,18 @@ private: QString m_sessionSecret; /** - * @brief String for storing expires + * @brief String for storing sig * - * @var m_expires + * @var m_sig */ - QString m_expires; + QString m_sig; /** * @brief String for storing userID * * @var m_userID */ - QString m_userID; - - /** - * @brief String for storing sig - * - * @var m_sig - */ - QString m_sig; + QString m_userID; }; #endif // FACEBOOKCREDENTIALS_H