GOImage

GOImage

Properties

guint height Read / Write
guint width Read / Write

Types and Values

Object Hierarchy

    GBoxed
    ╰── GOImageFormatInfo
    GObject
    ╰── GOImage
        ├── GOEmf
        ├── GOPixbuf
        ├── GOSpectre
        ╰── GOSvg

Description

Functions

go_image_differ ()

gboolean
go_image_differ (GOImage *first,
                 GOImage *second);

go_image_draw ()

void
go_image_draw (GOImage *image,
               cairo_t *cr);

go_image_format_info_get_type ()

GType
go_image_format_info_get_type (void);

go_image_format_to_mime ()

char *
go_image_format_to_mime (char const *format);

Parameters

format

a file extension string

 

Returns

corresponding mime type.


go_image_get_data ()

guint8 const	*
go_image_get_data (GOImage *image,
                   gsize *length);

go_image_get_default_dpi ()

void
go_image_get_default_dpi (double *dpi_x,
                          double *dpi_y);

go_image_get_format_from_name ()

GOImageFormat
go_image_get_format_from_name (char const *name);

Parameters

name

a string

 

Returns

corresponding GOImageFormat.


go_image_get_format_info ()

GOImageFormatInfo const *
go_image_get_format_info (GOImageFormat format);

Retrieves information associated to format .

Parameters

format

a GOImageFormat

 

Returns

a GOImageFormatInfo struct.


go_image_get_formats_with_pixbuf_saver ()

GSList *
go_image_get_formats_with_pixbuf_saver
                               (void);

Returns

a list of GOImageFormat that can be created from a pixbuf.

[element-type GOImageFormat][transfer container]


go_image_get_height ()

double
go_image_get_height (GOImage const *image);

go_image_get_info ()

GOImageFormatInfo const *
go_image_get_info (GOImage *image);

go_image_get_name ()

char const	*
go_image_get_name (GOImage const *image);

go_image_get_pixbuf ()

GdkPixbuf *
go_image_get_pixbuf (GOImage *image);

Builds a pixbuf from the image if not already done and returns it, adding a reference.

Parameters

image

GOImage

 

Returns

the pixbuf for image .

[transfer full]


go_image_get_scaled_pixbuf ()

GdkPixbuf *
go_image_get_scaled_pixbuf (GOImage *image,
                            int width,
                            int height);

Builds a scaled pixbuf from the image and returns it. The caller needs to unref it. The pixbuf is scaled so that its width and height are not larger than, respectively, width and height , and preserving the aspect ratio.

Parameters

image

GOImage

 

width

the new pixbuf width

 

height

the new pixbuf height

 

Returns

the scaled pixbuf for image .

[transfer full]


go_image_get_thumbnail ()

GdkPixbuf const *
go_image_get_thumbnail (GOImage *image);

Generates a thumbnail for image if not already done and returns it, adding a reference. The pixbuf is scaled so that its width and height are not larger than 64 pixels, and preserving the aspect ratio.

Parameters

image

GOImage

 

Returns

the thumbnail for image .

[transfer full]


go_image_get_width ()

double
go_image_get_width (GOImage const *image);

go_image_load_attrs ()

void
go_image_load_attrs (GOImage *image,
                     GsfXMLIn *xin,
                     xmlChar const **attrs);

go_image_load_data ()

void
go_image_load_data (GOImage *image,
                    GsfXMLIn *xin);

go_image_new_for_format ()

GOImage *
go_image_new_for_format (char const *format);

go_image_new_from_data ()

GOImage *
go_image_new_from_data (char const *type,
                        guint8 const *data,
                        gsize length,
                        char **format,
                        GError **error);

go_image_new_from_file ()

GOImage *
go_image_new_from_file (char const *filename,
                        GError **error);

go_image_save ()

void
go_image_save (GOImage *image,
               GsfXMLOut *output);

go_image_set_default_dpi ()

void
go_image_set_default_dpi (double dpi_x,
                          double dpi_y);

go_image_set_name ()

void
go_image_set_name (GOImage *image,
                   char const *name);

go_image_type_for_format ()

GType
go_image_type_for_format (char const *format);

go_mime_to_image_format ()

char *
go_mime_to_image_format (char const *mime_type);

Parameters

mime_type

a mime type string

 

Returns

file extension for the given mime type.

Types and Values

GOImage

typedef struct _GOImage GOImage;

GOImageClass

typedef struct {
	GObjectClass parent_klass;

	GdkPixbuf *(*get_pixbuf) (GOImage *image);
	GdkPixbuf *(*get_scaled_pixbuf) (GOImage *image, int width, int height);
	void (*save) (GOImage *image, GsfXMLOut *output);
	void (*load_attr) (GOImage *image, xmlChar const *attr_name, xmlChar const *attr_value);
	void (*load_data) (GOImage *image, GsfXMLIn *xin);
	void (*draw) (GOImage *image, cairo_t *cr);
	gboolean (*differ) (GOImage *first, GOImage *second);
} GOImageClass;

Members

GObjectClass parent_klass;

parent class.

 

get_pixbuf ()

gets a pixbuf with the same size as the image.

 

get_scaled_pixbuf ()

gets a scaled pixbuf respecting the original aspect ratio.

 

save ()

saves the image.

 

load_attr ()

loads the images properties.

 

load_data ()

loads the image data.

 

draw ()

draws the image.

 

differ ()

returns TRUE if the two images are different.

 

enum GOImageFormat

Members

GO_IMAGE_FORMAT_SVG

SVG.

 

GO_IMAGE_FORMAT_PNG

PNG.

 

GO_IMAGE_FORMAT_JPG

JPEG.

 

GO_IMAGE_FORMAT_PDF

PDF.

 

GO_IMAGE_FORMAT_PS

PostScript.

 

GO_IMAGE_FORMAT_EMF

Enhanced Metafile.

 

GO_IMAGE_FORMAT_WMF

Windows Metafile.

 

GO_IMAGE_FORMAT_EPS

Encapsulated Postscript.

 

GO_IMAGE_FORMAT_UNKNOWN

unknown.

 

GOImageFormatInfo

typedef struct {
	GOImageFormat format;
	char *name;
	char *desc;
	char *ext;
	gboolean has_pixbuf_saver;
	gboolean is_dpi_useful;
	gboolean alpha_support;
} GOImageFormatInfo;

Members

GOImageFormat format;

GOImageFormat.

 

char *name;

image type name.

 

char *desc;

image type description.

 

char *ext;

file extension.

 

gboolean has_pixbuf_saver;

can be saved as pixbuf.

 

gboolean is_dpi_useful;

depends upon device resolution.

 

gboolean alpha_support;

supports transparency.

 

Property Details

The “height” property

  “height”                   guint

Image height in pixels.

Owner: GOImage

Flags: Read / Write

Allowed values: <= 65535

Default value: 0


The “width” property

  “width”                    guint

Image width in pixels.

Owner: GOImage

Flags: Read / Write

Allowed values: <= 65535

Default value: 0