Класс QIconEngine

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

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

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

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

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

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

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

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

Функции 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(). Добавляет специализированную QPixmap из файла с заданным fileName, size, mode и state. Движок по умолчанию на основе QPixmap хранит все предоставленные имена файлов и загружает QPixmap по требованию вместо использования масштабированных QPixmap, если размер QPixmap соответствует размеру запрошенной иконки. Пользовательские движки иконок, реализующие масштабируемые векторные форматы, могут игнорировать дополнительные файлы.

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

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

[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 к целочисленному типу.

См. также 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.