KiCad PCB EDA Suite
WX_BUSY_INDICATOR Class Reference

Simple wrapper around wxBusyCursor for used with the generic BUSY_INDICATOR interface. More...

#include <wx_busy_indicator.h>

Inheritance diagram for WX_BUSY_INDICATOR:
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

 WX_BUSY_INDICATOR ()
 Constructs a busy indicator represented by a wxBusyCursor, which will be active as long as this object exists (just like wxBustCursor itself). More...
 

Private Attributes

std::unique_ptr< wxBusyCursor > m_cursor
 

This is the actual WX cursor that is the indicator.

More...
 

Detailed Description

Simple wrapper around wxBusyCursor for used with the generic BUSY_INDICATOR interface.

Can be used to provide a WX busy cursor (spinner) to generic code that otherwise has no concept of wx cursors.

Definition at line 38 of file wx_busy_indicator.h.

Member Typedef Documentation

◆ FACTORY

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

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

◆ WX_BUSY_INDICATOR()

WX_BUSY_INDICATOR::WX_BUSY_INDICATOR ( )

Constructs a busy indicator represented by a wxBusyCursor, which will be active as long as this object exists (just like wxBustCursor itself).

Definition at line 29 of file wx_busy_indicator.cpp.

29  : m_cursor( std::make_unique<wxBusyCursor>() )
30 {
31 }
std::unique_ptr< wxBusyCursor > m_cursor
This is the actual WX cursor that is the indicator.

Member Data Documentation

◆ m_cursor

std::unique_ptr<wxBusyCursor> WX_BUSY_INDICATOR::m_cursor
private

This is the actual WX cursor that is the indicator.

Definition at line 49 of file wx_busy_indicator.h.


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