smf/smfservermodule/smfclient/client/smfpostprovider.h
changeset 14 a469c0e6e7fb
parent 10 77a56c951f86
--- a/smf/smfservermodule/smfclient/client/smfpostprovider.h	Mon Jun 07 11:43:45 2010 +0100
+++ b/smf/smfservermodule/smfclient/client/smfpostprovider.h	Wed Jun 23 19:51:49 2010 +0530
@@ -13,7 +13,7 @@
  * Manasij Roy, Nalina Hariharan
  * 
  * Description:
- * The SmfEvent class represents an event
+ * SmfPostProvider
  *
  */
 #ifndef SMFPOSTPROVIDER_H
@@ -30,8 +30,7 @@
 #include "smfcontact.h"
 #include "smflocation.h"
 #include "smfpost.h"
-
-class SmfPostProviderPrivate;
+#include "smfpostprovider_p.h"
 
 /**
  * @ingroup smf_client_group 
@@ -51,7 +50,7 @@
 	 * Constructs SmfPostProvider.
 	 * @param baseProvider The base provider info
 	 * Seeing as this is a plug-in implementation, these will realistically
-	 * be generated by SMF factory of some kind
+	 * be generated by SMF factory of some kind
 	 */
 	SmfPostProvider(SmfProvider* baseProvider);
 	~SmfPostProvider();
@@ -60,23 +59,23 @@
 public:
 	/**
 	 * returns maximum no of chars (unicode) that service provider can post without truncation
-	 * negative value means no limit
+	 * negative value means no limit
 	 */
 	qint32 maxCharsInPost() const;
 	/**
 	 * returns maximum no of items that can be returned in a single query to getPosts
-	 * negative value means feature not supported.
+	 * negative value means feature not supported.
 	 */
 	qint32 maxItems() const;
 
 	/**
 	 * returns all the formatting of posts that this service provider supports.
-	 * May return 0 items to mean only QString is supported.
+	 * May return 0 items to mean only QString is supported.
 	 */
 	QVector<QTextFormat> supportedFormats () const;
 	
 	/**
-	 * returns whether this SP supports Appearence @see SmfAppearenceInfo
+	 * returns whether this SP supports Appearence @see SmfAppearenceInfo
 	 */
 	bool supportsAppearence () const;
 
@@ -87,7 +86,7 @@
 	 * @param user user's contact in this SP, omit for self contact
 	 * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
      * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE 
-	 * @see postsAvailable()
+	 * @see postsAvailable()
 	 */
 	void posts(SmfContact* user = 0,int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE);
 	
@@ -111,7 +110,7 @@
 	 * updatePostFinished() signal.
 	 * @param postData data to be posted
 	 * @param contact contact to which the post is to be directed
-	 * @param location location data
+	 * @param location location data
 	 */
 	void postDirected(SmfPost& postData,SmfContact& contact,SmfLocation* location=0);
 	
@@ -119,7 +118,7 @@
 	 * Posts appearance info of the user.e.g. appear offline, busy, do-not-disturb
 	 * @param appearence user appearance
 	 * @see SmfPresenceInfo
-	 * @return False on Failure/Not supported 
+	 * @return False on Failure/Not supported 
 	 */
 	bool postAppearence(SmfAppearenceInfo appearence); 
 	/**
@@ -154,15 +153,15 @@
 	 * In that case this signal is emitted multiple times.
 	 * @param list list of posts
 	 * @param error error string
-	 * @param resultPage Page number info
+	 * @param resultPage Page number info
 	 */
 	void postsAvailable(SmfPostList* list, SmfError error, SmfResultPage resultPage);
 	
 	/**
 	 * Emitted when update post is finished.
-	 * @param success the success of the update
+	 * @param success the success of the update
 	 */
-	void postFinished(bool success);
+	void postFinished(SmfError success);
 	/**
 	 * Emitted when custom data is available
 	 * @param operationId Requested operation id