Class progress_bar

Boost C++ Libraries

Class progress_bar

boost::ui::progress_bar — Progress bar widget base class.

Synopsis

// In header: <boost/ui/progress_bar.hpp>


class progress_bar : public boost::ui::widget {
public:
  // types
  typedef int value_type;  // Progress bar value type. 

  // construct/copy/destruct
  progress_bar();

  // public member functions
  progress_bar & value(value_type);
  value_type value() const;
  value_type max() const;

  // private member functions
  void check_range(value_type) const;
  detail_impl * get_impl();
  const detail_impl * get_impl() const;

  // private static functions
  static void check_range(value_type, value_type);
};

Description

See Also:

Progress bar (Wikipedia)

`progress_bar` public construct/copy/destruct

```
progress_bar();
```

`progress_bar` public member functions

```
progress_bar & value(value_type value);
```
Sets value position.

Throws:
std::out_of_range If value is out of range
```
value_type value() const;
```
Returns value position.
```
value_type max() const;
```
Returns maximum value position.

`progress_bar` private member functions

void check_range(value_type value) const;

```
detail_impl * get_impl();
```
```
const detail_impl * get_impl() const;
```

`progress_bar` private static functions

static void check_range(value_type value, value_type max);