summaryrefslogtreecommitdiffstats
path: root/lib/kross/api/exception.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
commit8362bf63dea22bbf6736609b0f49c152f975eb63 (patch)
tree0eea3928e39e50fae91d4e68b21b1e6cbae25604 /lib/kross/api/exception.h
downloadkoffice-8362bf63dea22bbf6736609b0f49c152f975eb63.tar.gz
koffice-8362bf63dea22bbf6736609b0f49c152f975eb63.zip
Added old abandoned KDE3 version of koffice
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1077364 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'lib/kross/api/exception.h')
-rw-r--r--lib/kross/api/exception.h102
1 files changed, 102 insertions, 0 deletions
diff --git a/lib/kross/api/exception.h b/lib/kross/api/exception.h
new file mode 100644
index 00000000..6ee9597b
--- /dev/null
+++ b/lib/kross/api/exception.h
@@ -0,0 +1,102 @@
+/***************************************************************************
+ * exception.h
+ * This file is part of the KDE project
+ * copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
+ *
+ * This program 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 program 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 program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ ***************************************************************************/
+
+#ifndef KROSS_API_EXCEPTION_H
+#define KROSS_API_EXCEPTION_H
+
+#include "object.h"
+
+#include <qstring.h>
+#include <ksharedptr.h>
+
+namespace Kross { namespace Api {
+
+ /**
+ * Common exception class used for representing exceptions
+ * in Kross.
+ *
+ * Internal we use \a Exception instances to throw and handle
+ * exceptions. Those exceptions are inherited from \a Object
+ * and therefore they are first class citizens in Kross.
+ */
+ class Exception : public Object
+ {
+ public:
+
+ /**
+ * Shared pointer to implement reference-counting.
+ */
+ typedef KSharedPtr<Exception> Ptr;
+
+ /**
+ * Constructor.
+ *
+ * \param error The error message.
+ * \param lineno The liner number in the scripting
+ * code where this exception got thrown.
+ */
+ Exception(const QString& error, long lineno = -1);
+
+ /**
+ * Destructor.
+ */
+ virtual ~Exception();
+
+ /// \see Kross::Api::Object::getClassName()
+ virtual const QString getClassName() const;
+
+ /// \see Kross::Api::Object::toString()
+ virtual const QString toString();
+
+ /**
+ * \return the error message.
+ */
+ const QString getError() const;
+
+ /**
+ * \return a more detailed tracemessage or QString::null if
+ * there is no trace avaiable.
+ */
+ const QString getTrace() const;
+
+ /**
+ * Set a more detailed tracemessage.
+ */
+ void setTrace(const QString& tracemessage);
+
+ /**
+ * \return the line number in the scripting code
+ * where the exception got thrown or -1 if there
+ * was no line number defined.
+ */
+ long getLineNo() const;
+
+ private:
+ /// The error message.
+ QString m_error;
+ /// The trace message.
+ QString m_trace;
+ /// The line number where the exception got thrown
+ long m_lineno;
+ };
+
+}}
+
+#endif
+