QImageIOHandler Class

Documentation des fonctions membres

QImageIOHandler::QImageIOHandler()

Construit 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 de commodité pour la fonction de lecture dans les sous-classes. Les gestionnaires de format 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, et effectue l'allocation si elle est valide et nécessaire. En cas de retour réussi, image sera un QImage valide et détaché des size et format donnés.

Cette fonction a été introduite dans Qt 6.0.

Voir aussi QImageReader::allocationLimit().

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

Renvoie true si une image peut être lue sur le périphérique (c'est-à-dire que le format d'image est pris en charge, que le périphérique peut être lu et que les informations d'en-tête initiales suggèrent que l'image peut être lue) ; sinon, renvoie false.

Lorsque vous réimplémentez canRead(), assurez-vous que le périphérique d'E/S (device()) est 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 qui supportent l'animation, cette fonction renvoie le numéro de séquence de l'image courante dans l'animation. Si cette fonction est appelée avant qu'une image ne soit 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 fonction renvoie 0.

Voir également read().

[virtual] QRect QImageIOHandler::currentImageRect() const

Renvoie le rectangle de l'image courante. Si aucun rect n'est défini pour l'image, un 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é à QImageIOHandler. Si aucun périphérique n'a été attribué, nullptr est renvoyé.

Voir aussi 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 qui supportent l'animation, cette fonction renvoie le nombre d'images dans l'animation. Si le format d'image ne prend pas en charge l'animation, ou s'il n'est pas en mesure de déterminer le nombre d'images, la fonction renvoie 0.

L'implémentation par défaut renvoie 1 si canRead() renvoie true; sinon, 0 est renvoyé.

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

Pour les formats d'image qui supportent l'animation, cette fonction saute à 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 qui prennent 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 qui supportent l'animation, cette fonction renvoie le nombre de fois que l'animation doit tourner en boucle. Si le format d'image ne prend pas en charge l'animation, la fonction renvoie 0.

[virtual] int QImageIOHandler::nextImageDelay() const

Pour les formats d'image qui supportent 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 fonction renvoie 0.

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

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

Voir aussi setOption() et supportsOption().

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

Lit une image à partir de l'appareil et la stocke dans image. Renvoie true si l'image est lue avec succès ; sinon, renvoie false.

Pour les formats d'image qui prennent en charge le chargement incrémentiel et les formats d'animation, le gestionnaire d'image peut supposer que image pointe vers l'image précédente.

Voir également canRead().

void QImageIOHandler::setDevice(QIODevice *device)

Définit le périphérique de QImageIOHandler à 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, construisez plusieurs instances de la sous-classe QImageIOHandler appropriée.

Voir aussi device().

void QImageIOHandler::setFormat(const QByteArray &format)

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

Voir aussi format().

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

Définit le format de QImageIOHandler à format. Le format est très utile pour les gestionnaires qui prennent en charge plusieurs formats d'image.

Cette fonction est déclarée const pour pouvoir être appelée à partir de canRead().

Voir aussi format().

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

Fixe l'option option avec la valeur value.

Voir aussi option() et ImageOption.

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

Renvoie true si le site QImageIOHandler prend en charge l'option option; sinon, il renvoie false. Par exemple, si QImageIOHandler prend en charge l'option Size, supportsOption(Size) doit renvoyer true.

Voir aussi setOption() et option().

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

Écrit l'image image sur le périphérique assigné. Renvoie true en cas de succès, sinon false.

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