---
title: "ClikaRT::progress::Spinner"
sidebar_label: "Spinner"
description: "An indeterminate activity spinner for work with no measurable progress."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--class">class</span>

**Header:** `ClikaRT/progress/progress.h`

An indeterminate activity spinner for work with no measurable progress.

## Member functions

### Spinner() {#Spinner}

<div class="api-signature">

**`Spinner`**()

</div>

an unstarted spinner (first [tick()](./Spinner.md#tick) draws it)

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 111

</div>

### \~Spinner() {#Spinner-2}

<div class="api-signature">

**`~Spinner`**()

</div>

destructor

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 112

</div>

### Spinner(Spinner) {#Spinner-3}

<div class="api-signature">

**`Spinner`**(`Spinner&&` `other`) `noexcept`

</div>

move-construct

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 113

</div>

### operator=(Spinner) {#operator-assign}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`operator=`**([`Spinner`](./Spinner.md)`&&` `other`) `noexcept`

</div>

move-assign

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 114

</div>

### Spinner(Spinner) {#Spinner-4}

<div class="api-signature">

**`Spinner`**(`const Spinner&`) `=delete`

</div>

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 115

</div>

### operator=(Spinner) {#operator-assign-2}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`operator=`**(`const` [`Spinner`](./Spinner.md)`&`) `=delete`

</div>

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 116

</div>

### prefix() {#prefix}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`prefix`**(`std::string_view` `text`)

</div>

text before the spinner

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 118

</div>

### postfix() {#postfix}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`postfix`**(`std::string_view` `text`)

</div>

text after the spinner

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 119

</div>

### color() {#color}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`color`**([`Color`](./index.md#Color) `c`)

</div>

spinner color

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 120

</div>

### ascii() {#ascii}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`ascii`**(`bool` `on` `=` `true`)

</div>

force the ASCII glyph set

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 121

</div>

### show\_elapsed() {#show_elapsed}

<div class="api-signature">

[`Spinner`](./Spinner.md)`&` **`show_elapsed`**(`bool` `on` `=` `true`)

</div>

show elapsed time

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 122

</div>

### tick() {#tick}

<div class="api-signature">

`void` **`tick`**()

</div>

advance the animation one frame and redraw

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 124

</div>

### set\_postfix() {#set_postfix}

<div class="api-signature">

`void` **`set_postfix`**(`std::string_view` `text`)

</div>

update the postfix mid-run

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 125

</div>

### mark\_completed() {#mark_completed}

<div class="api-signature">

`void` **`mark_completed`**()

</div>

show the finished glyph

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 126

</div>

### done() {#done}

<div class="api-signature">

`void` **`done`**()

</div>

finalize the line

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 127

</div>

### completed() {#completed}

<div class="api-signature">

`bool` **`completed`**() `const`

</div>

whether the spinner was finished

<div class="api-declared">

Declared in `ClikaRT/progress/progress.h`, line 128

</div>