summaryrefslogtreecommitdiffstats
path: root/kitchensync/libqopensync/result.h
blob: f35ed347a192ce858671b28f1b8d5d54c041849a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
    This file is part of libqopensync.

    Copyright (c) 2005 Tobias Koenig <tokoe@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 QSYNC_RESULT_H
#define QSYNC_RESULT_H

#include <tqstring.h>

struct OSyncError;

namespace QSync {

class Result
{
  public:
    /**
      Result types.
     */
    enum Type {
      NoError,
      GenericError,
      IOError,
      NotSupported,
      Timeout,
      Disconnected,
      FileNotFound,
      Exists,
      Convert,
      Misconfiguration,
      Initialization,
      Parameter,
      Expected,
      NoConnection,
      Temporary,
      Locked,
      PluginNotFound
    };

    /**
      Constructs a NoError result.
     */
    Result();

    /**
      Constructs a result of the given type.
     */
    Result( Type type );

    /**
      Construct Result from OpenSync error object. Deletes the OpenSync error
      object.
    */
    Result( OSyncError **, bool deleteError = true );

    /**
      Destroys the result.
     */
    ~Result();

    /**
      Sets the name of the result.
     */
    void setName( const TQString &name );

    /**
      Returns the name of the result.
     */
    TQString name() const;

    /**
      Sets the message text of the result.
     */
    void setMessage( const TQString &message );

    /**
      Returns the message text of the result.
     */
    TQString message() const;

    /**
      Sets the type of the result.
     */
    void setType( Type type );

    /**
      Returns the type of the result.
     */
    Type type() const;

    /**
      Reimplemented boolean operator.
     */
    operator bool () const;

    /**
      Return true, if this Result is an error, return false otherwise.
    */
    bool isError() const;

  private:
    TQString mName;
    TQString mMessage;
    Type mType;
};

}

#endif