Класс QProgressBar
Виджет QProgressBar предоставляет горизонтальную или вертикальную полосу прогресса. Подробнее...
| Заголовок: | #include <QProgressBar> |
| CMake: | find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
| Наследуется от: | QWidget |
Типы публичного доступа
| Перечисление | Direction { TopToBottom, BottomToTop } |
Свойства
|
|
Функции публичного доступа
| QProgressBar(QWidget *parent = nullptr) | |
| virtual | ~QProgressBar() |
| Qt::Alignment | alignment() const |
| QString | format() const |
| bool | invertedAppearance() const |
| bool | isTextVisible() const |
| int | maximum() const |
| int | minimum() const |
| Qt::Orientation | orientation() const |
| void | resetFormat() |
| void | setAlignment(Qt::Alignment alignment) |
| void | setFormat(const QString &format) |
| void | setInvertedAppearance(bool invert) |
| void | setTextDirection(QProgressBar::Direction textDirection) |
| void | setTextVisible(bool visible) |
| virtual QString | text() const |
| QProgressBar::Direction | textDirection() const |
| int | value() const |
Переопределенные функции публичного доступа
| virtual QSize | minimumSizeHint() const override |
| virtual QSize | sizeHint() const override |
Свойства
| void | reset() |
| void | setMaximum(int maximum) |
| void | setMinimum(int minimum) |
| void | setOrientation(Qt::Orientation) |
| void | setRange(int minimum, int maximum) |
| void | setValue(int value) |
Сигналы
| void | valueChanged(int value) |
Защищенные функции
| virtual void | initStyleOption(QStyleOptionProgressBar *option) const |
Переопределенные защищенные функции
| virtual bool | event(QEvent *e) override |
| virtual void | paintEvent(QPaintEvent *) override |
Подробное описание
Полоса прогресса используется для отображения пользователю хода выполнения операции и для уверения пользователя, что приложение всё ещё работает.
Полоса прогресса использует концепцию шагов. Вы настраиваете её, задавая минимальное и максимальное значения шагов, и она будет отображать процент завершенных шагов, когда вы позже зададите текущее значение шага. Процент рассчитывается путём деления прогресса (value() - minimum()) на maximum() - minimum().
Вы можете указать минимальное и максимальное количество шагов с помощью setMinimum() и setMaximum. Текущее количество шагов задаётся с помощью setValue(). Полосу прогресса можно перемотать в начало с помощью reset().
Если минимальное и максимальное значения оба установлены в 0, полоса отображает индикатор активности вместо процента завершенных шагов. Это полезно, например, при использовании QNetworkAccessManager для загрузки элементов, когда невозможно определить размер загружаемого элемента.
См. также QProgressDialog и Руководство по разработке графического интерфейса: Индикатор прогресса.
Документация типов членов
Перечисление QProgressBar::Direction
Определяет направление чтения текста для вертикальных полос прогресса.
| Константа | Значение | Описание |
|---|---|---|
QProgressBar::TopToBottom |
0 |
Текст поворачивается на 90 градусов по часовой стрелке. |
QProgressBar::BottomToTop |
1 |
Текст поворачивается на 90 градусов против часовой стрелки. |
Обратите внимание, что отображение текста зависит от стиля. В настоящее время стили CleanLooks и Plastique отображают текст. Стили Mac, Windows и WindowsVista не отображают.
См. также textDirection.
Документация свойств
alignment : Qt::Alignment
Это свойство содержит выравнивание полосы прогресса.
Функции доступа:
| Qt::Alignment | alignment() const |
| void | setAlignment(Qt::Alignment alignment) |
format : QString
Это свойство содержит строку, используемую для генерации текущего текста.
%p - заменяется процентом завершения. %v - заменяется текущим значением. %m - заменяется общим количеством шагов.
Значение по умолчанию - "%p%".
Функции доступа:
| QString | format() const |
| void | setFormat(const QString &format) |
| void | resetFormat() |
См. также text().
invertedAppearance : bool
Это свойство указывает, отображается ли полоса прогресса инвертированным образом.
Если это свойство true, полоса прогресса увеличивается в другом направлении (например, справа налево). По умолчанию, полоса прогресса не инвертирована.
Функции доступа:
| bool | invertedAppearance() const |
| void | setInvertedAppearance(bool invert) |
См. также orientation и layoutDirection.
maximum : int
Это свойство содержит максимальное значение полосы прогресса.
При установке этого свойства свойство minimum корректируется при необходимости, чтобы диапазон оставался допустимым. Если текущее значение выходит за пределы нового диапазона, полоса прогресса сбрасывается с помощью reset().
Функции доступа:
| int | maximum() const |
| void | setMaximum(int maximum) |
minimum : int
Это свойство содержит минимальное значение полосы прогресса.
При установке этого свойства свойство maximum корректируется при необходимости, чтобы диапазон оставался допустимым. Если текущее значение выходит за пределы нового диапазона, полоса прогресса сбрасывается с помощью reset().
Функции доступа:
| int | minimum() const |
| void | setMinimum(int minimum) |
orientation : Qt::Orientation
Это свойство содержит ориентацию полосы прогресса.
Ориентация должна быть Qt::Horizontal (по умолчанию) или Qt::Vertical.
Функции доступа:
| Qt::Orientation | orientation() const |
| void | setOrientation(Qt::Orientation) |
См. также invertedAppearance и textDirection.
[read-only] text : const QString
Это свойство содержит описательный текст, отображаемый вместе с полосой прогресса.
Возвращаемый текст совпадает с текстом, отображаемым в центре (или, в некоторых стилях, слева) полосы прогресса.
Отображаемый в тексте прогресс может быть меньше минимального значения, указывая, что полоса прогресса находится в состоянии "сброса" до установки любого прогресса.
В реализации по умолчанию текст содержит процентное значение, указывающее текущий прогресс, или он пуст, если полоса прогресса находится в состоянии сброса.
Функции доступа:
| virtual QString | text() const |
textDirection : Direction
Это свойство содержит направление чтения текста для вертикальных полос прогресса.
Это свойство не влияет на горизонтальные полосы прогресса. По умолчанию направление чтения - QProgressBar::TopToBottom.
Функции доступа:
| QProgressBar::Direction | textDirection() const |
| void | setTextDirection(QProgressBar::Direction textDirection) |
См. также orientation и textVisible.
textVisible : bool
Это свойство указывает, должен ли отображаться текущий процент завершения.
Это свойство может игнорироваться стилем (например, QMacStyle никогда не рисует текст).
Функции доступа:
| bool | isTextVisible() const |
| void | setTextVisible(bool visible) |
См. также textDirection.
value : int
Это свойство содержит текущее значение полосы прогресса.
Попытка изменить текущее значение на значение, выходящее за пределы диапазона минимального-максимального значения, не повлияет на текущее значение.
Функции доступа:
| int | value() const |
| void | setValue(int value) |
Сигнал-уведомление:
| void | valueChanged(int value) |
Документация функций-членов
QProgressBar::QProgressBar(QWidget *parent = nullptr)
Конструирует полосу прогресса с заданным parent.
По умолчанию минимальное значение шага устанавливается в 0, а максимальное - в 100.
См. также setRange().
[slot] void QProgressBar::reset()
Сбрасывает полосу прогресса. Полоса прогресса "перематывается" и не показывает прогресс.
[slot] void QProgressBar::setRange(int minimum, int maximum)
Устанавливает минимальное и максимальное значения полосы прогресса соответственно в minimum и maximum.
Если maximum меньше minimum, minimum становится единственным допустимым значением.
Если текущее значение выходит за пределы нового диапазона, полоса прогресса сбрасывается с помощью reset().
Можно установить полосу прогресса в неопределённое состояние, используя setRange(0, 0).
[signal] void QProgressBar::valueChanged(int value)
Этот сигнал генерируется при изменении значения, отображаемого в полосе прогресса. value - новое значение, отображаемое полосой прогресса.
Примечание: Сигнал-уведомление для свойства value.
[virtual] QProgressBar::~QProgressBar()
Деструктор.
[override virtual protected] bool QProgressBar::event(QEvent *e)
Переопределяет: QWidget::event(QEvent *event).
[virtual protected] void QProgressBar::initStyleOption(QStyleOptionProgressBar *option) const
Инициализирует option значениями из этой QProgressBar. Этот метод полезен для подклассов, когда им нужен QStyleOptionProgressBar, но они не хотят заполнять всю информацию сами.
См. также QStyleOption::initFrom().
[override virtual] QSize QProgressBar::minimumSizeHint() const
Переопределяет функцию доступа к свойству: QWidget::minimumSizeHint.
[override virtual protected] void QProgressBar::paintEvent(QPaintEvent *)
Переопределяет: QWidget::paintEvent(QPaintEvent *event).
[override virtual] QSize QProgressBar::sizeHint() const
Переопределяет функцию доступа к свойству: QWidget::sizeHint.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qprogressbar.html
