Класс QIconEngine

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

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

Открытые типы

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

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

Класс 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)

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

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

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

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

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

Возвращает пиксель для заданного 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.

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

См. также IconEngineHook.

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

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

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