blog.h

Go to the documentation of this file.

/*
  This file is part of the kblog library.

  Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (c) 2006-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_BLOG_H
#define KBLOG_BLOG_H

#include <kblog/kblog_export.h>

#include <QtCore/QObject>

template <class T,class S> class QMap;

class KTimeZone;
class KUrl;

namespace KBlog {

class BlogPost;
class BlogComment;
class BlogMedia;
class BlogPrivate;

class KBLOG_EXPORT Blog : public QObject
{
  Q_OBJECT
  public:
    explicit Blog( const KUrl &server, QObject *parent = 0,
                   const QString &applicationName = QString(),
                   const QString &applicationVersion = QString() );

    virtual ~Blog();

    enum ErrorType {
      XmlRpc,
      Atom,
      ParsingError,
      AuthenticationError,
      NotSupported,
      Other
    };

    QString userAgent() const;

    void setUserAgent( const QString &applicationName,
                       const QString &applicationVersion );

    virtual QString interfaceName() const = 0;

    virtual void setBlogId( const QString &blogId );

    QString blogId() const;

    virtual void setPassword( const QString &password );

    QString password() const;

    virtual void setUsername( const QString &username );

    QString username() const;

    virtual void setUrl( const KUrl &url );

    KUrl url() const;

    virtual void setTimeZone( const KTimeZone &timeZone );

    KTimeZone timeZone();

    virtual void listRecentPosts( int number ) = 0;

    virtual void fetchPost( KBlog::BlogPost *post ) = 0;

    virtual void modifyPost( KBlog::BlogPost *post ) = 0;

    virtual void createPost( KBlog::BlogPost *post ) = 0;

    virtual void removePost( KBlog::BlogPost *post ) = 0;

  Q_SIGNALS:
    void listedRecentPosts(
        const QList<KBlog::BlogPost>& posts );

    void createdPost( KBlog::BlogPost *post );

    void fetchedPost( KBlog::BlogPost *post );

    void modifiedPost( KBlog::BlogPost *post );

    void removedPost( KBlog::BlogPost *post );

    void error( KBlog::Blog::ErrorType type, const QString &errorMessage );

    void errorPost( KBlog::Blog::ErrorType type,
                    const QString &errorMessage, KBlog::BlogPost *post );

    void errorMedia( KBlog::Blog::ErrorType type,
                     const QString &errorMessage, KBlog::BlogMedia *media );

    void errorComment( KBlog::Blog::ErrorType type,
                       const QString &errorMessage, KBlog::BlogPost *post,
                       KBlog::BlogComment *comment );

  protected:
    BlogPrivate *const d_ptr;

    Blog( const KUrl &server, BlogPrivate &dd, QObject *parent = 0,
          const QString &applicationName = QString(),
          const QString &applicationVersion = QString() );

  private:
    Q_DECLARE_PRIVATE( Blog )
};

} //namespace KBlog
#endif