Audacity 3.2.0
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 () const override
 
TranslatableString GetDescription () const override
 
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
 
bool VisitSettings (SettingsVisitor &S) override
 
bool VisitSettings (ConstSettingsVisitor &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 () const override
 
VendorSymbol GetVendor () const override
 
wxString GetVersion () const override
 
ComponentInterfaceSymbol GetSymbol () const override=0
 
virtual TranslatableString GetDescription () const override
 
virtual ManualPageID ManualPage ()
 
virtual bool IsBatchProcessing () const
 
virtual void SetBatchProcessing (bool start)
 
virtual bool Apply (const CommandContext &WXUNUSED(context))
 
bool ShowInterface (wxWindow *parent, bool forceModal=false)
 
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
 
bool SaveSettingsAsString (wxString &parms)
 
bool LoadSettingsFromString (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 ()
 
virtual bool VisitSettings (SettingsVisitor &)
 
virtual bool VisitSettings (ConstSettingsVisitor &)
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 

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 }
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 

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 106 of file SelectCommand.h.

Member Function Documentation

◆ Apply()

bool SelectCommand::Apply ( const CommandContext context)
inlineoverride

Definition at line 122 of file SelectCommand.h.

122 {
123 return
124 mSelTime.Apply(context) &&
125 mSelFreq.Apply( context )&&
126 mSelTracks.Apply(context);
127 }
SelectFrequenciesCommand mSelFreq
SelectTracksCommand mSelTracks
SelectTimeCommand mSelTime
bool Apply(const CommandContext &context) override
bool Apply(const CommandContext &context) override
bool Apply(const CommandContext &context) override

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

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SelectCommand::GetDescription ( ) const
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 113 of file SelectCommand.h.

113{return XO("Selects Audio.");};
#define XO(s)
Definition: Internat.h:31

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol SelectCommand::GetSymbol ( ) const
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 112 of file SelectCommand.h.

112{return Symbol;};
static const ComponentInterfaceSymbol Symbol

References Symbol.

◆ ManualPage()

ManualPageID SelectCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 129 of file SelectCommand.h.

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

◆ PopulateOrExchange()

void SelectCommand::PopulateOrExchange ( ShuttleGui S)
inlineoverride

Definition at line 117 of file SelectCommand.h.

117 {
121 };
#define S(N)
Definition: ToChars.cpp:64
void PopulateOrExchange(ShuttleGui &S) override
void PopulateOrExchange(ShuttleGui &S) override
void PopulateOrExchange(ShuttleGui &S) override

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

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool SelectCommand::VisitSettings ( ConstSettingsVisitor )
overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 311 of file SelectCommand.cpp.

312{
313 return VisitSettings<true>(S);
314}

References S.

◆ VisitSettings() [2/3]

bool SelectCommand::VisitSettings ( SettingsVisitor )
overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 306 of file SelectCommand.cpp.

307{
308 return VisitSettings<false>(S);
309}

References S.

◆ VisitSettings() [3/3]

template<bool Const>
bool SelectCommand::VisitSettings ( SettingsVisitorBase< Const > &  S)

Definition at line 298 of file SelectCommand.cpp.

299{
300 return
304}
bool VisitSettings(SettingsVisitorBase< Const > &S)
bool VisitSettings(SettingsVisitorBase< Const > &S)
bool VisitSettings(SettingsVisitorBase< Const > &S)

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

Here is the call graph for this function:

Member Data Documentation

◆ mSelFreq

SelectFrequenciesCommand SelectCommand::mSelFreq
private

Definition at line 132 of file SelectCommand.h.

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

◆ mSelTime

SelectTimeCommand SelectCommand::mSelTime
private

Definition at line 131 of file SelectCommand.h.

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

◆ mSelTracks

SelectTracksCommand SelectCommand::mSelTracks
private

Definition at line 133 of file SelectCommand.h.

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

◆ Symbol

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

Definition at line 109 of file SelectCommand.h.

Referenced by GetSymbol().


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