QImageIOHandler Class

Documentation des fonctions membres

QImageIOHandler::QImageIOHandler()

Crée un objet QImageIOHandler.

[virtual noexcept] QImageIOHandler::~QImageIOHandler()

Détruit l'objet « QImageIOHandler ».

[static, since 6.0] bool QImageIOHandler::allocateImage(QSize size, QImage::Format format, QImage *image)

Il s'agit d'une méthode pratique destinée à la fonction de lecture dans les sous-classes. Les gestionnaires de formats d'image doivent refuser de charger une image si l'allocation requise dépasse la limite d'allocation actuelle. Cette fonction vérifie les paramètres et la limite, puis effectue l'allocation si celle-ci est valide et nécessaire. En cas de retour réussi, ` image ` sera un objet ` QImage ` valide et détaché, correspondant aux paramètres ` size ` et ` format` fournis.

Cette fonction a été introduite dans Qt 6.0.

Voir également QImageReader::allocationLimit().

[pure virtual] bool QImageIOHandler::canRead() const

Renvoie ` true ` si une image peut être lue à partir du périphérique (c'est-à-dire si le format de l'image est pris en charge, si le périphérique est accessible en lecture et si les informations d'en-tête initiales indiquent que l'image peut être lue) ; sinon, renvoie ` false`.

Lors de la réimplémentation de canRead(), veillez à ce que le périphérique d’E/S (device()) soit laissé dans son état d’origine (par exemple, en utilisant peek() plutôt que read()).

Voir également read() et QIODevice::peek().

[virtual] int QImageIOHandler::currentImageNumber() const

Pour les formats d'image prenant en charge l'animation, cette fonction renvoie le numéro de séquence de l'image actuelle dans l'animation. Si cette fonction est appelée avant qu'une image ne soit chargée via ` read()`, elle renvoie -1. Le numéro de la première image de la séquence est 0.

Si le format d'image ne prend pas en charge l'animation, la valeur 0 est renvoyée.

Voir également read().

[virtual] QRect QImageIOHandler::currentImageRect() const

Renvoie le rectangle de l'image courante. Si aucun rectangle n'est défini pour l'image, un objet QRect() vide est renvoyé.

Cette fonction est utile pour les animations, où seules certaines parties de l'image peuvent être mises à jour à la fois.

QIODevice *QImageIOHandler::device() const

Renvoie le périphérique actuellement attribué à l'QImageIOHandler. Si aucun périphérique n'a été attribué, la valeur « nullptr » est renvoyée.

Voir également setDevice().

QByteArray QImageIOHandler::format() const

Renvoie le format actuellement attribué à QImageIOHandler. Si aucun format n'a été attribué, une chaîne vide est renvoyée.

Voir aussi setFormat().

[virtual] int QImageIOHandler::imageCount() const

Pour les formats d'image prenant en charge l'animation, cette fonction renvoie le nombre d'images composant l'animation. Si le format d'image ne prend pas en charge l'animation, ou s'il est impossible de déterminer le nombre d'images, la valeur 0 est renvoyée.

L'implémentation par défaut renvoie 1 si la fonction ` canRead()` renvoie ` true` ; dans le cas contraire, elle renvoie 0.

[virtual] bool QImageIOHandler::jumpToImage(int imageNumber)

Pour les formats d'image prenant en charge l'animation, cette fonction passe à l'image dont le numéro de séquence est imageNumber. Le prochain appel à read() tentera de lire cette image.

L'implémentation par défaut ne fait rien et renvoie false.

[virtual] bool QImageIOHandler::jumpToNextImage()

Pour les formats d'image prenant en charge l'animation, cette fonction passe à l'image suivante.

L'implémentation par défaut ne fait rien et renvoie ` false`.

[virtual] int QImageIOHandler::loopCount() const

Pour les formats d'image prenant en charge l'animation, cette fonction renvoie le nombre de fois que l'animation doit être lue en boucle. Si le format d'image ne prend pas en charge l'animation, la valeur 0 est renvoyée.

[virtual] int QImageIOHandler::nextImageDelay() const

Pour les formats d'image prenant en charge l'animation, cette fonction renvoie le nombre de millisecondes à attendre avant de lire l'image suivante. Si le format d'image ne prend pas en charge l'animation, la valeur 0 est renvoyée.

[virtual] QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option) const

Renvoie la valeur attribuée à option sous la forme d'un objet de type « QVariant ». Le type de la valeur dépend de l'option. Par exemple, l'option (Size) renvoie une variante de type « QSize ».

Voir également setOption() et supportsOption().

[pure virtual] bool QImageIOHandler::read(QImage *image)

Lit une image à partir de l'appareil et l'enregistre dans ` image`. Renvoie ` true ` si la lecture de l'image a réussi ; sinon, renvoie `false`.

Pour les formats d’image prenant en charge le chargement incrémental, ainsi que pour les formats d’animation, le gestionnaire d’image peut considérer que image pointe vers l’image précédente.

Voir également canRead().

void QImageIOHandler::setDevice(QIODevice *device)

Définit le périphérique de la fonction ` QImageIOHandler ` sur ` device`. Le gestionnaire d'images utilisera ce périphérique lors de la lecture et de l'écriture d'images.

Le périphérique ne peut être défini qu’une seule fois et doit l’être avant d’appeler canRead(), read(), write(), etc. Si vous devez lire plusieurs fichiers, créez plusieurs instances de la sous-classe appropriée de QImageIOHandler.

Voir également device().

void QImageIOHandler::setFormat(const QByteArray &format)

Définit le format de l'QImageIOHandler sur format. Ce format est particulièrement utile pour les gestionnaires prenant en charge plusieurs formats d'image.

Voir également format().

void QImageIOHandler::setFormat(const QByteArray &format) const

Définit le format de la fonction ` QImageIOHandler ` sur ` format`. Ce format est particulièrement utile pour les gestionnaires prenant en charge plusieurs formats d'image.

Cette fonction est déclarée `const` afin de pouvoir être appelée depuis ` canRead()` ().

Voir également format().

[virtual] void QImageIOHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)

Définit l'option option avec la valeur value.

Voir également option() et ImageOption.

[virtual] bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option) const

Renvoie « true » si l'QImageIOHandler prend en charge l'option « option » ; sinon, renvoie « false ». Par exemple, si l'QImageIOHandler prend en charge l'option « Size », la fonction supportsOption(Size) doit renvoyer « true ».

Voir également setOption() et option().

[virtual] bool QImageIOHandler::write(const QImage &image)

Écrit l'image image sur le périphérique spécifié. Renvoie true en cas de réussite ; sinon, renvoie false.

L'implémentation par défaut ne fait rien et renvoie simplement false.