Audacity  3.0.3
Public Types | Public Attributes | List of all members
FileNames Class Reference

Provides Static functions to yield filenames. More...

Public Types

enum  Operation {
  Operation::_None, Operation::Temp, Operation::Presets, Operation::Open,
  Operation::Save, Operation::Import, Operation::Export, Operation::MacrosOut
}
 
enum  PathType { PathType::_None, PathType::User, PathType::LastUsed }
 
using FileTypes = std::vector< FileType >
 

Public Attributes

AUDACITY_DLL_API const FileType AllFiles { XO("All files"), { wxT("") } }
 
AUDACITY_DLL_API const FileType AudacityProjects { XO("AUP3 project files"), { wxT("aup3") }, true }
 
AUDACITY_DLL_API const FileType DynamicLibraries
 
AUDACITY_DLL_API const FileType TextFiles { XO("Text files"), { wxT("txt") }, true }
 
AUDACITY_DLL_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 79 of file FileNames.h.

Member Enumeration Documentation

◆ Operation

enum FileNames::Operation
strong
Enumerator
_None 
Temp 
Presets 
Open 
Save 
Import 
Export 
MacrosOut 

Definition at line 157 of file FileNames.h.

157  {
158  // _ on None to defeat some macro that is expanding this.
159  _None,
160 
161  // These do not have a specific pathtype
162  Temp,
163  Presets,
164 
165  // These have default/lastused pathtypes
166  Open,
167  Save,
168  Import,
169  Export,
170  MacrosOut
171  };

◆ PathType

enum FileNames::PathType
strong
Enumerator
_None 
User 
LastUsed 

Definition at line 173 of file FileNames.h.

173  {
174  // _ on None to defeat some macro that is expanding this.
175  _None,
176  User,
177  LastUsed
178  };

Member Data Documentation

◆ AllFiles

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

◆ AudacityProjects

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

◆ DynamicLibraries

const FileNames::FileType FileNames::DynamicLibraries
Initial value:
{
XO("Dynamically Linked Libraries"), { wxT("so*") }, true
}

Definition at line 75 of file FileNames.h.

Referenced by FFmpegLibs::GetLibraryTypes().

◆ TextFiles

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

◆ XMLFiles

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

The documentation for this class was generated from the following files:
XO
#define XO(s)
Definition: Internat.h:31
Export
Main class to control the export function.