/usr/include/KF5/KIOWidgets/kio/thumbcreator.h is in kio-dev 5.18.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | /* This file is part of the KDE libraries
Copyright (C) 2000 Malte Starostik <malte@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 _THUMBCREATOR_H_
#define _THUMBCREATOR_H_
#include "kiowidgets_export.h"
class QString;
class QImage;
class QWidget;
/**
* Base class for thumbnail generator plugins.
*
* KIO::PreviewJob, via the "thumbnail" kioslave, uses instances of this class
* to generate the thumbnail previews.
*
* To add support for a new document type, subclass ThumbCreator and implement
* create() to generate a thumbnail for a given path. Then create a factory
* method called "new_creator" to return instances of your subclass:
* \code
* extern "C"
* {
* Q_DECL_EXPORT ThumbCreator *new_creator()
* {
* return new FooThumbCreator();
* }
* };
* \endcode
*
* Compile your ThumbCreator as a module; for example, the relevant CMake code
* for a thumbnailer for the "foo" filetype might look like
* \code
* set(foothumbnail_SRCS foothumbnail.cpp)
* add_library(foothumbnail MODULE ${foothumbnail_SRCS})
* target_link_libraries(foothumbnail PRIVATE KF5::KIOWidgets)
*
* install(TARGETS foothumbnail DESTINATION ${PLUGIN_INSTALL_DIR})
* \endcode
*
* You also need to create a desktop file describing the thumbnailer. For
* example:
* \code
* [Desktop Entry]
* Encoding=UTF-8
* Type=Service
* Name=Foo Documents
* ServiceTypes=ThumbCreator
* MimeType=application/x-foo;
* CacheThumbnail=true
* X-KDE-Library=foothumbcreator
* \endcode
*
* Of course, you will need to install it:
* \code
* install(FILES foothumbcreator.desktop DESTINATION ${SERVICES_INSTALL_DIR})
* \endcode
*
* Note that you can supply a comma-separated list of mimetypes to the MimeTypes
* entry, naming all mimetypes your ThumbCreator supports. You can also use
* simple wildcards, like
* \htmlonly "text/*".\endhtmlonly\latexonly text/$\ast$.\endlatexonly
*
* If the thumbnail creation is cheap (such as text previews), you can set
* \code
* CacheThumbnail=false
* \endcode
* in the desktop file to prevent your thumbnails from being cached on disk.
*
* You can also use the "ThumbnailerVersion" optional property in the .desktop
* file, like
* \code
* ThumbnailerVersion=5
* \endcode
* When this is incremented (or defined when it previously was not), all the
* previously-cached thumbnails for this creator will be discarded. You should
* increase the version if and only if old thumbnails need to be regenerated.
*/
// KF6 TODO: put this in the KIO namespace
class KIOWIDGETS_EXPORT ThumbCreator
{
public:
/**
* Flags to provide hints to the user of this plugin.
* @see flags()
*/
enum Flags {
None = 0, /**< No hints. */
DrawFrame = 1, /**< A frame should be painted around the preview. */
BlendIcon = 2 /**< The mimetype icon should be blended over the preview. */
};
/**
* Destructor.
*/
virtual ~ThumbCreator();
/**
* Creates a thumbnail.
*
* Note that this method should not do any scaling. The @p width and @p
* height parameters are provided as hints for images that are generated
* from non-image data (like text).
*
* @param path The path of the file to create a preview for. This is
* always a local path.
* @param width The requested preview width (see the note on scaling
* above).
* @param height The requested preview height (see the note on scaling
* above).
* @param img The QImage to store the preview in.
*
* @return @c true if a preview was successfully generated and store in @p
* img, @c false otherwise.
*/
virtual bool create(const QString &path, int width, int height, QImage &img) = 0; // KF6 TODO: turn first arg into QUrl (see thumbnail/htmlcreator.cpp)
/**
* Returns the flags for this plugin.
*
* @return XOR'd flags values.
* @see Flags
*/
virtual Flags flags() const;
/**
* Create a widget for configuring the thumb creator.
*
* The caller will take ownership of the returned instance and must ensure
* its deletion.
*
* The default implementation returns 0.
*
* The following key in the thumbcreator .desktop file must be set to
* mark the plugin as configurable:
* \code
* Configurable=true
* \endcode
*
* @return A QWidget instance, which the caller takes ownership of, or 0.
*/
virtual QWidget *createConfigurationWidget();
/**
* Write the updated configuration.
*
* @param configurationWidget An object returned by
* createConfigurationWidget().
*/
virtual void writeConfiguration(const QWidget *configurationWidget);
};
/**
* @since 4.7
* @deprecated since 5.0, use ThumbCreator
*/
class KIOWIDGETS_DEPRECATED_EXPORT ThumbCreatorV2 : public ThumbCreator
{
public:
virtual ~ThumbCreatorV2();
};
// KF6 TODO: rename this to something less generic
typedef ThumbCreator *(*newCreator)();
#endif
|