Spec-Zone.ru › Qt 5.6

Класс 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
  • 58 свойств, унаследованных от QWidget
  • 1 свойство, унаследованное от QObject

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

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
  • 211 открытых функций, унаследованных от QWidget
  • 31 открытых функций, унаследованных от 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)
  • 19 открытых слотов, унаследованных от QWidget
  • 1 открытый слот, унаследованный от QObject

Сигналы

void valueChanged(int value)
  • 3 сигнала, унаследованные от QWidget
  • 2 сигнала, унаследованные от QObject

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

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 для загрузки элементов, когда они не могут определить размер загружаемого элемента.

Screenshot of a Macintosh style progress bar Полоса прогресса, отображаемая в стиле виджета Macintosh.
Screenshot of a Windows Vista style progress bar Полоса прогресса, отображаемая в стиле виджета Windows Vista.
Screenshot of a Fusion style progress bar Полоса прогресса, отображаемая в стиле виджета Fusion.

См. также QProgressDialog и Справочник по проектированию пользовательского интерфейса: индикатор выполнения.

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

enum 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().

Полосу прогресса можно установить в неопределенное состояние, используя setRange(0, 0).

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

[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/archives/qt-5.6/qprogressbar.html

Spec-Zone.ru

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