Audacity  2.3.1
Public Member Functions | Private Attributes | List of all members
SelectCommand Class Reference

Command for changing time, frequency and track selection. This class is a little baroque, as it uses the SelectTimeCommand, SelectFrequenciesCommand and SelectTracksCommand, when it could just explicitly code all three. More...

#include <SelectCommand.h>

Inheritance diagram for SelectCommand:
AudacityCommand ComponentInterface

Public Member Functions

ComponentInterfaceSymbol GetSymbol () override
 
wxString GetDescription () override
 
bool DefineParams (ShuttleParams &S) override
 
void PopulateOrExchange (ShuttleGui &S) override
 
bool Apply (const CommandContext &context) override
 
wxString ManualPage () override
 
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
 
virtual ~AudacityCommand ()
 
wxString GetPath () override
 
ComponentInterfaceSymbol GetVendor () override
 
wxString GetVersion () override
 
virtual bool IsBatchProcessing ()
 
virtual void SetBatchProcessing (bool start)
 
virtual bool Apply (const CommandContext &WXUNUSED(context))
 
virtual bool Apply ()
 
bool ShowInterface (wxWindow *parent, bool forceModal=false)
 
virtual void SetHostUI (EffectUIHostInterface *WXUNUSED(host))
 
bool PopulateUI (wxWindow *parent)
 
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
 
virtual bool GetAutomationParameters (wxString &parms)
 
virtual bool SetAutomationParameters (const wxString &parms)
 
bool DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
 
int MessageBox (const wxString &message, long style=DefaultMessageBoxStyle, const wxString &titleStr=wxString{})
 
virtual bool Init ()
 
virtual bool PromptUser (wxWindow *parent)
 
virtual bool CheckWhetherSkipAudacityCommand ()
 
virtual void End ()
 
virtual void PopulateOrExchange (ShuttleGui &WXUNUSED(S))
 
virtual bool TransferDataToWindow ()
 
virtual bool TransferDataFromWindow ()
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
const wxString & GetTranslatedName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Private Attributes

SelectTimeCommand mSelTime
 
SelectFrequenciesCommand mSelFreq
 
SelectTracksCommand mSelTracks
 

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 
int mUIResultID
 

Detailed Description

Command for changing time, frequency and track selection. This class is a little baroque, as it uses the SelectTimeCommand, SelectFrequenciesCommand and SelectTracksCommand, when it could just explicitly code all three.

Definition at line 100 of file SelectCommand.h.

Member Function Documentation

bool SelectCommand::Apply ( const CommandContext context)
inlineoverride

Definition at line 117 of file SelectCommand.h.

References SelectTimeCommand::Apply(), SelectFrequenciesCommand::Apply(), SelectTracksCommand::Apply(), mSelFreq, mSelTime, and mSelTracks.

117  {
118  return
119  mSelTime.Apply(context) &&
120  mSelFreq.Apply( context )&&
121  mSelTracks.Apply(context);
122  }
bool Apply(const CommandContext &context) override
SelectTimeCommand mSelTime
bool Apply(const CommandContext &context) override
bool Apply(const CommandContext &context) override
SelectFrequenciesCommand mSelFreq
SelectTracksCommand mSelTracks
bool SelectCommand::DefineParams ( ShuttleParams S)
inlineoverride

Definition at line 106 of file SelectCommand.h.

References SelectTimeCommand::DefineParams(), SelectFrequenciesCommand::DefineParams(), SelectTracksCommand::DefineParams(), mSelFreq, mSelTime, and mSelTracks.

106  {
107  return
108  mSelTime.DefineParams(S) &&
109  mSelFreq.DefineParams(S) &&
111  };
bool DefineParams(ShuttleParams &S) override
SelectTimeCommand mSelTime
bool DefineParams(ShuttleParams &S) override
SelectFrequenciesCommand mSelFreq
SelectTracksCommand mSelTracks
bool DefineParams(ShuttleParams &S) override
wxString SelectCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 105 of file SelectCommand.h.

References _().

105 {return _("Selects Audio.");};
_("Move Track &Down")+wxT("\t")+(GetActiveProject() -> GetCommandManager() ->GetKeyFromName(wxT("TrackMoveDown")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveTopID, _("Move Track to &Top")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveTop")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveBottomID, _("Move Track to &Bottom")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveBottom")).Raw()), OnMoveTrack)#define SET_TRACK_NAME_PLUGIN_SYMBOLclass SetTrackNameCommand:public AudacityCommand
ComponentInterfaceSymbol SelectCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 104 of file SelectCommand.h.

References SELECT_PLUGIN_SYMBOL.

104 {return SELECT_PLUGIN_SYMBOL;};
#define SELECT_PLUGIN_SYMBOL
Definition: SelectCommand.h:31
wxString SelectCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 124 of file SelectCommand.h.

124 {return wxT("Extra_Menu:_Scriptables_II#select");};
void SelectCommand::PopulateOrExchange ( ShuttleGui S)
inlineoverride

Definition at line 112 of file SelectCommand.h.

References mSelFreq, mSelTime, mSelTracks, SelectTimeCommand::PopulateOrExchange(), SelectFrequenciesCommand::PopulateOrExchange(), and SelectTracksCommand::PopulateOrExchange().

112  {
116  };
SelectTimeCommand mSelTime
void PopulateOrExchange(ShuttleGui &S) override
SelectFrequenciesCommand mSelFreq
void PopulateOrExchange(ShuttleGui &S) override
SelectTracksCommand mSelTracks
void PopulateOrExchange(ShuttleGui &S) override

Member Data Documentation

SelectFrequenciesCommand SelectCommand::mSelFreq
private

Definition at line 127 of file SelectCommand.h.

Referenced by Apply(), DefineParams(), and PopulateOrExchange().

SelectTimeCommand SelectCommand::mSelTime
private

Definition at line 124 of file SelectCommand.h.

Referenced by Apply(), DefineParams(), and PopulateOrExchange().

SelectTracksCommand SelectCommand::mSelTracks
private

Definition at line 128 of file SelectCommand.h.

Referenced by Apply(), DefineParams(), and PopulateOrExchange().


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