blogpost.h

/*
  This file is part of the kblog library.

  Copyright (c) 2007 Christian Weilbach <christian_weilbach@web.de>
  Copyright (c) 2007 Mike McQuaid <mike@mikemcquaid.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef KBLOG_BLOGPOSTING_H
#define KBLOG_BLOGPOSTING_H

#include <kblog/kblog_export.h>

#include <kurl.h>

#include <QtCore/QtAlgorithms>

class QStringList;

class KDateTime;
class KUrl;

namespace KCal {
  class Journal;
}

namespace KBlog {
  class Blog;
  class BlogPostPrivate;

class KBLOG_EXPORT BlogPost
{

public:

    BlogPost( const KBlog::BlogPost &post );

    explicit BlogPost( const QString &postId = QString() );

    explicit BlogPost( const KCal::Journal &journal );

    virtual ~BlogPost();

    KCal::Journal *journal( const Blog &blog ) const;

    QString journalId() const;

    bool isPrivate() const;

    void setPrivate( bool privatePost );

    QString postId() const;

    void setPostId( const QString &postId );

    QString title() const;

    void setTitle( const QString &title );

    QString content() const;

    void setContent( const QString &content );

//     QString abbreviatedContent() const; // TODO check if necessary
//     void setAbbreviatedContent( const QString &abbreviatedContent );

    QString additionalContent() const;

    void setAdditionalContent( const QString &additionalContent );

    QString slug() const;

    void setSlug( const QString &slug );
    KUrl link() const;

    void setLink( const KUrl &link ) const;

    KUrl permaLink() const;

    void setPermaLink( const KUrl &permalink ) const;

    bool isCommentAllowed() const;

    void setCommentAllowed( bool commentAllowed );

    bool isTrackBackAllowed() const; // pings in Movable Type

    void setTrackBackAllowed ( bool allowTrackBacks );

    QString summary() const; // excerpts in Movable Type

    void setSummary( const QString &summary );

    QStringList tags() const; // keywords in Movable Type

    void setTags( const QStringList &tags );

//     QList<KUrl> trackBackUrls() const; // TODO check if necessary
//     void setTrackBackUrls( const QList<KUrl> &trackBackUrls );

    QString mood() const;

    void setMood( const QString &mood );

    QString music() const;

    void setMusic( const QString &music );

    QStringList categories() const;

    void setCategories( const QStringList &categories );

    KDateTime creationDateTime() const;

    void setCreationDateTime( const KDateTime &datetime );

    KDateTime modificationDateTime() const;

    void setModificationDateTime( const KDateTime &datetime );

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

    Status status() const;

    void setStatus( Status status );

    QString error() const;

    void setError( const QString &error );

    BlogPost &operator=( const BlogPost &post );

    void swap( BlogPost &other ) {
        qSwap( this->d_ptr, other.d_ptr );
    }

  private:
    BlogPostPrivate *d_ptr;  //krazy:exclude=dpointer can't constify due to bic and swap being declared inline
};

} //namespace KBlog

#endif