smf/inc/common/smfcomment/smfcomment.h
changeset 5 edb9dc8273d9
parent 3 0446eb7b28aa
equal deleted inserted replaced
4:969092730d34 5:edb9dc8273d9
    29 
    29 
    30 /**
    30 /**
    31  * @ingroup smf_common_group
    31  * @ingroup smf_common_group
    32  * The comment class represents a comment (on a picture or a music track etc)
    32  * The comment class represents a comment (on a picture or a music track etc)
    33  */
    33  */
    34 class SMFCLIENT_EXPORT SmfComment : public QObject
    34 class SMFCLIENT_EXPORT SmfComment
    35 	{
    35 	{
    36 	Q_OBJECT
       
    37 public:
    36 public:
    38 	/**
    37 	/**
    39 	 * Constructor with default argument
    38 	 * Constructor with default argument
    40 	 * @param aParent The parent object 
       
    41 	 */
    39 	 */
    42 	SmfComment( QObject *aParent = 0 );
    40 	SmfComment();
    43 	
    41 	
    44 	/**
    42 	/**
    45 	 * Copy Constructor
    43 	 * Copy Constructor
    46 	 * @param aOther The reference object
    44 	 * @param aOther The reference object
    47 	 */
    45 	 */
    48 	SmfComment( const SmfComment &aOther );
    46 	SmfComment( const SmfComment &aOther );
       
    47 	
       
    48 	/**
       
    49 	 * Overloaded = operator
       
    50 	 * @param aOther The reference object
       
    51 	 * @return The current object reference
       
    52 	 */
       
    53 	SmfComment& operator=(const SmfComment &aOther);
    49 	
    54 	
    50 	/**
    55 	/**
    51 	 * Destructor
    56 	 * Destructor
    52 	 */
    57 	 */
    53 	~SmfComment( );
    58 	~SmfComment( );
    69 	 * @return The ID value 
    74 	 * @return The ID value 
    70 	 */
    75 	 */
    71 	QString id( ) const;
    76 	QString id( ) const;
    72 	
    77 	
    73 	/**
    78 	/**
       
    79 	 * Method to get the canonical link for the comment
       
    80 	 * @return The base url 
       
    81 	 */
       
    82 	QString link( ) const;
       
    83 
       
    84 	/**
    74 	 * Method to set the comment text
    85 	 * Method to set the comment text
    75 	 * @param aText The comment text to be set
    86 	 * @param aText The comment text to be set
    76 	 */
    87 	 */
    77 	void setText( const QString &aText );
    88 	void setText( const QString &aText );
    78 	
    89 	
       
    90 	/**
       
    91 	 * Method to set the time stamp
       
    92 	 * @param aDateTime The comment time stamp value to be set
       
    93 	 */
       
    94 	void setTimeStamp( const QDateTime &aDateTime );
       
    95 	
       
    96 	/**
       
    97 	 * Method to set the id of the comment
       
    98 	 * @param aId The ID value to be set
       
    99 	 */
       
   100 	void setId( const QString &aId );
       
   101 	
       
   102 	/**
       
   103 	 * Method to set the link of the comment
       
   104 	 * @param aLink The url to be set
       
   105 	 */
       
   106 	void setLink( const QString &aLink );
       
   107 
    79 private:
   108 private:
    80 	QSharedDataPointer<SmfCommentPrivate> d;
   109 	QSharedDataPointer<SmfCommentPrivate> d;
    81 	
   110 	
    82 	friend QDataStream &operator<<( QDataStream &aDataStream, 
   111 	friend QDataStream &operator<<( QDataStream &aDataStream, 
    83 			const SmfComment &aComment );
   112 			const SmfComment &aComment );
   106  * @return reference to the stream
   135  * @return reference to the stream
   107  */
   136  */
   108 QDataStream &operator>>( QDataStream &aDataStream, 
   137 QDataStream &operator>>( QDataStream &aDataStream, 
   109 		SmfComment &aComment);
   138 		SmfComment &aComment);
   110 
   139 
       
   140 
   111 // Make the class SmfComment known to QMetaType, so that as to register it.
   141 // Make the class SmfComment known to QMetaType, so that as to register it.
   112 Q_DECLARE_METATYPE(SmfComment)
   142 Q_DECLARE_METATYPE(SmfComment)
   113 
   143 
       
   144 
   114 #endif /* SMFCOMMENT_H_ */
   145 #endif /* SMFCOMMENT_H_ */