ThumbCreator Class Reference
from PyKDE4.kio import *
Detailed Description
- Abstract class:
- This class can be used as a base class for new classes, but can not be instantiated directly.
This is the baseclass for "thumbnail-plugins" in KDE. Using the class KIO.PreviewJob allows you to generate small images (thumbnails) for any kind of file, where a "ThumbCreator" is available. Have a look at kdebase/kioslave/thumbnail/ for existing ThumbCreators.
What you need to do to create and register a ThumbCreator:
extern "C" { KDE_EXPORT ThumbCreator *new_creator() { return new YourThumbCreator(); } };
Compile your ThumbCreator as a module. The contents of CMakeLists.txt should look something like this, with "filetype" replaced by the type of file this plugin creates thumbnails for:
project(filetypethumbcreator) find_package(KDE4 REQUIRED) include (KDE4Defaults) include(MacroOptionalAddSubdirectory) set(filetypethumbnail_SRCS filetypethumbnail.cpp) kde4_add_ui_files(filetypethumbnail_SRCS config.ui ) kde4_add_plugin(filetypethumbnail ${filetypethumbnail_SRCS}) target_link_libraries(filetypethumbnail ${KDE4_KIO_LIBS}) install(TARGETS filetypethumbnail DESTINATION ${PLUGIN_INSTALL_DIR}) install(FILES filetypethumbcreator.desktop DESTINATION ${SERVICES_INSTALL_DIR})
[Desktop Entry] Encoding=UTF-8 Type=Service Name=Name of the type of files your ThumbCreator supports ServiceTypes=ThumbCreator MimeType=application/x-somemimetype; CacheThumbnail=true X-KDE-Library=yourthumbcreator
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 (where you see [slash], put a /)
text[slash]* or image[slash]*.
If your plugin is rather inexpensive (e.g. like the text preview ThumbCreator), you can set CacheThumbnail=false to prevent your thumbnails from being cached on disk.
Baseclass for thumbnail-generating plugins.
Enumerations | |
Flags | { None, DrawFrame, BlendIcon } |
Methods | |
bool | create (self, QString path, int width, int height, QImage img) |
ThumbCreator.Flags | flags (self) |
Method Documentation
- Abstract method:
- This method is abstract and can be overridden but not called directly.
Creates a thumbnail Note that the width and height parameters should not be used for scaling. Only plugins that create an image "from scratch", like the TextCreator should directly use the specified size. If the resulting preview is larger than width x height, it will be scaled down.
- Parameters:
-
path the (always local) file path to create a preview for width maximum width for the preview height maximum height for the preview img this image will contain the preview on success
- Returns:
- true if preview generation succeeded
ThumbCreator.Flags flags | ( | self ) |
The flags of this plugin:
- Returns:
- flags for this plugin
Enumeration Documentation
Flags |
The flags of this plugin.
- See also:
- flags()
- Enumerator:
-
None = 0 DrawFrame = 1 BlendIcon = 2