• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KBlog Client Library

KBlog::BlogComment

KBlog::BlogComment Class Reference

A class that represents a blog comment on the blog post. More...

#include <blogcomment.h>

List of all members.

Public Types

enum  Status {
  New, Fetched, Created, Removed,
  Error
}

Public Member Functions

 BlogComment (const QString &commentId=QString())
 BlogComment (const BlogComment &comment)
virtual ~BlogComment ()
QString commentId () const
QString content () const
KDateTime creationDateTime () const
QString email () const
QString error () const
KDateTime modificationDateTime () const
QString name () const
BlogComment & operator= (const BlogComment &comment)
void setCommentId (const QString &id)
void setContent (const QString &content)
void setCreationDateTime (const KDateTime &datetime)
void setEmail (const QString &email)
void setError (const QString &error)
void setModificationDateTime (const KDateTime &datetime)
void setName (const QString &name)
void setStatus (Status status)
void setTitle (const QString &title)
void setUrl (const KUrl &url)
Status status () const
void swap (BlogComment &other)
QString title () const
KUrl url () const

Detailed Description

A class that represents a blog comment on the blog post.

  KBlog::BlogComment *comment = new BlogComment();
  comment->setTitle( "This is the title." );
  comment->setContent( "Here is some the content..." );
Author:
Mike Arthur <mike@mikearthur.co.uk>

Definition at line 50 of file blogcomment.h.


Member Enumeration Documentation

enum KBlog::BlogComment::Status

The enumartion of the different post status, reflecting the status changes on the server.

Enumerator:
New 

Status of a freshly constructed comment on the client.

Fetched 

Status of a successfully fetched comment.

Created 

Status of a successfully created comment.

See also:
GData::createComment( BlogPost*, BlogComment* )
Removed 

Status of a successfully removed comment.

See also:
GData::removeComment( BlogPost*, BlogComment* )
Error 

Status when an error has occurred on the server side.

See also:
error()

Definition at line 202 of file blogcomment.h.


Constructor & Destructor Documentation

KBlog::BlogComment::BlogComment ( const BlogComment &  comment  ) 

Copy Constructor for list handling.

Parameters:
comment The comment to copy.

Definition at line 27 of file blogcomment.cpp.

KBlog::BlogComment::BlogComment ( const QString &  commentId = QString()  )  [explicit]

Constructor.

Parameters:
commentId The ID of the comment on the server.

Definition at line 43 of file blogcomment.cpp.

KBlog::BlogComment::~BlogComment (  )  [virtual]

Virtual default destructor.

Definition at line 51 of file blogcomment.cpp.


Member Function Documentation

QString KBlog::BlogComment::commentId (  )  const

Returns the comment's id.

Returns:
The comment's id
See also:
setCommentId( const QString& )

Definition at line 76 of file blogcomment.cpp.

QString KBlog::BlogComment::content (  )  const

Returns the content.

Returns:
The content.
See also:
setContent( const QString& )

Definition at line 66 of file blogcomment.cpp.

KDateTime KBlog::BlogComment::creationDateTime (  )  const

Returns the creation date-time.

Returns:
The creation date-time.
See also:
setCreationDateTime( const KDateTime& )

Definition at line 125 of file blogcomment.cpp.

QString KBlog::BlogComment::email (  )  const

Returns the E-Mail address of the commentator.

Returns:
The E-Mail.
See also:
setEmail( const QString& )

Definition at line 86 of file blogcomment.cpp.

QString KBlog::BlogComment::error (  )  const

Returns the last error.

Returns:
The last error string.
See also:
setError( const QString& ), Error

Definition at line 145 of file blogcomment.cpp.

KDateTime KBlog::BlogComment::modificationDateTime (  )  const

Returns the modification date-time.

Returns:
The modification date-time.
See also:
setModificationDateTime( const KDateTime& )

Definition at line 115 of file blogcomment.cpp.

QString KBlog::BlogComment::name (  )  const

Returns the commentator's name.

Returns:
The name.
See also:
setName()

Definition at line 96 of file blogcomment.cpp.

BlogComment & KBlog::BlogComment::operator= ( const BlogComment &  comment  ) 

Overloaded for QList handling.

Definition at line 155 of file blogcomment.cpp.

void KBlog::BlogComment::setCommentId ( const QString &  id  ) 

Sets the comment's id.

Parameters:
id The comment's id.
See also:
commentId()

Definition at line 81 of file blogcomment.cpp.

void KBlog::BlogComment::setContent ( const QString &  content  ) 

Sets the content.

Parameters:
content This is the content.
See also:
content()

Definition at line 71 of file blogcomment.cpp.

void KBlog::BlogComment::setCreationDateTime ( const KDateTime &  datetime  ) 

Sets the creation date-time.

Parameters:
datetime The date-time the comment has been created.
See also:
creationDateTime()

Definition at line 130 of file blogcomment.cpp.

void KBlog::BlogComment::setEmail ( const QString &  email  ) 

Sets the E-Mail.

Parameters:
email This is the E-Mail address of the commentator.
See also:
email()

Definition at line 91 of file blogcomment.cpp.

void KBlog::BlogComment::setError ( const QString &  error  ) 

Sets the error.

Parameters:
error The error string.
See also:
error(), Error

Definition at line 150 of file blogcomment.cpp.

void KBlog::BlogComment::setModificationDateTime ( const KDateTime &  datetime  ) 

Sets the modification date-time.

Parameters:
datetime The date-time the comment has been modified.
See also:
modificationDateTime( const KDateTime& )

Definition at line 120 of file blogcomment.cpp.

void KBlog::BlogComment::setName ( const QString &  name  ) 

Sets the name of the commentator.

Parameters:
name This is the commenator's name.
See also:
name()

Definition at line 101 of file blogcomment.cpp.

void KBlog::BlogComment::setStatus ( BlogComment::Status  status  ) 

Sets the status.

Parameters:
status The status on the server.
See also:
status(), Status

Definition at line 140 of file blogcomment.cpp.

void KBlog::BlogComment::setTitle ( const QString &  title  ) 

Sets the title.

Parameters:
title This is the title.
See also:
title()

Definition at line 61 of file blogcomment.cpp.

void KBlog::BlogComment::setUrl ( const KUrl &  url  ) 

Sets the commentator's homepage URL.

Parameters:
url The commentator's homepage url.
See also:
url()

Definition at line 110 of file blogcomment.cpp.

BlogComment::Status KBlog::BlogComment::status (  )  const

Returns the status on the server.

Returns:
The status.
See also:
setStatus( Status ), Status

Definition at line 135 of file blogcomment.cpp.

void KBlog::BlogComment::swap ( BlogComment &  other  )  [inline]

The swap operator.

Definition at line 258 of file blogcomment.h.

QString KBlog::BlogComment::title (  )  const

Returns the title.

Returns:
The title.
See also:
setTitle( const QString& )

Definition at line 56 of file blogcomment.cpp.

KUrl KBlog::BlogComment::url (  )  const

Returns the commentator's homepage URL.

Returns:
The url of the commentator's homepage
See also:
setUrl( const KUrl& )

Definition at line 105 of file blogcomment.cpp.


The documentation for this class was generated from the following files:
  • blogcomment.h
  • blogcomment.cpp

KBlog Client Library

Skip menu "KBlog Client Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.2-20100208
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal