Класс QIconEngine

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

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

Типы

Открытые функции

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

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

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

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

См. также QIconEnginePlugin.

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

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

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

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

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

[since 5.6] 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)

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

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

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

[virtual] QString QIconEngine::iconName()

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

[virtual, since 5.7] bool QIconEngine::isNull()

Возвращает 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.

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

[virtual, since 5.9] QPixmap QIconEngine::scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale)

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

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

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

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

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

См. также ScaledPixmapArgument.

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

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

См. также IconEngineHook.

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

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

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