Gdk::PixbufFormat Class Reference

List of all members.

Public Member Functions

 PixbufFormat ()
 PixbufFormat (const GdkPixbufFormat* gobject)
virtual ~PixbufFormat ()
 PixbufFormat (const PixbufFormat& src)
PixbufFormatoperator= (const PixbufFormat& src)
Glib::ustring get_name () const
 Return value: the name of the format.
Glib::ustring get_description () const
 Return value: a description of the format.
Glib::StringArrayHandle get_mime_types () const
 Return value: a 0-terminated array of mime types which must be freed with.
Glib::StringArrayHandle get_extensions () const
 Return value: a 0-terminated array of filename extensions which must be.
bool is_writable () const
 Return value: whether pixbufs can be saved in the given format.
bool is_scalable () const
 Return value: whether this image format is scalable.
bool is_disabled () const
 Return value: whether this image format is disabled.
void set_disabled (bool disabled=true)
 Disables or enables an image format.
Glib::ustring get_license () const
 Returns: a string describing the license of format.
GdkPixbufFormat* gobj ()
 Provides access to the underlying C GObject.
const GdkPixbufFormat* gobj () const
 Provides access to the underlying C GObject.

Protected Attributes

const GdkPixbufFormat* gobject_

Constructor & Destructor Documentation

Gdk::PixbufFormat::PixbufFormat (  ) 
Gdk::PixbufFormat::PixbufFormat ( const GdkPixbufFormat *  gobject  )  [explicit]
virtual Gdk::PixbufFormat::~PixbufFormat (  )  [virtual]
Gdk::PixbufFormat::PixbufFormat ( const PixbufFormat src  ) 

Member Function Documentation

Glib::ustring Gdk::PixbufFormat::get_description (  )  const

Return value: a description of the format.

Returns:
A description of the format.
Since gtkmm 2.2:
Glib::StringArrayHandle Gdk::PixbufFormat::get_extensions (  )  const

Return value: a 0-terminated array of filename extensions which must be.

Returns:
A 0-terminated array of filename extensions which must be freed with Glib::strfreev() when it is no longer needed.
Since gtkmm 2.2:
Glib::ustring Gdk::PixbufFormat::get_license (  )  const

Returns: a string describing the license of format.

Returns:
A string describing the license of format.
Since gtkmm 2.6:
Glib::StringArrayHandle Gdk::PixbufFormat::get_mime_types (  )  const

Return value: a 0-terminated array of mime types which must be freed with.

Returns:
A 0-terminated array of mime types which must be freed with Glib::strfreev() when it is no longer needed.
Since gtkmm 2.2:
Glib::ustring Gdk::PixbufFormat::get_name (  )  const

Return value: the name of the format.

Returns:
The name of the format.
Since gtkmm 2.2:
const GdkPixbufFormat* Gdk::PixbufFormat::gobj (  )  const [inline]

Provides access to the underlying C GObject.

GdkPixbufFormat* Gdk::PixbufFormat::gobj (  )  [inline]

Provides access to the underlying C GObject.

bool Gdk::PixbufFormat::is_disabled (  )  const

Return value: whether this image format is disabled.

Returns:
Whether this image format is disabled.
Since gtkmm 2.6:
bool Gdk::PixbufFormat::is_scalable (  )  const

Return value: whether this image format is scalable.

Returns:
Whether this image format is scalable.
Since gtkmm 2.6:
bool Gdk::PixbufFormat::is_writable (  )  const

Return value: whether pixbufs can be saved in the given format.

Returns:
Whether pixbufs can be saved in the given format.
Since gtkmm 2.2:
PixbufFormat& Gdk::PixbufFormat::operator= ( const PixbufFormat src  ) 
void Gdk::PixbufFormat::set_disabled ( bool  disabled = true  ) 

Disables or enables an image format.

If a format is disabled, gdk-pixbuf won't use the image loader for this format to load images. Applications can use this to avoid using image loaders with an inappropriate license, see format_get_license().

Since gtkmm 2.6:
Parameters:
disabled true to disable the format format.

Member Data Documentation

const GdkPixbufFormat* Gdk::PixbufFormat::gobject_ [protected]

The documentation for this class was generated from the following file:

Generated on Mon Jan 4 14:29:31 2010 for gtkmm by  doxygen 1.6.1