KiCad PCB EDA Suite
BUSY_INDICATOR Class Reference

A class that can be used to implement a "busy" indicator. More...

#include <busy_indicator.h>

Inheritance diagram for BUSY_INDICATOR:
WX_BUSY_INDICATOR

Public Types

using FACTORY = std::function< std::unique_ptr< BUSY_INDICATOR >()>
 A factory function that returns a new busy indicator. More...
 

Public Member Functions

virtual ~BUSY_INDICATOR ()=default
 This class is intended to be handled by pointer-to-base class. More...
 

Detailed Description

A class that can be used to implement a "busy" indicator.

The exact form of the busy indicator is unspecified. It could be a "spinner" cursor in a GUI context, for example.

This base class provides a "null" implementation, and can be overriden for specific behaviours.

THe busy-ness semantics are defined by this object's lifetime.

Definition at line 40 of file busy_indicator.h.

Member Typedef Documentation

◆ FACTORY

using BUSY_INDICATOR::FACTORY = std::function<std::unique_ptr<BUSY_INDICATOR>()>

A factory function that returns a new busy indicator.

Because BUSY_INDICATORs are RAII objects (i.e. the busy-ness is defined by the object's lieftime), it's convenient to pass a factory function for a client to be able to make a busy indicator when needed.

Definition at line 50 of file busy_indicator.h.

Constructor & Destructor Documentation

◆ ~BUSY_INDICATOR()

virtual BUSY_INDICATOR::~BUSY_INDICATOR ( )
virtualdefault

This class is intended to be handled by pointer-to-base class.


The documentation for this class was generated from the following file: