#include <thumbcreator.h>
Public Types | |
enum | Flags { None = 0 , DrawFrame = 1 , BlendIcon = 2 } |
Public Member Functions | |
virtual bool | create (const TQString &path, int width, int height, TQImage &img)=0 |
virtual Flags | flags () const |
Detailed Description
This is the baseclass for "thumbnail-plugins" in KDE.
Using the class TDEIO::PreviewJob allows you to generate small images (thumbnails) for any kind of file, where a "ThumbCreator" is available. Have a look at tdebase/tdeioslave/thumbnail/ for existing ThumbCreators.
What you need to do to create and register a ThumbCreator:
- Inherit from this class and reimplement the create() method to generate a thumbnail for the given file-path.
- Provide a factory method in your implementation file to instantiate your plugin, e.g.:
Compile your ThumbCreator as a module. The contents of Makefile.am need to look like this:
- Create a file yourthumbcreator.desktop with the following contents: [Desktop Entry]Encoding=UTF-8Type=ServiceName=Name of the type of files your ThumbCreator supportsServiceTypes=ThumbCreatorMimeTypes=application/x-somemimetypeCacheThumbnail=trueX-TDE-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 /)
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.
Definition at line 84 of file thumbcreator.h.
Member Enumeration Documentation
◆ Flags
enum ThumbCreator::Flags |
Member Function Documentation
◆ create()
|
pure virtual |
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
◆ flags()
|
inlinevirtual |
The flags of this plugin:
- None nothing special
- DrawFrame a frame should be painted around the preview
- BlendIcon the mimetype icon should be blended over the preview
- Returns
- flags for this plugin
Definition at line 119 of file thumbcreator.h.
The documentation for this class was generated from the following file: