kopete/libkopete/kopetemimetypehandler.h

   1 /*
   2     kopetemimetypehandler.h - Kopete Mime-type Handlers
   3
   4     Copyright (c) 2004      by Richard Smith         <kde@metafoo.co.uk>
   5
   6     Kopete    (c) 2004      by the Kopete developers <kopete-devel@kde.org>
   7
   8     *************************************************************************
   9     *                                                                       *
  10     * This library is free software; you can redistribute it and/or         *
  11     * modify it under the terms of the GNU Lesser General Public            *
  12     * License as published by the Free Software Foundation; either          *
  13     * version 2 of the License, or (at your option) any later version.      *
  14     *                                                                       *
  15     *************************************************************************
  16 */
  17
  18 #ifndef KOPETEMIMETYPEHANDLER_H
  19 #define KOPETEMIMETYPEHANDLER_H
  20
  21 #include <kurl.h>
  22
  23 class QString;
  24 class QStringList;
  25
  26 #include "kopete_export.h"
  27
  28 namespace Kopete
  29 {
  30
  31 /**
  32  * @brief A handler for some set of mime-types
  33  * A mime type handler is responsible for handling requests to open files of
  34  * certain mime types presented to the main application.
  35  */
  36 class KOPETE_EXPORT MimeTypeHandler
  37 {
  38 protected:
  39         MimeTypeHandler( bool canAcceptRemoteFiles = false );
  40 public:
  41         virtual ~MimeTypeHandler();
  42
  43         /**
  44          * Finds a MimeTypeHandler for a given URL, and tells that handler to handle it
  45          *
  46          * @param url the url to dispatch
  47          *
  48          * @return true if a handler was registered for the mime type, false otherwise
  49          */
  50         static bool dispatchURL( const KUrl &url );
  51
  52         /**
  53          * Returns a list of mime types this object is registered to handle
  54          */
  55         const QStringList mimeTypes() const;
  56
  57         /**
  58          * Returns a list of protocols this object is registered to handle
  59          */
  60         const QStringList protocols() const;
  61
  62         /**
  63          * Returns true if this handler can accept remote files direcltly;
  64          * If false, remote files are downloaded via KIO::NetAccess before
  65          * being passed to handleURL
  66          */
  67         bool canAcceptRemoteFiles() const;
  68
  69         /**
  70          * Handles the URL @p url
  71          *
  72          * @param url The url to handle
  73          */
  74         virtual void handleURL( const KUrl &url ) const;
  75
  76         /**
  77          * Handles the URL @p url, which has the mime type @p mimeType
  78          *
  79          * @param mimeType The mime type of the URL
  80          * @param url The url to handle
  81          */
  82         virtual void handleURL( const QString &mimeType, const KUrl &url ) const;
  83
  84 protected:
  85         /**
  86          * Register this object as the handler of type @p mimeType.
  87          * @param mimeType the mime type to handle
  88          * @return true if registration succeeded, false if another handler is
  89          *         already set for this mime type.
  90          */
  91         bool registerAsMimeHandler( const QString &mimeType );
  92
  93         /**
  94          * Register this object as the handler of type @p protocol.
  95          * @param protocol the protocol to handle
  96          * @return true if registration succeeded, false if another handler is
  97          *         already set for this protocol.
  98          */
  99         bool registerAsProtocolHandler( const QString &protocol );
 100
 101 private:
 102         /**
 103          * Helper function.
 104          * Attempts to dispatch a given URL to a given handler
 105          *
 106          * @param url The url to dispatch
 107          * @param mimeType The mime type of the url
 108          * @param handler The handler to attempt
 109          *
 110          * @return true if a handler was able to process the URL, false otherwise
 111          */
 112         static bool dispatchToHandler( const KUrl &url, const QString &mimeType, MimeTypeHandler *handler );
 113
 114         class Private;
 115         Private *d;
 116 };
 117
 118 /**
 119  * Mime-type handler class for Kopete emoticon files
 120  */
 121 class KOPETE_EXPORT EmoticonMimeTypeHandler : public MimeTypeHandler
 122 {
 123 public:
 124         EmoticonMimeTypeHandler();
 125
 126         const QStringList mimeTypes() const;
 127
 128         void handleURL( const QString &mimeType, const KUrl &url ) const;
 129 };
 130
 131 } // Kopete
 132
 133 #endif
 134 // vim: set noet ts=4 sts=4 sw=4: