summaryrefslogtreecommitdiffstats
path: root/kopete/libkopete/kopetemimetypehandler.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitbcb704366cb5e333a626c18c308c7e0448a8e69f (patch)
treef0d6ab7d78ecdd9207cf46536376b44b91a1ca71 /kopete/libkopete/kopetemimetypehandler.h
downloadtdenetwork-bcb704366cb5e333a626c18c308c7e0448a8e69f.tar.gz
tdenetwork-bcb704366cb5e333a626c18c308c7e0448a8e69f.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdenetwork@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kopete/libkopete/kopetemimetypehandler.h')
-rw-r--r--kopete/libkopete/kopetemimetypehandler.h133
1 files changed, 133 insertions, 0 deletions
diff --git a/kopete/libkopete/kopetemimetypehandler.h b/kopete/libkopete/kopetemimetypehandler.h
new file mode 100644
index 00000000..8f3235f0
--- /dev/null
+++ b/kopete/libkopete/kopetemimetypehandler.h
@@ -0,0 +1,133 @@
+/*
+ kopetemimetypehandler.h - Kopete Mime-type Handlers
+
+ Copyright (c) 2004 by Richard Smith <kde@metafoo.co.uk>
+
+ Kopete (c) 2004 by the Kopete developers <kopete-devel@kde.org>
+
+ *************************************************************************
+ * *
+ * This library is free software; you can redistribute it and/or *
+ * modify it under the terms of the GNU Lesser General Public *
+ * License as published by the Free Software Foundation; either *
+ * version 2 of the License, or (at your option) any later version. *
+ * *
+ *************************************************************************
+*/
+
+#ifndef KOPETEMIMETYPEHANDLER_H
+#define KOPETEMIMETYPEHANDLER_H
+
+class KURL;
+class QString;
+class QStringList;
+
+#include "kopete_export.h"
+
+namespace Kopete
+{
+
+/**
+ * @brief A handler for some set of mime-types
+ * A mime type handler is responsible for handling requests to open files of
+ * certain mime types presented to the main application.
+ */
+class KOPETE_EXPORT MimeTypeHandler
+{
+protected:
+ MimeTypeHandler( bool canAcceptRemoteFiles = false );
+public:
+ virtual ~MimeTypeHandler();
+
+ /**
+ * Finds a MimeTypeHandler for a given URL, and tells that handler to handle it
+ *
+ * @param url the url to dispatch
+ *
+ * @return true if a handler was registered for the mime type, false otherwise
+ */
+ static bool dispatchURL( const KURL &url );
+
+ /**
+ * Returns a list of mime types this object is registered to handle
+ */
+ const QStringList mimeTypes() const;
+
+ /**
+ * Returns a list of protocols this object is registered to handle
+ */
+ const QStringList protocols() const;
+
+ /**
+ * Returns true if this handler can accept remote files direcltly;
+ * If false, remote files are downloaded via KIO::NetAccess before
+ * being passed to handleURL
+ */
+ bool canAcceptRemoteFiles() const;
+
+ /**
+ * Handles the URL @p url
+ *
+ * @param url The url to handle
+ */
+ virtual void handleURL( const KURL &url ) const;
+
+ /**
+ * Handles the URL @p url, which has the mime type @p mimeType
+ *
+ * @param mimeType The mime type of the URL
+ * @param url The url to handle
+ */
+ virtual void handleURL( const QString &mimeType, const KURL &url ) const;
+
+protected:
+ /**
+ * Register this object as the handler of type @p mimeType.
+ * @param mimeType the mime type to handle
+ * @return true if registration succeeded, false if another handler is
+ * already set for this mime type.
+ */
+ bool registerAsMimeHandler( const QString &mimeType );
+
+ /**
+ * Register this object as the handler of type @p protocol.
+ * @param protocol the protocol to handle
+ * @return true if registration succeeded, false if another handler is
+ * already set for this protocol.
+ */
+ bool registerAsProtocolHandler( const QString &protocol );
+
+private:
+ /**
+ * Helper function.
+ * Attempts to dispatch a given URL to a given handler
+ *
+ * @param url The url to dispatch
+ * @param mimeType The mime type of the url
+ * @param handler The handler to attempt
+ *
+ * @return true if a handler was able to process the URL, false otherwise
+ */
+ static bool dispatchToHandler( const KURL &url, const QString &mimeType, MimeTypeHandler *handler );
+
+ class Private;
+ Private *d;
+};
+
+/**
+ * Mime-type handler class for Kopete emoticon files
+ */
+class KOPETE_EXPORT EmoticonMimeTypeHandler : public MimeTypeHandler
+{
+public:
+ EmoticonMimeTypeHandler();
+
+ const QStringList mimeTypes() const;
+
+ void handleURL( const QString &mimeType, const KURL &url ) const;
+};
+
+} // Kopete
+
+#endif
+// vim: set noet ts=4 sts=4 sw=4: