|
| PixbufLoader (PixbufLoader && src) noexcept |
|
PixbufLoader & | operator= (PixbufLoader && src) noexcept |
|
| ~PixbufLoader () noexcept override |
|
GdkPixbufLoader * | gobj () |
| Provides access to the underlying C GObject.
|
|
const GdkPixbufLoader * | gobj () const |
| Provides access to the underlying C GObject.
|
|
GdkPixbufLoader * | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
|
void | set_size (int width, int height) |
| Causes the image to be scaled while it is loaded.
|
|
void | write (const guint8 * buf, gsize count) |
| Causes the pixbuf loader to parse the next count bytes of an image.
|
|
void | close () |
| Informs a pixbuf loader that no further writes with PixbufLoader::write() will occur, so that it can free its internal loading structures.
|
|
Glib::RefPtr< Gdk::Pixbuf > | get_pixbuf () |
| Queries the Gdk::Pixbuf that a pixbuf loader is currently creating.
|
|
Glib::RefPtr< Gdk::PixbufAnimation > | get_animation () |
| Queries the Gdk::PixbufAnimation that a pixbuf loader is currently creating.
|
|
PixbufFormat | get_format () const |
| Obtains the available information about the format of the currently loading image file.
|
|
Glib::SignalProxy< void > | signal_area_prepared () |
| This signal is emitted when the pixbuf loader has allocated the pixbuf in the desired size.
|
|
Glib::SignalProxy< void, int, int, int, int > | signal_area_updated () |
| This signal is emitted when a significant area of the image being loaded has been updated.
|
|
Glib::SignalProxy< void > | signal_closed () |
| This signal is emitted when close() is called.
|
|
Glib::SignalProxy< void, int, int > | signal_size_prepared () |
| This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create.
|
|
Gdk::PixbufLoader::PixbufLoader |
( |
const Glib::ustring & | image_type, |
|
|
bool | mime_type = false ) |
|
explicitprotected |
Constructs a pixbuf loader object for a specific image type.
Constructs a new pixbuf loader object that always attempts to parse image data as if it were an image of type image_type, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type.
The image_type can be one of the types returned by Gdk::Pixbuf::get_formats(), or a MIME type.
Common MIME Types are listed here http://www.iana.org/assignments/media-types/ and here: http://www.freedesktop.org/Software/shared-mime-info
The list of non-mime-type image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call PixbufFormat::get_name() on each of the PixbufFormats returned by Gdk::Pixbuf::get_formats().
- Parameters
-
image_type | Name of the image format to be loaded with the image. |
mime_type | If this is true then the image_type is a MIME type. |
- Exceptions
-
void Gdk::PixbufLoader::close |
( |
| ) |
|
Informs a pixbuf loader that no further writes with PixbufLoader::write() will occur, so that it can free its internal loading structures.
Also, tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, an exception will be thrown. If you're just cancelling a load rather than expecting it to be finished, writing an empty catch()
block to ignore errors is reasonable.
- Exceptions
-
static Glib::RefPtr< PixbufLoader > Gdk::PixbufLoader::create |
( |
const Glib::ustring & | image_type, |
|
|
bool | mime_type = false ) |
|
static |
Constructs a pixbuf loader object for a specific image type.
Constructs a new pixbuf loader object that always attempts to parse image data as if it were an image of type image_type, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type.
The image_type can be one of the types returned by Gdk::Pixbuf::get_formats(), or a MIME type.
Common MIME Types are listed here http://www.iana.org/assignments/media-types/ and here: http://www.freedesktop.org/Software/shared-mime-info
The list of non-mime-type image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call PixbufFormat::get_name() on each of the PixbufFormats returned by Gdk::Pixbuf::get_formats().
- Parameters
-
image_type | Name of the image format to be loaded with the image. |
mime_type | If this is true then the image_type is a MIME type. |
- Exceptions
-
Glib::SignalProxy< void > Gdk::PixbufLoader::signal_area_prepared |
( |
| ) |
|
This signal is emitted when the pixbuf loader has allocated the pixbuf in the desired size.
After this signal is emitted, applications can call get_pixbuf() to fetch the partially-loaded pixbuf.
- Slot Prototype:
void on_my_area_prepared()
Flags: Run Last
This signal is emitted when the pixbuf loader has allocated the pixbuf in the desired size. After this signal is emitted, applications can call Gdk::PixbufLoader::get_pixbuf() to fetch the partially-loaded pixbuf.
Glib::SignalProxy< void, int, int, int, int > Gdk::PixbufLoader::signal_area_updated |
( |
| ) |
|
This signal is emitted when a significant area of the image being loaded has been updated.
Normally it means that a complete scanline has been read in, but it could be a different area as well. Applications can use this signal to know when to repaint areas of an image that is being loaded.
- Parameters
-
X | offset of upper-left corner of the updated area. |
y | Y offset of upper-left corner of the updated area. |
width | Width of updated area. |
height | Height of updated area. |
- Slot Prototype:
void on_my_area_updated(int x, int y, int width, int height)
Flags: Run Last
This signal is emitted when a significant area of the image being loaded has been updated. Normally it means that a complete scanline has been read in, but it could be a different area as well. Applications can use this signal to know when to repaint areas of an image that is being loaded.
- Parameters
-
x | X offset of upper-left corner of the updated area. |
y | Y offset of upper-left corner of the updated area. |
width | Width of updated area. |
height | Height of updated area. |
Glib::SignalProxy< void, int, int > Gdk::PixbufLoader::signal_size_prepared |
( |
| ) |
|
This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create.
Applications can call set_size() in response to this signal to set the desired size to which the image should be scaled.
- Parameters
-
width | The original width of the image. |
height | The original height of the image |
- Slot Prototype:
void on_my_size_prepared(int width, int height)
Flags: Run Last
This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create. Applications can call
Gdk::PixbufLoader::set_size() in response to this signal to set the desired size to which the image should be scaled.
- Parameters
-
width | The original width of the image. |
height | The original height of the image. |