Audacity 3.2.0
Public Member Functions | List of all members
ChannelAttachment Class Reference

#include <ChannelAttachments.h>

Inheritance diagram for ChannelAttachment:
[legend]

Public Member Functions

virtual ~ChannelAttachment ()
 
virtual void CopyTo (Track &track, size_t iChannel) const
 Copy state, for undo/redo purposes. More...
 
virtual void Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
 Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
 
virtual void WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
 Serialize persistent attributes. More...
 
virtual bool HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
 Deserialize an attribute, returning true if recognized. More...
 

Detailed Description

Like the TrackAttachment interface, but member functions take an extra argument choosing the channel

Definition at line 20 of file ChannelAttachments.h.

Constructor & Destructor Documentation

◆ ~ChannelAttachment()

ChannelAttachment::~ChannelAttachment ( )
virtualdefault

Member Function Documentation

◆ CopyTo()

void ChannelAttachment::CopyTo ( Track track,
size_t  iChannel 
) const
virtual

Copy state, for undo/redo purposes.

Parameters
iChannelposition of the attachment's channel in the group The default does nothing

Reimplemented in LabelTrackView, WaveChannelView, and ChannelView.

Definition at line 24 of file ChannelAttachments.cpp.

25{
26}

◆ HandleXMLAttribute()

bool ChannelAttachment::HandleXMLAttribute ( const std::string_view &  attr,
const XMLAttributeValueView valueView,
size_t  iChannel 
)
virtual

Deserialize an attribute, returning true if recognized.

default recognizes no attributes, and returns false

Reimplemented in ChannelView.

Definition at line 36 of file ChannelAttachments.cpp.

38{
39 return false;
40}

◆ Reparent()

void ChannelAttachment::Reparent ( const std::shared_ptr< Track > &  parent,
size_t  iChannel 
)
virtual

Object may be shared among tracks but hold a special back-pointer to one of them; reassign it.

Parameters
iChannelposition of the attachment's channel in the group The default does nothing

Reimplemented in LabelTrackView, WaveChannelView, ChannelView, and CommonChannelCell.

Definition at line 28 of file ChannelAttachments.cpp.

29{
30}

◆ WriteXMLAttributes()

void ChannelAttachment::WriteXMLAttributes ( XMLWriter writer,
size_t  iChannel 
) const
virtual

Serialize persistent attributes.

default does nothing

Reimplemented in ChannelView.

Definition at line 32 of file ChannelAttachments.cpp.

33{
34}

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