Spec-Zone.ru › Qt 5.12

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

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

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
  • 214 общедоступных функций унаследовано от 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

Статические публичные члены

const QMetaObject staticMetaObject
  • 5 статических публичных членов унаследованных от QWidget
  • 9 статических публичных членов унаследованных от QObject

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

void initStyleOption(QStyleOptionProgressBar *option) const

Переопределенные защищенные функции

virtual bool event(QEvent *e) override
virtual void paintEvent(QPaintEvent *) override
  • 35 защищенных функций унаследованных от QWidget
  • 9 защищенных функций унаследованных от QObject
  • 1 защищенная функция унаследованная от QPaintDevice

Дополнительные унаследованные члены

  • 1 защищенный слот унаследованный от QWidget

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

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

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

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

Вы можете указать минимальное и максимальное количество шагов с помощью 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().

[virtual] QProgressBar::~QProgressBar()

Деструктор.

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

Переопределено из QWidget::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().

[slot] void QProgressBar::reset()

Сброс полосы прогресса. Полоса прогресса "перематывается" и не показывает никакой прогресс.

[slot] void QProgressBar::setRange(int minimum, int maximum)

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

Если maximum меньше minimum, minimum становится единственным допустимым значением.

Если текущее значение выходит за пределы нового диапазона, полоса прогресса сбрасывается с помощью reset().

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

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

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

Spec-Zone.ru

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