kresult.h

Go to the documentation of this file.

/*
  This file is part of KDE.

  Copyright (c) 2005 Cornelius Schumacher <schumacher@kde.org>

  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 KRESULT_H
#define KRESULT_H

#include <QtCore/QString>
#include "kcal_export.h"

namespace KCal {

class KCAL_DEPRECATED_EXPORT KResult
{
  public:
    enum Type {
      Ok,         
      InProgress, 
      Error       
    };

    enum ErrorType {
      NotAnError,         
      Undefined,          
      InvalidUrl,         
      WrongParameter,     
      ConnectionFailed,   
      WriteError,         
      ReadError,          
      ParseError,         
      WrongSchemaRevision 
    };

    KResult();

    KResult( const KResult & );

    explicit KResult( Type type );

    explicit KResult( ErrorType error, const QString &details = QString() );

    ~KResult();

    operator bool() const;

    bool isOk() const;

    bool isInProgress() const;

    bool isError() const;

    ErrorType error() const;

    QString message() const;

    void setDetails( const QString &details );

    QString details() const;

    QString fullMessage() const;

    KResult &chain( const KResult &result );

    bool hasChainedResult() const;

    KResult chainedResult() const;

    QString chainedMessage() const;

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

class KCAL_DEPRECATED_EXPORT KResultOk : public KResult
{
  public:
    KResultOk() : KResult( Ok ), d( 0 ) {}

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

class KCAL_DEPRECATED_EXPORT KResultInProgress : public KResult
{
  public:
    KResultInProgress() : KResult( InProgress ), d( 0 ) {}

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

class KCAL_DEPRECATED_EXPORT KResultError : public KResult
{
  public:
    KResultError() : KResult( Error ), d( 0 ) {}

    explicit KResultError( ErrorType error, const QString &details = QString() )
      : KResult( error, details ), d( 0 ) {}

    KResultError( const QString &details ) :
      KResult( Undefined, details ), d( 0 ) {}

  private:
    //@cond PRIVATE
    Q_DISABLE_COPY( KResultError )
    class Private;
    Private *const d;
    //@endcond PRIVATE
};

}

#endif