QIcon Class

Documentación de las funciones miembro

[noexcept] QIcon::QIcon()

Construye un icono nulo.

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

Crea un icono con un icono específico engine. El icono toma la propiedad del motor.

QIcon::QIcon(const QPixmap &pixmap)

Construye un icono a partir de pixmap.

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

Crea un icono a partir del archivo con la dirección fileName. El archivo se cargará cuando se solicite.

Si fileName contiene una ruta relativa (por ejemplo, sólo el nombre del archivo), el archivo en cuestión debe encontrarse en relación con el directorio de trabajo en tiempo de ejecución.

El nombre del archivo puede referirse a un archivo real en el disco o a uno de los recursos integrados de la aplicación. Consulte la descripción general del sistema de recursos para obtener más información sobre cómo incrustar imágenes y otros archivos de recursos en el ejecutable de la aplicación.

Utilice las funciones QImageReader::supportedImageFormats() y QImageWriter::supportedImageFormats() para obtener una lista completa de los formatos de archivo compatibles.

QIcon::QIcon(const QIcon &other)

Construye una copia de other. Esto es muy rápido.

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

Mover-construye una instancia de QIcon, haciendo que apunte al mismo objeto al que apuntaba other.

[noexcept] QIcon::~QIcon()

Destruye el icono.

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

Devuelve el tamaño real del icono para los sitios solicitados size, mode, y state. El resultado puede ser menor que el solicitado, pero nunca mayor. El tamaño devuelto está en píxeles independientes del dispositivo (Esto es relevante para mapas de píxeles de alta ppp).

Véase también pixmap() y paint().

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

Añade una imagen del archivo con el valor fileName al icono, como especialización para size, mode y state. El archivo se cargará bajo demanda. Nota: los motores de iconos personalizados son libres de ignorar los mapas de píxeles añadidos adicionalmente.

Si fileName contiene una ruta relativa (por ejemplo, sólo el nombre del archivo), el archivo correspondiente debe encontrarse en relación con el directorio de trabajo en tiempo de ejecución.

El nombre del archivo puede referirse a un archivo real en disco o a uno de los recursos incrustados de la aplicación. Consulte la descripción general del sistema de recursos para obtener más información sobre cómo incrustar imágenes y otros archivos de recursos en el ejecutable de la aplicación.

Utilice las funciones QImageReader::supportedImageFormats() y QImageWriter::supportedImageFormats() para obtener una lista completa de los formatos de archivo compatibles.

Si existe una versión de alta resolución de la imagen (identificada por el sufijo @2x en el nombre base), se carga automáticamente y se añade con la relación de píxeles del dispositivo establecida en un valor de 2. Esto puede desactivarse estableciendo la variable de entorno QT_HIGHDPI_DISABLE_2X_IMAGE_LOADING (véase QImageReader).

Véase también addPixmap() y QPixmap::devicePixelRatio().

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

Añade pixmap al icono, como especialización para mode y state.

Los motores de iconos personalizados son libres de ignorar los mapas de píxeles añadidos adicionalmente.

Véase también addFile().

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

Devuelve una lista de los tamaños de icono disponibles para los sitios mode y state especificados.

qint64 QIcon::cacheKey() const

Devuelve un número que identifica el contenido de este objeto QIcon. Distintos objetos QIcon pueden tener la misma clave si se refieren al mismo contenido.

La cacheKey() cambiará cuando el icono se modifique a través de addPixmap() o addFile().

Las claves de caché son útiles sobre todo en conjunción con el almacenamiento en caché.

Véase también QPixmap::cacheKey().

[static] QStringList QIcon::fallbackSearchPaths()

Devuelve las rutas de búsqueda alternativas de iconos.

Las rutas de búsqueda alternativas se consultan para los archivos de iconos independientes si current icon theme o fallback icon theme no proporcionan resultados para una búsqueda de iconos.

Si no se establecen, las rutas de búsqueda alternativas serán definidas por la plataforma.

Véase también setFallbackSearchPaths() y themeSearchPaths().

[static] QString QIcon::fallbackThemeName()

Devuelve el nombre del tema del icono alternativo.

Si no se establece, el tema de icono alternativo será definido por la plataforma.

Véase también setFallbackThemeName() y themeName().

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

Devuelve el QIcon correspondiente a name en el current icon theme.

Si el tema actual no proporciona un icono para name, se consulta fallback icon theme, antes de volver a buscar archivos de iconos independientes en fallback icon search path. Por último, se consulta la biblioteca de iconos nativa de la plataforma.

Para obtener un icono del tema de iconos actual:

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

Si no se ha establecido explícitamente un icon theme mediante setThemeName(), se utilizará un tema de iconos definido por la plataforma.

Véase también themeName(), fallbackThemeName(), setThemeName(), themeSearchPaths(), fallbackSearchPaths(), y Freedesktop Icon Naming Specification.

Devuelve el QIcon correspondiente a icon en el current icon theme.

Si el tema actual no proporciona un icono para icon, se consulta fallback icon theme, antes de volver a buscar archivos de iconos independientes en fallback icon search path. Por último, se consulta la biblioteca de iconos nativa de la plataforma.

Si no se encuentra ningún icono y se proporciona un fallback, se devuelve fallback. Esto es útil para proporcionar un fallback garantizado, independientemente de si el conjunto actual de temas de iconos y rutas de fallbacks soportan el icono solicitado.

Si no se encuentra ningún icono y no se proporciona fallback, se devuelve un QIcon vacío construido por defecto.

Estas funciones se introdujeron en Qt 6.7.

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

Devuelve el QIcon correspondiente a name en el current icon theme.

Si el tema actual no proporciona un icono para name, se consulta fallback icon theme, antes de volver a buscar archivos de iconos independientes en fallback icon search path. Por último, se consulta la biblioteca de iconos nativa de la plataforma.

Si no se encuentra ningún icono, se devuelve fallback.

Esto es útil para proporcionar un fallback garantizado, independientemente de si el conjunto actual de temas de iconos y rutas de fallbacks soportan el icono solicitado.

Por ejemplo:

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

Véase también fallbackThemeName() y fallbackSearchPaths().

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

Devuelve true si hay un icono disponible para name en el tema de iconos actual o en cualquiera de los temas alternativos, como se describe en fromTheme(), de lo contrario devuelve false.

Véase también themeSearchPaths(), fromTheme(), y setThemeName().

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

Devuelve true si hay un icono disponible para icon en el tema de iconos actual o en cualquiera de los temas alternativos, como se describe en fromTheme(), de lo contrario devuelve false.

Esta función se introdujo en Qt 6.7.

Véase también fromTheme().

bool QIcon::isMask() const

Devuelve true si este icono se ha marcado como imagen de máscara. Algunas plataformas muestran los iconos de máscara de forma diferente (por ejemplo, los iconos de menú en macOS).

Véase también setIsMask().

bool QIcon::isNull() const

Devuelve true si el icono está vacío; en caso contrario, devuelve false.

Un icono está vacío si no tiene ni un mapa de píxeles ni un nombre de archivo.

Nota: Incluso un icono no nulo podría no ser capaz de crear pixmaps válidos, por ejemplo, si el archivo no existe o no se puede leer.

QString QIcon::name() const

Devuelve el nombre utilizado para crear el icono, si está disponible.

Dependiendo de la forma en que se creó el icono, puede tener un nombre asociado. Este es el caso de los iconos creados con fromTheme().

Véase también fromTheme() y QIconEngine::iconName().

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

Utiliza painter para pintar el icono con alignment especificado, mode requerido y state en el rectángulo rect.

Véase también actualSize() y 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

Pinta el icono en el rectángulo QRect(x, y, w, h).

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

Devuelve un mapa de píxeles con los valores solicitados size, mode, y state, generando uno si es necesario. El mapa de píxeles puede ser menor que el solicitado, pero nunca mayor, a menos que la relación dispositivo-píxel del mapa de píxeles devuelto sea mayor que 1.

Véase también actualSize() y paint().

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

Devuelve un mapa de píxeles de tamaño QSize(extent, extent). El mapa de píxeles puede ser menor que el solicitado, pero nunca mayor, a menos que la relación dispositivo-píxel del mapa de píxeles devuelto sea mayor que 1.

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

Devuelve un mapa de píxeles con los valores solicitados size, devicePixelRatio, mode, y state, generando uno con los valores mode y state si es necesario. El mapa de píxeles puede ser menor que el solicitado, pero nunca mayor, a menos que la relación dispositivo-píxel del mapa de píxeles devuelto sea mayor que 1.

Esta función se introdujo en Qt 6.0.

Ver también actualSize() y paint().

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

Devuelve un mapa de píxeles de tamaño QSize(w, h). El mapa de píxeles puede ser menor que el solicitado, pero nunca mayor, a menos que la relación dispositivo-píxel del mapa de píxeles devuelto sea mayor que 1.

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

Establece las rutas de búsqueda alternativas para los iconos en paths.

Las rutas de búsqueda alternativas se consultan para los archivos de iconos independientes si current icon theme o fallback icon theme no proporcionan resultados para una búsqueda de iconos.

Por ejemplo:

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

Véase también fallbackSearchPaths() y setThemeSearchPaths().

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

Establece el tema del icono de reserva en name.

El tema de icono alternativo se consulta para los iconos no proporcionados por current icon theme, o si current icon theme no existe.

name debe corresponder al tema en el mismo formato que el documentado por setThemeName(), y se buscará en themeSearchPaths().

Véase también fallbackThemeName(), themeSearchPaths(), y themeName().

void QIcon::setIsMask(bool isMask)

Indica que este icono es una imagen de máscara(boolean isMask), y por lo tanto puede modificarse potencialmente en función de dónde se muestre.

Véase también isMask().

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

Establece el tema del icono actual en name.

Si el tema coincide con el nombre de una fuente instalada que proporciona glifos con nombre, las llamadas a QIcon::fromTheme que coincidan con uno de los glifos producirán un icono para ese glifo.

En caso contrario, el tema se buscará en themeSearchPaths(). Por el momento, el único formato de tema de icono compatible es Freedesktop Icon Theme Specification. name debe corresponder a un nombre de directorio en themeSearchPath() que contenga un archivo index.theme que describa su contenido.

Véase también themeSearchPaths(), themeName(), y Freedesktop Icon Theme Specification.

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

Establece las rutas de búsqueda de temas de iconos en paths.

El contenido de paths debe seguir el formato de tema documentado por setThemeName().

Véase también themeSearchPaths(), fromTheme(), y setThemeName().

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

Cambia este icono por other. Esta operación es muy rápida y nunca falla.

[static] QString QIcon::themeName()

Devuelve el nombre del tema de iconos actual.

Si no se establece, el tema de iconos actual será definido por la plataforma.

Véase también setThemeName(), themeSearchPaths(), fromTheme(), y hasThemeIcon().

[static] QStringList QIcon::themeSearchPaths()

Devuelve las rutas de búsqueda de los temas de iconos.

Las rutas de búsqueda por defecto serán definidas por la plataforma. Todas las plataformas tendrán también el directorio de recursos :\icons como alternativa.

Véase también setThemeSearchPaths(), fromTheme() y setThemeName().

QIcon::operator QVariant() const

Devuelve el icono como QVariant.

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

Mover-asigna other a esta instancia QIcon.

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

Asigna el icono other a este icono y devuelve una referencia a este icono.