Audacity  3.0.3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ImportCommand Class Reference

Command for importing audio. More...

#include <ImportExportCommands.h>

Inheritance diagram for ImportCommand:
[legend]
Collaboration diagram for ImportCommand:
[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))
 

Public Attributes

wxString mFileName
 

Static Public Attributes

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

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 importing audio.

Definition at line 26 of file ImportExportCommands.h.

Member Function Documentation

◆ Apply()

bool ImportCommand::Apply ( const CommandContext context)
override

Definition at line 52 of file ImportExportCommands.cpp.

53 {
54  bool wasEmpty = TrackList::Get( context.project ).Any().empty();
55  bool success = ProjectFileManager::Get( context.project )
56  .Import(mFileName, false);
57 
58  if (success && wasEmpty)
59  {
61  }
62 
63  return success;
64 }

References TrackList::Any(), ProjectFileManager::Get(), TrackList::Get(), ProjectFileManager::Import(), mFileName, CommandContext::project, and SelectUtilities::SelectAllIfNone().

Here is the call graph for this function:

◆ DefineParams()

bool ImportCommand::DefineParams ( ShuttleParams S)
override

Definition at line 36 of file ImportExportCommands.cpp.

36  {
37  S.Define( mFileName, wxT("Filename"), "" );
38  return true;
39 }

References ShuttleParams::Define(), and mFileName.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString ImportCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 33 of file ImportExportCommands.h.

33 {return XO("Imports from a file.");};

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol ImportCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 32 of file ImportExportCommands.h.

32 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID ImportCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 39 of file ImportExportCommands.h.

39 {return L"Extra_Menu:_Scriptables_II#import";}

◆ PopulateOrExchange()

void ImportCommand::PopulateOrExchange ( ShuttleGui S)
override

Definition at line 41 of file ImportExportCommands.cpp.

42 {
43  S.AddSpace(0, 5);
44 
45  S.StartMultiColumn(2, wxALIGN_CENTER);
46  {
47  S.TieTextBox(XXO("File Name:"),mFileName);
48  }
49  S.EndMultiColumn();
50 }

References ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), mFileName, ShuttleGuiBase::StartMultiColumn(), ShuttleGuiBase::TieTextBox(), and XXO.

Here is the call graph for this function:

Member Data Documentation

◆ mFileName

wxString ImportCommand::mFileName

Definition at line 41 of file ImportExportCommands.h.

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

◆ Symbol

const ComponentInterfaceSymbol ImportCommand::Symbol { XO("Import2") }
static

Definition at line 29 of file ImportExportCommands.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files:
ImportCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: ImportExportCommands.h:29
ShuttleGui::AddSpace
wxSizerItem * AddSpace(int width, int height, int prop=0)
Definition: ShuttleGui.cpp:2459
XO
#define XO(s)
Definition: Internat.h:31
ShuttleGuiBase::EndMultiColumn
void EndMultiColumn()
Definition: ShuttleGui.cpp:1238
ShuttleGuiBase::TieTextBox
wxTextCtrl * TieTextBox(const TranslatableString &Caption, wxString &Value, const int nChars=0)
Definition: ShuttleGui.cpp:1652
XXO
#define XXO(s)
Definition: Internat.h:44
ImportCommand::mFileName
wxString mFileName
Definition: ImportExportCommands.h:41
ProjectFileManager::Get
static ProjectFileManager & Get(AudacityProject &project)
Definition: ProjectFileManager.cpp:66
ShuttleGuiBase::StartMultiColumn
void StartMultiColumn(int nCols, int PositionFlags=wxALIGN_LEFT)
Definition: ShuttleGui.cpp:1229
SelectUtilities::SelectAllIfNone
void SelectAllIfNone(AudacityProject &project)
Definition: SelectUtilities.cpp:85
TrackList::Get
static TrackList & Get(AudacityProject &project)
Definition: Track.cpp:506
ProjectFileManager::Import
bool Import(const FilePath &fileName, bool addToHistory=true)
Definition: ProjectFileManager.cpp:1207
ShuttleParams::Define
virtual void Define(bool &var, const wxChar *key, const bool vdefault, const bool vmin=false, const bool vmax=false, const bool vscl=false)
Definition: Shuttle.cpp:332
TrackList::Any
auto Any() -> TrackIterRange< TrackType >
Definition: Track.h:1371
CommandContext::project
AudacityProject & project
Definition: CommandContext.h:64