Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
SnapRegistryItem Struct Referenceabstract

#include <SnapUtils.h>

Inheritance diagram for SnapRegistryItem:
[legend]
Collaboration diagram for SnapRegistryItem:
[legend]

Public Member Functions

 SnapRegistryItem (const Identifier &internalName, const TranslatableString &label)
 
 ~SnapRegistryItem () override
 
virtual SnapResult Snap (const AudacityProject &project, double time, bool nearest) const =0
 
virtual SnapResult SingleStep (const AudacityProject &project, double time, bool upwards) const =0
 
- Public Member Functions inherited from Registry::SingleItem
 ~SingleItem () override=0
 
- Public Member Functions inherited from Registry::detail::BaseItem
 BaseItem (const Identifier &internalName)
 
virtual ~BaseItem ()
 

Public Attributes

const TranslatableString label
 
- Public Attributes inherited from Registry::detail::BaseItem
const Identifier name
 
OrderingHint orderingHint
 

Detailed Description

Definition at line 76 of file SnapUtils.h.

Constructor & Destructor Documentation

◆ SnapRegistryItem()

SnapRegistryItem::SnapRegistryItem ( const Identifier internalName,
const TranslatableString label 
)

Definition at line 174 of file SnapUtils.cpp.

176 : SingleItem { internalName }
177 , label { _label }
178{
179}
const TranslatableString label
Definition: SnapUtils.h:82

◆ ~SnapRegistryItem()

SnapRegistryItem::~SnapRegistryItem ( )
override

Definition at line 181 of file SnapUtils.cpp.

182{
183}

Member Function Documentation

◆ SingleStep()

virtual SnapResult SnapRegistryItem::SingleStep ( const AudacityProject project,
double  time,
bool  upwards 
) const
pure virtual

◆ Snap()

virtual SnapResult SnapRegistryItem::Snap ( const AudacityProject project,
double  time,
bool  nearest 
) const
pure virtual

Member Data Documentation

◆ label

const TranslatableString SnapRegistryItem::label

Definition at line 82 of file SnapUtils.h.


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