Audacity 3.2.0
Public Member Functions | List of all members
ProjectFileIOExtension Class Referenceabstract

Set of hooks for project file I/O. More...

#include <ProjectFileIOExtension.h>

Inheritance diagram for ProjectFileIOExtension:
[legend]

Public Member Functions

virtual ~ProjectFileIOExtension ()
 
virtual OnOpenAction OnOpen (AudacityProject &project, const std::string &path)=0
 This hook is called before the project is opened. More...
 
virtual void OnLoad (AudacityProject &project)=0
 This hook is called after the project is loaded. More...
 
virtual OnSaveAction OnSave (AudacityProject &project, const ProjectSaveCallback &projectSaveCallback)=0
 This hook is called before the project is saved. More...
 
virtual OnCloseAction OnClose (AudacityProject &project)=0
 This hook is called before the project is closed. More...
 
virtual void OnUpdateSaved (AudacityProject &project, const ProjectSerializer &serializer)=0
 This hook is called after the project blob is saved. More...
 
virtual bool IsBlockLocked (const AudacityProject &project, int64_t blockId) const =0
 This hook is called to check if a block is locked. More...
 

Detailed Description

Set of hooks for project file I/O.

Definition at line 53 of file ProjectFileIOExtension.h.

Constructor & Destructor Documentation

◆ ~ProjectFileIOExtension()

ProjectFileIOExtension::~ProjectFileIOExtension ( )
virtualdefault

Member Function Documentation

◆ IsBlockLocked()

virtual bool ProjectFileIOExtension::IsBlockLocked ( const AudacityProject project,
int64_t  blockId 
) const
pure virtual

This hook is called to check if a block is locked.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.

◆ OnClose()

virtual OnCloseAction ProjectFileIOExtension::OnClose ( AudacityProject project)
pure virtual

This hook is called before the project is closed.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.

◆ OnLoad()

virtual void ProjectFileIOExtension::OnLoad ( AudacityProject project)
pure virtual

This hook is called after the project is loaded.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.

◆ OnOpen()

virtual OnOpenAction ProjectFileIOExtension::OnOpen ( AudacityProject project,
const std::string &  path 
)
pure virtual

This hook is called before the project is opened.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.

◆ OnSave()

virtual OnSaveAction ProjectFileIOExtension::OnSave ( AudacityProject project,
const ProjectSaveCallback projectSaveCallback 
)
pure virtual

This hook is called before the project is saved.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.

◆ OnUpdateSaved()

virtual void ProjectFileIOExtension::OnUpdateSaved ( AudacityProject project,
const ProjectSerializer serializer 
)
pure virtual

This hook is called after the project blob is saved.

Implemented in anonymous_namespace{CloudProjectFileIOExtensions.cpp}::IOExtension.


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