Spec-Zone.ru › Qt 5.14

Класс QProgressBar

Виджет QProgressBar предоставляет горизонтальную или вертикальную полосу прогресса. Подробнее...

Заголовок: #include <QProgressBar>
qmake: QT += widgets
Наследует: QWidget
  • Список всех членов, включая унаследованные

Общедоступные типы

Перечисление Direction { TopToBottom, BottomToTop }

Свойства

  • alignment : Qt::Alignment
  • format : QString
  • invertedAppearance : bool
  • maximum : int
  • minimum : int
  • orientation : Qt::Orientation
  • text : const QString
  • textDirection : Direction
  • textVisible : bool
  • value : int

Общедоступные функции

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)

Защищенные функции

void initStyleOption(QStyleOptionProgressBar *option) const

Реализованные защищенные функции

virtual bool event(QEvent *e) override
virtual void paintEvent(QPaintEvent *) override

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

Полоса прогресса используется для отображения пользователю хода выполнения операции и для того, чтобы убедиться, что приложение всё ещё работает.

Полоса прогресса использует понятие шагов. Вы настраиваете её, указывая минимальное и максимальное значения шагов, и она будет отображать процент завершённых шагов, когда вы позже укажете текущее значение шага. Процент вычисляется путём деления прогресса (значение() - минимальное()) на максимальное() - минимальное().

Вы можете указать минимальное и максимальное количество шагов с помощью setMinimum() и setMaximum. Текущее количество шагов устанавливается с помощью setValue(). Полоса прогресса может быть перемотана в начало с помощью reset().

Если минимальное и максимальное значения оба установлены в 0, полоса отображает индикатор активности вместо процента завершённых шагов. Это полезно, например, при использовании QNetworkAccessManager для загрузки элементов, когда невозможно определить размер загружаемого элемента.

См. также QProgressDialog и Руководство по разработке пользовательского интерфейса: Индикатор прогресса.

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

enum QProgressBar::Direction

Указывает направление чтения текста для вертикальных полос прогресса.

Константа Значение Описание
QProgressBar::TopToBottom 0 Текст поворачивается на 90 градусов по часовой стрелке.
QProgressBar::BottomToTop 1 Текст поворачивается на 90 градусов против часовой стрелки.

Обратите внимание, что вывод текста зависит от стиля. В настоящее время стили CleanLooks и Plastique выводят текст. Стили Mac, Windows и WindowsVista не выводят.

Этот перечисление был введён или изменён в 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 = 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).

См. также minimum и maximum.

[signal] void QProgressBar::valueChanged(int value)

Данный сигнал генерируется, когда значение, отображаемое на полосе прогресса, изменяется. value - новое значение, отображаемое полосой прогресса.

Примечание: Сигнал уведомления для свойства value.

[virtual] QProgressBar::~QProgressBar()

Деструктор.

[override virtual protected] bool QProgressBar::event(QEvent *e)

Переопределяет: QWidget::event(QEvent *event).

[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-5.14/qprogressbar.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API