JX Application Framework
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
JXProgressTask Class Reference

#include <JXProgressTask.h>

Inheritance diagram for JXProgressTask:
[legend]

Classes

class  Cancelled
 

Public Member Functions

 JXProgressTask (const JString &message, const bool allowCancel)
 
 JXProgressTask (JProgressDisplay *pg)
 
 ~JXProgressTask () override
 
- Public Member Functions inherited from JXIdleTask
 JXIdleTask (const Time period)
 
virtual ~JXIdleTask ()
 
void Start ()
 
void Stop ()
 
Time GetPeriod () const
 
void SetPeriod (const Time period)
 
void ResetTimer ()
 
- Public Member Functions inherited from JBroadcaster
 JBroadcaster ()
 
virtual ~JBroadcaster ()
 
JBroadcasteroperator= (const JBroadcaster &source)
 
bool HasSenders () const
 
JSize GetSenderCount () const
 
bool HasRecipients () const
 
JSize GetRecipientCount () const
 
virtual JString ToString () const
 
template<class T >
void ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)
 

Static Public Attributes

static const JUtf8BytekCancelled = "Cancelled::JXProgressTask"
 

Protected Member Functions

void Perform (const Time delta) override
 
- Protected Member Functions inherited from JXIdleTask
bool Ready (const Time delta, Time *maxSleepTime)
 
- Protected Member Functions inherited from JBroadcaster
 JBroadcaster (const JBroadcaster &source)
 
void ListenTo (const JBroadcaster *sender)
 
void StopListening (const JBroadcaster *sender)
 
void ClearWhenGoingAway (const JBroadcaster *sender, void *pointerToMember)
 
void StopListening (const JBroadcaster *sender, const std::type_info &messageType)
 
template<class T >
void Send (JBroadcaster *recipient, const T &message)
 
template<class T >
void Broadcast (const T &message)
 
virtual void Receive (JBroadcaster *sender, const Message &message)
 
void SendWithFeedback (JBroadcaster *recipient, Message *message)
 
void BroadcastWithFeedback (Message *message)
 
virtual void ReceiveWithFeedback (JBroadcaster *sender, Message *message)
 
virtual void ReceiveGoingAway (JBroadcaster *sender)
 

Detailed Description

Displays a progress display that ticks once per seconds.  Broadcasts
Cancelled message if the process is cancelled.

Constructor & Destructor Documentation

◆ JXProgressTask() [1/2]

JXProgressTask::JXProgressTask ( const JString message,
const bool  allowCancel 
)

By providing a constructor taking JString, derived classes can construct the message on the fly.

◆ JXProgressTask() [2/2]

JXProgressTask::JXProgressTask ( JProgressDisplay pg)

◆ ~JXProgressTask()

JXProgressTask::~JXProgressTask ( )
override

Member Function Documentation

◆ Perform()

void JXProgressTask::Perform ( const Time  delta)
overrideprotectedvirtual

Implements JXIdleTask.

Member Data Documentation

◆ kCancelled

const JUtf8Byte * JXProgressTask::kCancelled = "Cancelled::JXProgressTask"
static

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