Audacity  3.0.3
Public Member Functions | Static Public Attributes | 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:
[legend]
Collaboration diagram for SelectCommand:
[legend]

Public Member Functions

ComponentInterfaceSymbol GetSymbol () override
 
TranslatableString GetDescription () override
 
bool DefineParams (ShuttleParams &S) override
 
void PopulateOrExchange (ShuttleGui &S) override
 
bool Apply (const CommandContext &context) override
 
ManualPageID ManualPage () override
 
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
 
virtual ~AudacityCommand ()
 
PluginPath GetPath () override
 
VendorSymbol GetVendor () override
 
wxString GetVersion () override
 
virtual bool IsBatchProcessing ()
 
virtual void SetBatchProcessing (bool start)
 
virtual bool Apply (const CommandContext &WXUNUSED(context))
 
bool ShowInterface (wxWindow *parent, bool forceModal=false)
 
virtual void SetHostUI (EffectUIHostInterface *WXUNUSED(host))
 
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 TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
 
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 ()
 
TranslatableString GetName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Select") }
 

Private Attributes

SelectTimeCommand mSelTime
 
SelectFrequenciesCommand mSelFreq
 
SelectTracksCommand mSelTracks
 

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
using VetoDialogHook = bool(*)(wxDialog *)
 
- Static Public Member Functions inherited from AudacityCommand
static VetoDialogHook SetVetoDialogHook (VetoDialogHook hook)
 
- 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

◆ Apply()

bool SelectCommand::Apply ( const CommandContext context)
inlineoverride

Definition at line 119 of file SelectCommand.h.

119  {
120  return
121  mSelTime.Apply(context) &&
122  mSelFreq.Apply( context )&&
123  mSelTracks.Apply(context);
124  }

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

Here is the call graph for this function:

◆ DefineParams()

bool SelectCommand::DefineParams ( ShuttleParams S)
inlineoverride

Definition at line 108 of file SelectCommand.h.

108  {
109  return
110  mSelTime.DefineParams(S) &&
111  mSelFreq.DefineParams(S) &&
113  };

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

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SelectCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 107 of file SelectCommand.h.

107 {return XO("Selects Audio.");};

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol SelectCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 106 of file SelectCommand.h.

106 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID SelectCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 126 of file SelectCommand.h.

126 {return L"Extra_Menu:_Scriptables_II#select";}

◆ PopulateOrExchange()

void SelectCommand::PopulateOrExchange ( ShuttleGui S)
inlineoverride

Definition at line 114 of file SelectCommand.h.

114  {
118  };

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

Here is the call graph for this function:

Member Data Documentation

◆ mSelFreq

SelectFrequenciesCommand SelectCommand::mSelFreq
private

Definition at line 129 of file SelectCommand.h.

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

◆ mSelTime

SelectTimeCommand SelectCommand::mSelTime
private

Definition at line 128 of file SelectCommand.h.

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

◆ mSelTracks

SelectTracksCommand SelectCommand::mSelTracks
private

Definition at line 130 of file SelectCommand.h.

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

◆ Symbol

const ComponentInterfaceSymbol SelectCommand::Symbol { XO("Select") }
static

Definition at line 103 of file SelectCommand.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files:
SelectFrequenciesCommand::Apply
bool Apply(const CommandContext &context) override
Definition: SelectCommand.cpp:169
SelectCommand::mSelTime
SelectTimeCommand mSelTime
Definition: SelectCommand.h:128
SelectTimeCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SelectCommand.cpp:66
SelectCommand::mSelFreq
SelectFrequenciesCommand mSelFreq
Definition: SelectCommand.h:129
XO
#define XO(s)
Definition: Internat.h:31
SelectTimeCommand::Apply
bool Apply(const CommandContext &context) override
Definition: SelectCommand.cpp:92
SelectCommand::mSelTracks
SelectTracksCommand mSelTracks
Definition: SelectCommand.h:130
SelectTracksCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SelectCommand.cpp:200
SelectTracksCommand::Apply
bool Apply(const CommandContext &context) override
Definition: SelectCommand.cpp:227
SelectCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: SelectCommand.h:103
SelectFrequenciesCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SelectCommand.cpp:150
SelectFrequenciesCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SelectCommand.cpp:156
SelectTracksCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SelectCommand.cpp:208
SelectTimeCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SelectCommand.cpp:75