QIcon Class

Documentation des fonctions membres

[noexcept] QIcon::QIcon()

Construit une icône nulle.

[explicit] QIcon::QIcon(QIconEngine *engine)

Crée une icône avec une icône spécifique engine. L'icône devient propriétaire du moteur.

QIcon::QIcon(const QPixmap &pixmap)

Construit une icône à partir d'un pixmap.

[explicit] QIcon::QIcon(const QString &fileName)

Construit une icône à partir du fichier avec l'adresse fileName. Le fichier sera chargé à la demande.

Si fileName contient un chemin relatif (par exemple, le nom du fichier uniquement), le fichier concerné doit être trouvé par rapport au répertoire de travail de l'exécution.

Le nom du fichier peut faire référence à un fichier réel sur le disque ou à l'une des ressources intégrées de l'application. Voir la vue d'ensemble du système de ressources pour plus de détails sur la manière d'intégrer des images et d'autres fichiers de ressources dans l'exécutable de l'application.

Utilisez les fonctions QImageReader::supportedImageFormats() et QImageWriter::supportedImageFormats() pour obtenir une liste complète des formats de fichiers pris en charge.

QIcon::QIcon(const QIcon &other)

Construit une copie de other, ce qui est très rapide.

[noexcept] QIcon::QIcon(QIcon &&other)

Move-construit une instance de QIcon, en la faisant pointer sur le même objet que celui vers lequel other pointait.

[noexcept] QIcon::~QIcon()

Détruit l'icône.

QSize QIcon::actualSize(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie la taille réelle de l'icône pour les objets demandés size, mode, et state. Le résultat peut être inférieur à la taille demandée, mais jamais supérieur. La taille renvoyée est exprimée en pixels indépendants du périphérique (ceci est important pour les pixmaps à haute résolution).

Voir aussi pixmap() et paint().

void QIcon::addFile(const QString &fileName, const QSize &size = QSize(), QIcon::Mode mode = Normal, QIcon::State state = Off)

Ajoute à l'icône une image provenant du fichier dont l'adresse est fileName, en tant que spécialisation pour size, mode et state. Le fichier sera chargé à la demande. Remarque : les moteurs d'icônes personnalisés sont libres d'ignorer les images ajoutées.

Si fileName contient un chemin relatif (par exemple, le nom du fichier uniquement), le fichier concerné doit être trouvé par rapport au répertoire de travail de l'exécution.

Le nom du fichier peut faire référence à un fichier réel sur le disque ou à l'une des ressources intégrées de l'application. Voir la vue d'ensemble du système de ressources pour plus de détails sur la manière d'intégrer des images et d'autres fichiers de ressources dans l'exécutable de l'application.

Utilisez les fonctions QImageReader::supportedImageFormats() et QImageWriter::supportedImageFormats() pour obtenir une liste complète des formats de fichiers pris en charge.

S'il existe une version haute résolution de l'image (identifiée par le suffixe @2x dans le nom de la base), elle est automatiquement chargée et ajoutée avec un rapport de pixels de 2. Ceci peut être désactivé en définissant la variable d'environnement QT_HIGHDPI_DISABLE_2X_IMAGE_LOADING (voir QImageReader).

Voir également addPixmap() et QPixmap::devicePixelRatio().

void QIcon::addPixmap(const QPixmap &pixmap, QIcon::Mode mode = Normal, QIcon::State state = Off)

Ajoute pixmap à l'icône, en tant que spécialisation pour mode et state.

Les moteurs d'icônes personnalisés sont libres d'ignorer les pixmaps ajoutés.

Voir aussi addFile().

QList<QSize> QIcon::availableSizes(QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie une liste des tailles d'icônes disponibles pour les sites mode et state spécifiés.

qint64 QIcon::cacheKey() const

Renvoie un nombre qui identifie le contenu de cet objet QIcon. Des objets QIcon distincts peuvent avoir la même clé s'ils font référence au même contenu.

La clé cacheKey() change lorsque l'icône est modifiée via addPixmap() ou addFile().

Les clés de cache sont surtout utiles dans le cadre de la mise en cache.

Voir aussi QPixmap::cacheKey().

[static] QStringList QIcon::fallbackSearchPaths()

Renvoie les chemins de recherche de secours pour les icônes.

Les chemins de recherche de secours sont consultés pour les fichiers d'icônes autonomes si current icon theme ou fallback icon theme ne fournissent pas de résultats pour une recherche d'icônes.

S'il n'est pas défini, les chemins de recherche de secours seront définis par la plate-forme.

Voir également setFallbackSearchPaths() et themeSearchPaths().

[static] QString QIcon::fallbackThemeName()

Renvoie le nom du thème d'icône de secours.

S'il n'est pas défini, le thème d'icône de secours sera défini par la plate-forme.

Voir aussi setFallbackThemeName() et themeName().

[static] QIcon QIcon::fromTheme(const QString &name)

Renvoie l'icône QIcon correspondant à name dans current icon theme.

Si le thème actuel ne fournit pas d'icône pour name, fallback icon theme est consulté, avant de rechercher des fichiers d'icônes autonomes dans fallback icon search path. Enfin, la bibliothèque d'icônes native de la plateforme est consultée.

Pour récupérer une icône du thème d'icônes actuel :

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo);

Si un thème icon theme n'a pas été explicitement défini via setThemeName(), un thème d'icônes défini par la plate-forme sera utilisé.

Voir aussi themeName(), fallbackThemeName(), setThemeName(), themeSearchPaths(), fallbackSearchPaths(), et Freedesktop Icon Naming Specification.

Renvoie l'icône QIcon correspondant à icon dans current icon theme.

Si le thème actuel ne fournit pas d'icône pour icon, le site fallback icon theme est consulté, avant de rechercher des fichiers d'icônes autonomes dans le site fallback icon search path. Enfin, la bibliothèque d'icônes native de la plateforme est consultée.

Si aucune icône n'est trouvée et qu'un fallback est fourni, fallback est renvoyé. Ceci est utile pour fournir une solution de repli garantie, indépendamment du fait que l'ensemble actuel des thèmes d'icônes et des chemins de repli supporte ou non l'icône demandée.

Si aucune icône n'est trouvée et qu'aucun fallback n'est fourni, un QIcon vide et construit par défaut est renvoyé.

Ces fonctions ont été introduites dans Qt 6.7.

[static] QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback)

Renvoie l'icône QIcon correspondant à name dans current icon theme.

Si le thème actuel ne fournit pas d'icône pour name, la page fallback icon theme est consultée, avant de rechercher des fichiers d'icônes autonomes dans la page fallback icon search path. Enfin, la bibliothèque d'icônes native de la plateforme est consultée.

Si aucune icône n'est trouvée, fallback est renvoyé.

Ceci est utile pour fournir une solution de repli garantie, indépendamment du fait que l'ensemble actuel de thèmes d'icônes et de chemins de repli prenne en charge l'icône demandée.

Par exemple, il s'agit d'une fonction surchargée :

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo, QIcon(":/undo.png"));

Voir aussi fallbackThemeName() et fallbackSearchPaths().

[static] bool QIcon::hasThemeIcon(const QString &name)

Renvoie true si une icône est disponible pour name dans le thème d'icônes actuel ou dans l'un des thèmes de remplacement, comme décrit par fromTheme(), sinon renvoie false.

Voir aussi themeSearchPaths(), fromTheme(), et setThemeName().

[static, since 6.7] bool QIcon::hasThemeIcon(QIcon::ThemeIcon icon)

Renvoie true s'il existe une icône disponible pour icon dans le thème d'icônes actuel ou dans l'un des thèmes de remplacement, comme décrit par fromTheme(), sinon renvoie false.

Cette fonction a été introduite dans Qt 6.7.

Voir aussi fromTheme().

bool QIcon::isMask() const

Renvoie true si cette icône a été marquée comme une image de masque. Certaines plateformes rendent les icônes masquées différemment (par exemple, les icônes de menu sur macOS).

Voir aussi setIsMask().

bool QIcon::isNull() const

Renvoie true si l'icône est vide, sinon renvoie false.

Une icône est vide si elle n'a ni pixmap ni nom de fichier.

Remarque : même une icône non vide peut ne pas être en mesure de créer des pixmaps valides, par exemple si le fichier n'existe pas ou ne peut pas être lu.

QString QIcon::name() const

Renvoie le nom utilisé pour créer l'icône, s'il est disponible.

Selon la manière dont l'icône a été créée, elle peut avoir un nom associé. C'est le cas des icônes créées avec fromTheme().

Voir aussi fromTheme() et QIconEngine::iconName().

void QIcon::paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Utilise painter pour peindre l'icône avec les éléments spécifiés alignment, requis mode, et state dans le rectangle rect.

Voir aussi actualSize() et pixmap().

void QIcon::paint(QPainter *painter, int x, int y, int w, int h, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Peint l'icône dans le rectangle QRect(x, y, w, h).

QPixmap QIcon::pixmap(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie une pixmap avec les valeurs demandées size, mode, et state, en en générant une si nécessaire. La pixmap peut être plus petite que celle demandée, mais jamais plus grande, à moins que le rapport périphérique-pixel de la pixmap renvoyée ne soit supérieur à 1.

Voir aussi actualSize() et paint().

QPixmap QIcon::pixmap(int extent, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie une image de taille QSize(extent, extent). La pixmap peut être plus petite que celle demandée, mais jamais plus grande, à moins que le rapport périphérique-pixel de la pixmap renvoyée ne soit supérieur à 1.

[since 6.0] QPixmap QIcon::pixmap(const QSize &size, qreal devicePixelRatio, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie une pixmap avec les images demandées size, devicePixelRatio, mode, et state, en générant une avec les images données mode et state si nécessaire. La pixmap peut être plus petite que celle demandée, mais jamais plus grande, à moins que le rapport périphérique-pixel de la pixmap renvoyée ne soit supérieur à 1.

Cette fonction a été introduite dans Qt 6.0.

Voir aussi actualSize() et paint().

QPixmap QIcon::pixmap(int w, int h, QIcon::Mode mode = Normal, QIcon::State state = Off) const

Renvoie une image de taille QSize(w, h). La pixmap peut être plus petite que celle demandée, mais jamais plus grande, à moins que le rapport périphérique-pixel de la pixmap renvoyée ne soit supérieur à 1.

[static] void QIcon::setFallbackSearchPaths(const QStringList &paths)

Définit les chemins de recherche de secours pour les icônes à paths.

Les chemins de recherche de secours sont consultés pour les fichiers d'icônes autonomes si les chemins current icon theme ou fallback icon theme ne fournissent pas de résultats pour une recherche d'icônes.

Par exemple :

QIcon::setFallbackSearchPaths(QIcon::fallbackSearchPaths() << "my/search/path");

Voir aussi fallbackSearchPaths() et setThemeSearchPaths().

[static] void QIcon::setFallbackThemeName(const QString &name)

Définit le thème d'icône de secours à name.

Le thème d'icône de secours est consulté pour les icônes non fournies par current icon theme, ou si current icon theme n'existe pas.

Le thème name doit correspondre au même format que celui documenté par setThemeName(), et sera recherché dans themeSearchPaths().

Voir également fallbackThemeName(), themeSearchPaths() et themeName().

void QIcon::setIsMask(bool isMask)

Indique que cette icône est une image masque (booléen isMask), et qu'elle peut donc potentiellement être modifiée en fonction de l'endroit où elle est affichée.

Voir aussi isMask().

[static] void QIcon::setThemeName(const QString &name)

Définit le thème de l'icône actuelle à name.

Si le thème correspond au nom d'une police installée qui fournit des glyphes nommés, les appels à QIcon::fromTheme qui correspondent à l'un des glyphes produiront une icône pour ce glyphe.

Sinon, le thème sera recherché dans themeSearchPaths(). Pour l'instant, le seul format de thème d'icône supporté est le Freedesktop Icon Theme Specification. L'adresse name doit correspondre à un nom de répertoire dans themeSearchPath() contenant un fichier index.theme décrivant son contenu.

Voir aussi themeSearchPaths(), themeName(), et Freedesktop Icon Theme Specification.

[static] void QIcon::setThemeSearchPaths(const QStringList &paths)

Définit les chemins de recherche pour les thèmes d'icônes à paths.

Le contenu de paths doit respecter le format de thème documenté par setThemeName().

Voir aussi themeSearchPaths(), fromTheme() et setThemeName().

[noexcept] void QIcon::swap(QIcon &other)

Remplace cette icône par other. Cette opération est très rapide et n'échoue jamais.

[static] QString QIcon::themeName()

Renvoie le nom du thème d'icônes actuel.

S'il n'est pas défini, le thème d'icônes actuel sera défini par la plate-forme.

Voir aussi setThemeName(), themeSearchPaths(), fromTheme(), et hasThemeIcon().

[static] QStringList QIcon::themeSearchPaths()

Renvoie les chemins de recherche pour les thèmes d'icônes.

Les chemins de recherche par défaut sont définis par la plateforme. Toutes les plates-formes disposent également du répertoire de ressources :\icons comme solution de rechange.

Voir aussi setThemeSearchPaths(), fromTheme() et setThemeName().

QIcon::operator QVariant() const

Retourne l'icône sous forme de QVariant.

[noexcept] QIcon &QIcon::operator=(QIcon &&other)

Move-assigne other à cette instance QIcon.

QIcon &QIcon::operator=(const QIcon &other)

Attribue l'icône other à cette icône et renvoie une référence à cette icône.