Audacity 3.2.0
Classes | Typedefs | Enumerations
ProjectFileIOExtension.h File Reference
#include <cstdint>
#include <functional>
#include <string>
Include dependency graph for ProjectFileIOExtension.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  ProjectFileIOExtension
 Set of hooks for project file I/O. More...
 
struct  ProjectFileIOExtensionRegistry
 Extension registry for project file I/O extensions. More...
 
struct  ProjectFileIOExtensionRegistry::Extension
 

Typedefs

using ProjectSaveCallback = std::function< bool(const std::string &path, bool nameChanged)>
 

Enumerations

enum class  OnSaveAction { Handled , Cancelled , Continue }
 Action the ProjectManager should take after the save hooks were called. More...
 
enum class  OnCloseAction { Veto , Continue }
 Action the ProjectManager should take after the close hooks were called. More...
 
enum class  OnOpenAction { Cancel , Continue }
 Action the ProjectManager should take after the open hooks were called. More...
 

Typedef Documentation

◆ ProjectSaveCallback

using ProjectSaveCallback = std::function<bool(const std::string& path, bool nameChanged)>

Definition at line 20 of file ProjectFileIOExtension.h.

Enumeration Type Documentation

◆ OnCloseAction

enum class OnCloseAction
strong

Action the ProjectManager should take after the close hooks were called.

Enumerator
Veto 

Extension vetoed the close.

Continue 

Extension did not veto the close.

Definition at line 35 of file ProjectFileIOExtension.h.

36{
38 Veto,
41};
@ Veto
Extension vetoed the close.

◆ OnOpenAction

enum class OnOpenAction
strong

Action the ProjectManager should take after the open hooks were called.

Enumerator
Cancel 

Open was cancelled by the extension.

Continue 

ProjectManager should continue with the open.

Definition at line 44 of file ProjectFileIOExtension.h.

◆ OnSaveAction

enum class OnSaveAction
strong

Action the ProjectManager should take after the save hooks were called.

Enumerator
Handled 

Save was handled by the extension.

Cancelled 

Save was cancelled by the extension.

Continue 

Save was not handled by the extension.

Definition at line 24 of file ProjectFileIOExtension.h.

25{
27 Handled,
32};
@ Handled
Save was handled by the extension.