Provides Static functions to yield filenames. More...

Public Types
enum class	Operation { _None , Temp , Presets , Open , Save , Import , Export , MacrosOut }

enum class	PathType { _None , User , LastUsed }

using	FileTypes = std::vector< FileType >

Public Attributes
FILES_API const FileType	AllFiles { XO("All files"), { wxT("") } }

FILES_API const FileType	AudacityProjects { XO("AUP3 project files"), { wxT("aup3") }, true }

FILES_API const FileType	DynamicLibraries

FILES_API const FileType	TextFiles { XO("Text files"), { wxT("txt") }, true }

FILES_API const FileType	XMLFiles { XO("XML files"), { wxT("xml"), wxT("XML") }, true }

Detailed Description

Provides Static functions to yield filenames.

This class helps us with setting a base path, and makes it easier for us to keep track of the different kinds of files we read and write from.

JKC: In time I plan to add all file names and file extensions used throughout Audacity into this one place.

Member Typedef Documentation

◆ FileTypes

using FileNames::FileTypes = std::vector< FileType >

Definition at line 75 of file FileNames.h.

Member Enumeration Documentation

◆ Operation

enum class FileNames::Operation

strong

Enumerator
_None
Temp
Presets
Open
Save
Import
Export
MacrosOut

Definition at line 161 of file FileNames.h.

                        {
      // _ on None to defeat some macro that is expanding this.
      _None,
 
      // These do not have a specific pathtype
      Temp,
      Presets,
 
      // These have default/lastused pathtypes
      Open,
      Save,
      Import,
      Export,
      MacrosOut
   };

◆ PathType

enum class FileNames::PathType

strong

Enumerator
_None
User
LastUsed

Definition at line 177 of file FileNames.h.

                       {
      // _ on None to defeat some macro that is expanding this.
      _None,
      User,
      LastUsed
   };

Member Data Documentation

◆ AllFiles

const FileNames::FileType FileNames::AllFiles { XO("All files"), { wxT("") } }

Definition at line 69 of file FileNames.h.

Referenced by FileTypes(), Importer::GetFileTypes(), MP3Exporter::GetLibraryTypes(), ExportOptionsCLEditor::OnBrowse(), FindFFmpegDialog::OnBrowse(), KeyConfigPrefs::OnExport(), ContrastDialog::OnExport(), FrequencyPlotDialog::OnExport(), KeyConfigPrefs::OnImport(), LabelDialog::OnImport(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), anonymous_namespace{ImportMIDI.cpp}::OnImportMIDI(), PresetTypes(), and VerifyFilename().

◆ AudacityProjects

const FileNames::FileType FileNames::AudacityProjects { XO("AUP3 project files"), { wxT("aup3") }, true }

Definition at line 70 of file FileNames.h.

Referenced by Importer::GetFileTypes(), TimerRecordDialog::OnAutoSavePathButton_Click(), ProjectFileManager::SaveAs(), and ProjectFileManager::SaveCopy().

◆ DynamicLibraries

const FileNames::FileType FileNames::DynamicLibraries

Initial value:

{
 
      XO("Dynamically Linked Libraries"), { wxT("dll") }, true
 
     }

Definition at line 71 of file FileNames.h.

Referenced by MP3Exporter::GetLibraryTypes(), and FindFFmpegDialog::OnBrowse().

◆ TextFiles

const FileNames::FileType FileNames::TextFiles { XO("Text files"), { wxT("txt") }, true }

Definition at line 72 of file FileNames.h.

Referenced by ContrastDialog::OnExport(), FrequencyPlotDialog::OnExport(), LabelDialog::OnExport(), anonymous_namespace{FileMenus.cpp}::OnExportLabels(), LabelDialog::OnImport(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), BenchmarkDialog::OnSave(), anonymous_namespace{LogWindow.cpp}::OnSave(), MacroCommands::ReadMacro(), ShowDiagnostics(), and MacroCommands::WriteMacro().

◆ XMLFiles

const FileNames::FileType FileNames::XMLFiles { XO("XML files"), { wxT("xml"), wxT("XML") }, true }

Definition at line 73 of file FileNames.h.

Referenced by FileTypes(), KeyConfigPrefs::OnExport(), KeyConfigPrefs::OnImport(), TagsEditorDialog::OnLoad(), TagsEditorDialog::OnSave(), and XMLtypes().

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

Public Types

Public Attributes