Класс QIconEngine

Класс QIconEngine предоставляет абстрактный базовый класс для рендереров QIcon. Подробнее...

• Список всех членов, включая унаследованные

Типы публичного доступа

Публичные функции

Подробное описание

Движок иконок предоставляет функции рендеринга для QIcon. Каждая иконка имеет соответствующий движок иконок, который отвечает за отрисовку иконки с запрошенным размером, режимом и состоянием.

Иконка отрисовывается функцией paint(), а иконку также можно получить в виде пиксельного изображения с помощью функции pixmap() (реализация по умолчанию просто использует paint() для достижения этого). Функция addPixmap() может использоваться для добавления новых пиксельных изображений в движок иконок и используется QIcon для добавления специализированных пользовательских пиксельных изображений.

Функции paint(), pixmap() и addPixmap() являются виртуальными и поэтому могут быть переопределены в подклассах QIconEngine.

См. также QIconEnginePlugin.

Документация по типам членов

перечисление QIconEngine::IconEngineHook

Эти значения перечисления используются для virtual_hook() для разрешения дополнительных запросов к движку иконок без нарушения двоичной совместимости.

Это перечисление было введено или изменено в Qt 4.5.

См. также virtual_hook().

Документация по функциям-членам

QIconEngine::QIconEngine()

Конструирует движок иконок.

Эта функция была добавлена в Qt 5.6.

[virtual] QIconEngine::~QIconEngine()

Удаляет движок иконок.

[virtual] QSize QIconEngine::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)

Возвращает фактический размер иконки, предоставляемый движком для запрошенного size, mode и state. Реализация по умолчанию возвращает заданный size.

[virtual] void QIconEngine::addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)

Вызывается функцией QIcon::addFile(). Добавляет специализированное пиксельное изображение из файла с заданным fileName, size, mode и state. Стандартный движок на основе пиксельных изображений сохраняет все предоставленные имена файлов и загружает пиксельные изображения по мере необходимости, а не использует масштабированные пиксельные изображения, если размер пиксельного изображения соответствует запрошенному размеру иконки. Пользовательские движки иконок, реализующие масштабируемые векторные форматы, могут игнорировать дополнительные файлы.

[virtual] void QIconEngine::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)

Вызывается функцией QIcon::addPixmap(). Добавляет специализированное pixmap для заданного mode и state. Стандартный движок на основе пиксельных изображений сохраняет все предоставленные пиксельные изображения и использует их вместо масштабированных пиксельных изображений, если размер пиксельного изображения соответствует запрошенному размеру иконки. Пользовательские движки иконок, реализующие масштабируемые векторные форматы, могут игнорировать дополнительные пиксельные изображения.

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

Возвращает размеры всех изображений, содержащихся в движке для указанного mode и state.

Примечание: Это вспомогательный метод, и фактическая работа выполняется методом virtual_hook(), поэтому этот метод зависит от поддержки движка иконок и может не работать со всеми движками иконок.

Эта функция была добавлена в Qt 4.5.

[pure virtual] QIconEngine *QIconEngine::clone() const

Переопределите этот метод, чтобы вернуть клонированный экземпляр этого движка иконок.

[virtual] QString QIconEngine::iconName() const

Возвращает имя, используемое для создания движка, если оно доступно.

Примечание: Это вспомогательный метод, и фактическая работа выполняется методом virtual_hook(), поэтому этот метод зависит от поддержки движком иконок и может не работать со всеми движками иконок.

Функция была введена в Qt 4.7.

bool QIconEngine::isNull() const

Возвращает true, если этот движок иконок представляет пустую QIcon.

Примечание: Это вспомогательный метод, и фактическая работа выполняется методом virtual_hook(), поэтому этот метод зависит от поддержки движком иконок и может не работать со всеми движками иконок.

Функция была введена в Qt 5.7.

[virtual] QString QIconEngine::key() const

Возвращает ключ, идентифицирующий этот движок иконок.

[pure virtual] void QIconEngine::paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)

Использует заданный painter для отрисовки иконки с необходимым mode и state в прямоугольнике rect.

[virtual] QPixmap QIconEngine::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)

Возвращает иконку в виде pixmap с необходимым size, mode и state. По умолчанию создаётся новый pixmap и вызывается метод paint() для его заполнения.

[virtual] bool QIconEngine::read(QDataStream &in)

Читает содержимое движка иконок из потока QDataStream in. Возвращает true, если содержимое было прочитано; в противном случае возвращает false.

Реализация движка иконок по умолчанию всегда возвращает false.

QPixmap QIconEngine::scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale)

Возвращает pixmap для заданных size, mode, state и scale.

Аргумент scale обычно равен коэффициенту масштабирования (device pixel ratio) дисплея.

Примечание: Это вспомогательный метод, и фактическая работа выполняется методом virtual_hook(), поэтому этот метод зависит от поддержки движком иконок и может не работать со всеми движками иконок.

Примечание: Некоторые движки могут преобразовать scale в целое число.

См. также ScaledPixmapArgument.

[virtual] void QIconEngine::virtual_hook(int id, void *data)

Дополнительный метод, позволяющий расширить QIconEngine без добавления новых виртуальных методов (и без нарушения двоичной совместимости). Фактическое действие и формат data зависят от аргумента id, который фактически является константой из перечисления IconEngineHook.

Функция была введена в Qt 4.5.

См. также IconEngineHook.

[virtual] bool QIconEngine::write(QDataStream &out) const

Записывает содержимое этого движка в поток QDataStream out. Возвращает true если содержимое было записано; в противном случае возвращает false.

Реализация движка иконок по умолчанию всегда возвращает false.