Audacity  2.2.0
AppCommandEvent Class Referencefinal

An event 'envelope' for sending Command objects through the wxwidgets event loop. More...

#include <AppCommandEvent.h>

Inheritance diagram for AppCommandEvent:

Public Member Functions

 AppCommandEvent (wxEventType commandType=wxEVT_APP_COMMAND_RECEIVED, int id=0)
 AppCommandEvent (const AppCommandEvent &event)
 ~AppCommandEvent ()
wxEvent * Clone () const override
void SetCommand (const CommandHolder &cmd)
 Store a pointer to a command object. More...
CommandHolder GetCommand ()

Private Attributes

CommandHolder mCommand

Detailed Description

An event 'envelope' for sending Command objects through the wxwidgets event loop.

This allows commands to be communicated from the script thread to the main thread.

Constructor & Destructor Documentation

AppCommandEvent::AppCommandEvent ( wxEventType  commandType = wxEVT_APP_COMMAND_RECEIVED,
int  id = 0 

Referenced by Clone().

AppCommandEvent::AppCommandEvent ( const AppCommandEvent event)
AppCommandEvent::~AppCommandEvent ( )

Member Function Documentation

wxEvent * AppCommandEvent::Clone ( ) const

References AppCommandEvent(), and safenew.

CommandHolder AppCommandEvent::GetCommand ( )

References mCommand.

void AppCommandEvent::SetCommand ( const CommandHolder cmd)

Store a pointer to a command object.

References mCommand.

Referenced by ScriptCommandRelay::PostCommand().

Member Data Documentation

CommandHolder AppCommandEvent::mCommand

Referenced by GetCommand(), and SetCommand().

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