Класс QProgressBar
Виджет QProgressBar предоставляет горизонтальную или вертикальную полосу прогресса. Подробнее...
| Заголовок: | #include <QProgressBar> |
| qmake: | QT += widgets |
| Наследует: | QWidget |
Общедоступные типы
| Перечисление | Direction { TopToBottom, BottomToTop } |
Свойства
|
|
Общедоступные функции
| QProgressBar(QWidget *parent = Q_NULLPTR) | |
| ~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 |
| virtual QSize | sizeHint() const |
- 214 общедоступных функций унаследовано от QWidget
- 32 общедоступных функции унаследовано от QObject
- 14 общедоступных функций унаследовано от QPaintDevice
Общедоступные слоты
| 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) |
Защищённые функции
| void | initStyleOption(QStyleOptionProgressBar *option) const |
Переопределённые защищённые функции
| virtual bool | event(QEvent *e) |
| virtual void | paintEvent(QPaintEvent *) |
- 35 защищённых функций унаследовано от QWidget
- 9 защищённых функций унаследовано от QObject
- 1 защищённая функция унаследовано от QPaintDevice
Дополнительные унаследованные члены
- 5 статических публичных членов унаследовано от QWidget
- 11 статических публичных членов унаследовано от QObject
- 1 защищённый слот унаследовано от QWidget
Подробное описание
Виджет QProgressBar предоставляет горизонтальную или вертикальную полосу прогресса.
Полоса прогресса используется, чтобы дать пользователю представление о ходе операции и заверить его, что приложение всё ещё работает.
Полоса прогресса использует понятие шагов. Вы настраиваете её, задавая минимальное и максимальное значения шагов, и она будет отображать процент завершённых шагов, когда вы позже укажете текущее значение шага. Процент рассчитывается путём деления прогресса (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 и WindowsXP этого не делают.
Этот перечисление был введен или изменен в Qt 4.1.
См. также textDirection.
Документация по свойствам
alignment : Qt::Alignment
Это свойство содержит выравнивание полосы прогресса.
Функции доступа:
| Qt::Alignment | alignment() const |
| void | setAlignment(Qt::Alignment alignment) |
format : QString
Это свойство содержит строку, используемую для генерации текущего текста.
%p - заменяется на процент завершенности. %v - заменяется на текущее значение. %m - заменяется на общее количество шагов.
Значение по умолчанию - "%p%".
Это свойство было введено в Qt 4.2.
Функции доступа:
| QString | format() const |
| void | setFormat(const QString &format) |
| void | resetFormat() |
См. также text().
invertedAppearance : bool
Это свойство указывает, отображается ли полоса прогресса в обратном порядке.
Если это свойство равно true, полоса прогресса растет в другом направлении (например, справа налево). По умолчанию, полоса прогресса не инвертирована.
Это свойство было введено в Qt 4.1.
Функции доступа:
| 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 4.1.
Функции доступа:
| Qt::Orientation | orientation() const |
| void | setOrientation(Qt::Orientation) |
См. также invertedAppearance и textDirection.
text : const QString
Это свойство содержит описательный текст, отображаемый с полосой прогресса.
Возвращаемый текст совпадает с текстом, отображаемым в центре (или, в некоторых стилях, слева) полосы прогресса.
Отображаемый прогресс может быть меньше минимального значения, указывая, что полоса прогресса находится в состоянии "сброса" до установки прогресса.
В реализации по умолчанию текст содержит процентное значение, которое указывает на прогресс до сих пор, или он пустой, потому что полоса прогресса находится в состоянии сброса.
Функции доступа:
| virtual QString | text() const |
textDirection : Direction
Это свойство содержит направление чтения текста для вертикальных полос прогресса.
Это свойство не оказывает влияния на горизонтальные полосы прогресса. По умолчанию направление чтения — QProgressBar::TopToBottom.
Это свойство было введено в Qt 4.1.
Функции доступа:
| 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 = Q_NULLPTR)
Создает полосу прогресса с заданным parent.
По умолчанию, минимальное значение шага устанавливается в 0, а максимальное - в 100.
См. также setRange().
QProgressBar::~QProgressBar()
Деструктор.
[virtual protected] bool QProgressBar::event(QEvent *e)
Переопределено из QObject::event().
[protected] void QProgressBar::initStyleOption(QStyleOptionProgressBar *option) const
Инициализирует option значениями из этой QProgressBar. Этот метод полезен для подклассов, когда им требуется QStyleOptionProgressBar, но они не хотят сами заполнять всю информацию.
См. также QStyleOption::initFrom().
[virtual] QSize QProgressBar::minimumSizeHint() const
Переопределено из QWidget::minimumSizeHint().
[virtual protected] void QProgressBar::paintEvent(QPaintEvent *)
Переопределено из QWidget::paintEvent().
[slot] void QProgressBar::reset()
Сбросить полосу прогресса. Полоса прогресса "перематывается" и не показывает прогресс.
[slot] void QProgressBar::setRange(int minimum, int maximum)
Устанавливает минимальное и максимальное значения полосы прогресса соответственно на minimum и maximum.
Если maximum меньше minimum, minimum становится единственным допустимым значением.
Если текущее значение выходит за пределы нового диапазона, полоса прогресса сбрасывается с помощью reset().
Полосу прогресса QProgressBar можно установить в состояние неопределенности, используя setRange(0, 0).
[virtual] QSize QProgressBar::sizeHint() const
Переопределено из QWidget::sizeHint().
[signal] void QProgressBar::valueChanged(int value)
Этот сигнал генерируется, когда изменяется значение, отображаемое в полосе прогресса. value — новое значение, отображаемое полосой прогресса.
Примечание: Сигнал-уведомление для свойства value.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qprogressbar.html