ProjectFileIOExtensionRegistry Struct Reference

Extension registry for project file I/O extensions. More...

#include <ProjectFileIOExtension.h>

Classes
struct	Extension

Static Public Member Functions
static OnOpenAction	OnOpen (AudacityProject &project, const std::string &path)
static void	OnLoad (AudacityProject &project)
static OnSaveAction	OnSave (AudacityProject &project, const ProjectSaveCallback &projectSaveCallback)
static OnCloseAction	OnClose (AudacityProject &project)
static void	OnUpdateSaved (AudacityProject &project, const ProjectSerializer &serializer)
static bool	IsBlockLocked (const AudacityProject &project, int64_t blockId)

Detailed Description

Extension registry for project file I/O extensions.

Definition at line 78 of file ProjectFileIOExtension.h.

Member Function Documentation

IsBlockLocked()

bool ProjectFileIOExtensionRegistry::IsBlockLocked ( const AudacityProject &  project, int64_t  blockId  )

static

Definition at line 79 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
   {
      if (extension->IsBlockLocked(project, blockId))
         return true;
   }
 
   return false;
}

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), and project.

Referenced by ProjectFileIO::InSet().

Here is the call graph for this function:

Here is the caller graph for this function:

OnClose()

OnCloseAction ProjectFileIOExtensionRegistry::OnClose ( AudacityProject &  project )

static

Definition at line 61 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
   {
      if (extension->OnClose(project) == OnCloseAction::Veto)
         return OnCloseAction::Veto;
   }
 
   return OnCloseAction::Continue;
}

References Continue, anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), project, and Veto.

Referenced by ProjectManager::OnCloseWindow(), and ProjectFileManager::SaveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

OnLoad()

void ProjectFileIOExtensionRegistry::OnLoad ( AudacityProject &  project )

static

Definition at line 42 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
      extension->OnLoad(project);
}

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), and project.

Referenced by ProjectFileManager::ReadProjectFile().

Here is the call graph for this function:

Here is the caller graph for this function:

OnOpen()

OnOpenAction ProjectFileIOExtensionRegistry::OnOpen ( AudacityProject &  project, const std::string &  path  )

static

Definition at line 32 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
      if (extension->OnOpen(project, path) == OnOpenAction::Cancel)
         return OnOpenAction::Cancel;
 
   return OnOpenAction::Continue;
}

References Cancel, Continue, anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), and project.

Referenced by ProjectFileManager::OpenProjectFile().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSave()

OnSaveAction ProjectFileIOExtensionRegistry::OnSave ( AudacityProject &  project, const ProjectSaveCallback &  projectSaveCallback  )

static

Definition at line 48 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
   {
      if (auto action = extension->OnSave(project, projectSaveCallback);
          action != OnSaveAction::Continue)
         return action;
   }
 
   return OnSaveAction::Continue;
}

References Continue, anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), and project.

Referenced by ProjectFileManager::Save().

Here is the call graph for this function:

Here is the caller graph for this function:

OnUpdateSaved()

void ProjectFileIOExtensionRegistry::OnUpdateSaved ( AudacityProject &  project, const ProjectSerializer &  serializer  )

static

Definition at line 72 of file ProjectFileIOExtension.cpp.

{
   for (auto& extension : GetExtensions())
      extension->OnUpdateSaved(project, serializer);
}

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, anonymous_namespace{ProjectFileIOExtension.cpp}::GetExtensions(), and project.

Referenced by ProjectFileIO::UpdateSaved().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• ProjectFileIOExtension.h
• ProjectFileIOExtension.cpp