MateThumbnail

MateThumbnail

Synopsis

#include <libmateui/libmateui.h>

struct              MateThumbnailFactory;
enum                MateThumbnailSize;
struct              MateThumbnailFactoryClass;
MateThumbnailFactory * mate_thumbnail_factory_new     (MateThumbnailSize size);
char *                  mate_thumbnail_factory_lookup  (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);
gboolean            mate_thumbnail_factory_has_valid_failed_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);
gboolean            mate_thumbnail_factory_can_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         const char *mime_type,
                                                         time_t mtime);
GdkPixbuf *             mate_thumbnail_factory_generate_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         const char *mime_type);
void                mate_thumbnail_factory_save_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         GdkPixbuf *thumbnail,
                                                         const char *uri,
                                                         time_t original_mtime);
void                mate_thumbnail_factory_create_failed_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);
GdkPixbuf *         mate_thumbnail_scale_down_pixbuf   (GdkPixbuf *pixbuf,
                                                         int dest_width,
                                                         int dest_height);
gboolean            mate_thumbnail_has_uri             (GdkPixbuf *pixbuf,
                                                         const char *uri);
gboolean            mate_thumbnail_is_valid            (GdkPixbuf *pixbuf,
                                                         const char *uri,
                                                         time_t mtime);
char *              mate_thumbnail_md5                 (const char *uri);
char *              mate_thumbnail_path_for_uri        (const char *uri,
                                                         MateThumbnailSize size);

Description

Details

struct MateThumbnailFactory

struct MateThumbnailFactory {
	GObject parent;
	
	MateThumbnailFactoryPrivate *priv;
};


enum MateThumbnailSize

typedef enum {
  MATE_THUMBNAIL_SIZE_NORMAL,
  MATE_THUMBNAIL_SIZE_LARGE
} MateThumbnailSize;


struct MateThumbnailFactoryClass

struct MateThumbnailFactoryClass {
	GObjectClass parent;
};


mate_thumbnail_factory_new ()

MateThumbnailFactory * mate_thumbnail_factory_new     (MateThumbnailSize size);

Creates a new MateThumbnailFactory.

This function must be called on the main thread.

size :

The thumbnail size to use

Returns :

a new MateThumbnailFactory

Since 2.2


mate_thumbnail_factory_lookup ()

char *                  mate_thumbnail_factory_lookup  (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);

Tries to locate an existing thumbnail for the file specified.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

uri :

the uri of a file

mtime :

the mtime of the file

Returns :

The absolute path of the thumbnail, or NULL if none exist.

Since 2.2


mate_thumbnail_factory_has_valid_failed_thumbnail ()

gboolean            mate_thumbnail_factory_has_valid_failed_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);

Tries to locate an failed thumbnail for the file specified. Writing and looking for failed thumbnails is important to avoid to try to thumbnail e.g. broken images several times.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

uri :

the uri of a file

mtime :

the mtime of the file

Returns :

TRUE if there is a failed thumbnail for the file.

Since 2.2


mate_thumbnail_factory_can_thumbnail ()

gboolean            mate_thumbnail_factory_can_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         const char *mime_type,
                                                         time_t mtime);

Returns TRUE if this MateIconFactory can (at least try) to thumbnail this file. Thumbnails or files with failed thumbnails won't be thumbnailed.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

uri :

the uri of a file

mime_type :

the mime type of the file

mtime :

the mtime of the file

Returns :

TRUE if the file can be thumbnailed.

Since 2.2


mate_thumbnail_factory_generate_thumbnail ()

GdkPixbuf *             mate_thumbnail_factory_generate_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         const char *mime_type);

Tries to generate a thumbnail for the specified file. If it succeeds it returns a pixbuf that can be used as a thumbnail.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

uri :

the uri of a file

mime_type :

the mime type of the file

Returns :

thumbnail pixbuf if thumbnailing succeeded, NULL otherwise.

Since 2.2


mate_thumbnail_factory_save_thumbnail ()

void                mate_thumbnail_factory_save_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         GdkPixbuf *thumbnail,
                                                         const char *uri,
                                                         time_t original_mtime);

Saves thumbnail at the right place. If the save fails a failed thumbnail is written.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

thumbnail :

the thumbnail as a pixbuf

uri :

the uri of a file

original_mtime :

the modification time of the original file

Since 2.2


mate_thumbnail_factory_create_failed_thumbnail ()

void                mate_thumbnail_factory_create_failed_thumbnail
                                                        (MateThumbnailFactory *factory,
                                                         const char *uri,
                                                         time_t mtime);

Creates a failed thumbnail for the file so that we don't try to re-thumbnail the file later.

Usage of this function is threadsafe.

factory :

a MateThumbnailFactory

uri :

the uri of a file

mtime :

the modification time of the file

Since 2.2


mate_thumbnail_scale_down_pixbuf ()

GdkPixbuf *         mate_thumbnail_scale_down_pixbuf   (GdkPixbuf *pixbuf,
                                                         int dest_width,
                                                         int dest_height);

Scales the pixbuf to the desired size. This function is a lot faster than gdk-pixbuf when scaling down by large amounts.

pixbuf :

a GdkPixbuf

dest_width :

the desired new width

dest_height :

the desired new height

Returns :

a scaled pixbuf

Since 2.2


mate_thumbnail_has_uri ()

gboolean            mate_thumbnail_has_uri             (GdkPixbuf *pixbuf,
                                                         const char *uri);

Returns whether the thumbnail has the correct uri embedded in the Thumb::URI option in the png.

pixbuf :

an loaded thumbnail pixbuf

uri :

a uri

Returns :

TRUE if the thumbnail is for uri

Since 2.2


mate_thumbnail_is_valid ()

gboolean            mate_thumbnail_is_valid            (GdkPixbuf *pixbuf,
                                                         const char *uri,
                                                         time_t mtime);

Returns whether the thumbnail has the correct uri and mtime embedded in the png options.

pixbuf :

an loaded thumbnail GdkPixbuf

uri :

a uri

mtime :

the mtime

Returns :

TRUE if the thumbnail has the right uri and mtime

Since 2.2


mate_thumbnail_md5 ()

char *              mate_thumbnail_md5                 (const char *uri);

Calculates the MD5 checksum of the uri. This can be useful if you want to manually handle thumbnail files.

uri :

an uri

Returns :

A string with the MD5 digest of the uri string.

Since 2.2


mate_thumbnail_path_for_uri ()

char *              mate_thumbnail_path_for_uri        (const char *uri,
                                                         MateThumbnailSize size);

Returns the filename that a thumbnail of size size for uri would have.

uri :

an uri

size :

a thumbnail size

Returns :

an absolute filename

Since 2.2