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
namespace	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(), bool allowReporting=true)
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 1503 of file Export.cpp.

{
   return XO("Warning");
}

References XO.

Referenced by Exporter::ExamineTracks().

Here is the caller graph for this function:

AudacityExportMessageStr()

AUDACITY_DLL_API TranslatableString AudacityExportMessageStr

(

)

Definition at line 1507 of file Export.cpp.

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

References XO.

ShowDiskFullExportErrorDialog()

AUDACITY_DLL_API void ShowDiskFullExportErrorDialog

(

const wxFileNameWrapper &

fileName

)

Definition at line 1533 of file Export.cpp.

{
   BasicUI::ShowErrorDialog( {},
      XO("Warning"),
      FileException::WriteFailureMessage(fileName),
      "Error:_Disk_full_or_not_writable"
   );
}

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(),
		bool	allowReporting = true
	)

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 1520 of file Export.cpp.

{
   using namespace BasicUI;
   ShowErrorDialog( {},
      caption,
      message.Format( ErrorCode ),
      "Error:_Unable_to_export", // URL.
      ErrorDialogOptions { allowReporting ? ErrorDialogType::ModalErrorReport : ErrorDialogType::ModalError });
}

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

Referenced by ExportCL::CheckFileName(), ExportFFmpeg::EncodeAudioFrame(), Exporter::ExamineTracks(), ExportFFmpeg::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), ExportWavPack::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
	)