Audacity  3.0.3
Classes | Namespaces | Typedefs | Functions
Export.h File Reference
#include <functional>
#include <vector>
#include <wx/filename.h>
#include "Identifier.h"
#include "SampleFormat.h"
#include "../widgets/wxPanelWrapper.h"
#include "FileNames.h"
#include "Registry.h"
Include dependency graph for Export.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  FormatInfo
 
class  ExportPlugin
 
class  Exporter
 
struct  Exporter::RegisteredExportPlugin
 
class  ExportMixerPanel
 Panel that displays mixing for advanced mixing option. More...
 
class  ExportMixerDialog
 Dialog for advanced mixing. More...
 

Namespaces

 BasicUI
 

Typedefs

using WaveTrackConstArray = std::vector< std::shared_ptr< const WaveTrack > >
 
using ExportPluginArray = std::vector< std::unique_ptr< ExportPlugin > >
 

Functions

 wxDECLARE_EXPORTED_EVENT (AUDACITY_DLL_API, AUDACITY_FILE_SUFFIX_EVENT, wxCommandEvent)
 
AUDACITY_DLL_API TranslatableString AudacityExportCaptionStr ()
 
AUDACITY_DLL_API TranslatableString AudacityExportMessageStr ()
 
AUDACITY_DLL_API void ShowExportErrorDialog (wxString ErrorCode, TranslatableString message=AudacityExportMessageStr(), const TranslatableString &caption=AudacityExportCaptionStr())
 
AUDACITY_DLL_API void ShowDiskFullExportErrorDialog (const wxFileNameWrapper &fileName)
 

Typedef Documentation

◆ ExportPluginArray

using ExportPluginArray = std::vector < std::unique_ptr< ExportPlugin > >

Definition at line 155 of file Export.h.

◆ WaveTrackConstArray

using WaveTrackConstArray = std::vector < std::shared_ptr < const WaveTrack > >

Definition at line 38 of file Export.h.

Function Documentation

◆ AudacityExportCaptionStr()

AUDACITY_DLL_API TranslatableString AudacityExportCaptionStr ( )

Definition at line 1502 of file Export.cpp.

1503 {
1504  return XO("Warning");
1505 }

References XO.

◆ AudacityExportMessageStr()

AUDACITY_DLL_API TranslatableString AudacityExportMessageStr ( )

Definition at line 1506 of file Export.cpp.

1507 {
1508  return XO("Unable to export.\nError %s");
1509 }

References XO.

◆ ShowDiskFullExportErrorDialog()

AUDACITY_DLL_API void ShowDiskFullExportErrorDialog ( const wxFileNameWrapper fileName)

Definition at line 1531 of file Export.cpp.

1532 {
1534  XO("Warning"),
1536  "Error:_Disk_full_or_not_writable"
1537  );
1538 }

References BasicUI::ShowErrorDialog(), FileException::WriteFailureMessage(), and XO.

Referenced by ExportFFmpeg::EncodeAudioFrame(), ExportFLAC::Export(), ExportMP3::Export(), and ExportOGG::Export().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ShowExportErrorDialog()

AUDACITY_DLL_API void ShowExportErrorDialog ( wxString  ErrorCode,
TranslatableString  message = AudacityExportMessageStr(),
const TranslatableString caption = AudacityExportCaptionStr() 
)

We have many Export errors that are essentially anonymous and are distinguished only by an error code number. Rather than repeat the code, we have it just once.

Definition at line 1519 of file Export.cpp.

1522 {
1523  using namespace BasicUI;
1524  ShowErrorDialog( {},
1525  caption,
1526  message.Format( ErrorCode ),
1527  "Error:_Unable_to_export", // URL.
1529 }

References TranslatableString::Format(), BasicUI::ModalErrorReport, and BasicUI::ShowErrorDialog().

Referenced by ExportCL::CheckFileName(), ExportFFmpeg::EncodeAudioFrame(), Exporter::ExamineTracks(), ExportFFmpeg::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), and ExportFFmpeg::Finalize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wxDECLARE_EXPORTED_EVENT()

wxDECLARE_EXPORTED_EVENT ( AUDACITY_DLL_API  ,
AUDACITY_FILE_SUFFIX_EVENT  ,
wxCommandEvent   
)
BasicUI::ShowErrorDialog
void ShowErrorDialog(const WindowPlacement &placement, const TranslatableString &dlogTitle, const TranslatableString &message, const ManualPageID &helpPage, const ErrorDialogOptions &options={})
Show an error dialog with a link to the manual for further help.
Definition: BasicUI.h:233
XO
#define XO(s)
Definition: Internat.h:31
BasicUI::ErrorDialogType::ModalErrorReport
@ ModalErrorReport
BasicUI::ErrorDialogOptions
Options for variations of error dialogs; the default is for modal dialogs.
Definition: BasicUI.h:49
BasicUI
Definition: Export.h:39
FileException::WriteFailureMessage
static TranslatableString WriteFailureMessage(const wxFileName &fileName)
Definition: FileException.cpp:60
TranslatableString::Format
TranslatableString & Format(Args &&...args) &
Capture variadic format arguments (by copy) when there is no plural.
Definition: TranslatableString.h:103