AppEvents::ProviderBase Class Reference

#include <AppEvents.h>

Inheritance diagram for AppEvents::ProviderBase:

Protected Member Functions
virtual	~ProviderBase ()=default
void	HandleAppInitialized ()
void	HandleAppIdle ()
void	HandleAppClosing ()

Detailed Description

Base class for application events providers. This class has no virtual methods and should not be publicly derived from. Derived classes should use the provided interface to fire events. It is safe to have multiple instances of derived classes, but it does not make much sense.

Definition at line 41 of file AppEvents.h.

Constructor & Destructor Documentation

~ProviderBase()

virtual AppEvents::ProviderBase::~ProviderBase ( )

protectedvirtualdefault

Member Function Documentation

HandleAppClosing()

void AppEvents::ProviderBase::HandleAppClosing ( )

protected

Definition at line 96 of file AppEvents.cpp.

{
   auto& handlers = GetEventHandlers();
 
   handlers.AppClosingCalled = true;
 
   std::vector<std::function<void()>> callbacks;
   std::swap(callbacks, handlers.appClosing);
 
   for (auto& callback : callbacks)
      callback();
}

References AppEvents::anonymous_namespace{AppEvents.cpp}::GetEventHandlers(), and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by AudacityApp::OnExit().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleAppIdle()

void AppEvents::ProviderBase::HandleAppIdle ( )

protected

Definition at line 91 of file AppEvents.cpp.

{
   GetEventHandlers().Publish(IdleEvent{});
}

References AppEvents::anonymous_namespace{AppEvents.cpp}::GetEventHandlers(), and Observer::Publisher< Message, NotifyAll >::Publish().

Referenced by AudacityApp::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleAppInitialized()

void AppEvents::ProviderBase::HandleAppInitialized ( )

protected

Definition at line 78 of file AppEvents.cpp.

{
   auto& handlers = GetEventHandlers();
 
   handlers.AppInitializedCalled = true;
 
   std::vector<std::function<void()>> callbacks;
   std::swap(callbacks, handlers.appInitialized);
 
   for (auto& callback : callbacks)
      callback();
}

References AppEvents::anonymous_namespace{AppEvents.cpp}::GetEventHandlers(), and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• AppEvents.h
• AppEvents.cpp