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

CommandMessageTargetDecorator is a CommandOutputTarget that forwards its work on to another one. Typically we derive from it to modify some functionality and forward the rest. More...

#include <CommandTargets.h>

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

Public Member Functions

 CommandMessageTargetDecorator (CommandMessageTarget &target)
 
 ~CommandMessageTargetDecorator () override
 
void Update (const wxString &message) override
 
void StartArray () override
 
void EndArray () override
 
void StartStruct () override
 
void EndStruct () override
 
void AddItem (const wxString &value, const wxString &name={}) override
 
void AddBool (const bool value, const wxString &name={}) override
 
void AddItem (const double value, const wxString &name={}) override
 
void StartField (const wxString &name={}) override
 
void EndField () override
 
void Flush () override
 
- Public Member Functions inherited from CommandMessageTarget
 CommandMessageTarget ()
 
virtual ~CommandMessageTarget ()
 
virtual void Update (const wxString &message)=0
 
virtual void StartArray ()
 
virtual void EndArray ()
 
virtual void StartStruct ()
 
virtual void EndStruct ()
 
virtual void AddItem (const wxString &value, const wxString &name={})
 
virtual void AddBool (const bool value, const wxString &name={})
 
virtual void AddItem (const double value, const wxString &name={})
 
virtual void StartField (const wxString &name={})
 
virtual void EndField ()
 
virtual void Flush ()
 
wxString Escaped (const wxString &str)
 

Public Attributes

CommandMessageTargetmTarget
 
- Public Attributes inherited from CommandMessageTarget
std::vector< int > mCounts
 

Detailed Description

CommandMessageTargetDecorator is a CommandOutputTarget that forwards its work on to another one. Typically we derive from it to modify some functionality and forward the rest.

Definition at line 94 of file CommandTargets.h.

Constructor & Destructor Documentation

◆ CommandMessageTargetDecorator()

CommandMessageTargetDecorator::CommandMessageTargetDecorator ( CommandMessageTarget target)
inline

Definition at line 97 of file CommandTargets.h.

97: mTarget(target) {}
CommandMessageTarget & mTarget

◆ ~CommandMessageTargetDecorator()

CommandMessageTargetDecorator::~CommandMessageTargetDecorator ( )
inlineoverride

Definition at line 98 of file CommandTargets.h.

98{ }

Member Function Documentation

◆ AddBool()

void CommandMessageTargetDecorator::AddBool ( const bool  value,
const wxString &  name = {} 
)
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 106 of file CommandTargets.h.

106 {} ) override
107 { mTarget.AddBool(value,name);}
const TranslatableString name
Definition: Distortion.cpp:74
virtual void AddBool(const bool value, const wxString &name={})

Referenced by anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBox(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBoxOnRight().

Here is the caller graph for this function:

◆ AddItem() [1/2]

void CommandMessageTargetDecorator::AddItem ( const double  value,
const wxString &  name = {} 
)
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 108 of file CommandTargets.h.

108 {} ) override
109 { mTarget.AddItem(value,name);}
virtual void AddItem(const wxString &value, const wxString &name={})

◆ AddItem() [2/2]

void CommandMessageTargetDecorator::AddItem ( const wxString &  value,
const wxString &  name = {} 
)
inlineoverridevirtual

◆ EndArray()

void CommandMessageTargetDecorator::EndArray ( )
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 101 of file CommandTargets.h.

101{ mTarget.EndArray();}
virtual void EndArray()

References CommandMessageTarget::EndArray(), and mTarget.

Referenced by ShuttleGetDefinition::DefineEnum(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EndField()

void CommandMessageTargetDecorator::EndField ( )
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 112 of file CommandTargets.h.

113 { mTarget.EndField();}
virtual void EndField()

References CommandMessageTarget::EndField(), and mTarget.

Referenced by ShuttleGetDefinition::DefineEnum(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EndStruct()

void CommandMessageTargetDecorator::EndStruct ( )
inlineoverridevirtual

◆ Flush()

void CommandMessageTargetDecorator::Flush ( )
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Definition at line 114 of file CommandTargets.h.

115 { mTarget.Flush();}

References CommandMessageTarget::Flush(), and mTarget.

Here is the call graph for this function:

◆ StartArray()

void CommandMessageTargetDecorator::StartArray ( )
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 100 of file CommandTargets.h.

virtual void StartArray()

References mTarget, and CommandMessageTarget::StartArray().

Referenced by ShuttleGetDefinition::DefineEnum(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StartField()

void CommandMessageTargetDecorator::StartField ( const wxString &  name = {})
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 110 of file CommandTargets.h.

110 {} ) override
virtual void StartField(const wxString &name={})

Referenced by ShuttleGetDefinition::DefineEnum(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the caller graph for this function:

◆ StartStruct()

void CommandMessageTargetDecorator::StartStruct ( )
inlineoverridevirtual

◆ Update()

void CommandMessageTargetDecorator::Update ( const wxString &  message)
inlineoverridevirtual

Implements CommandMessageTarget.

Definition at line 99 of file CommandTargets.h.

99{ mTarget.Update( message );}
virtual void Update(const wxString &message)=0

References mTarget, and CommandMessageTarget::Update().

Referenced by LispyCommandMessageTarget::AddBool(), BriefCommandMessageTarget::AddBool(), LispyCommandMessageTarget::AddItem(), LispyCommandMessageTarget::EndArray(), BriefCommandMessageTarget::EndArray(), LispyCommandMessageTarget::EndField(), LispyCommandMessageTarget::EndStruct(), BriefCommandMessageTarget::EndStruct(), LispyCommandMessageTarget::StartArray(), BriefCommandMessageTarget::StartArray(), LispyCommandMessageTarget::StartField(), LispyCommandMessageTarget::StartStruct(), and BriefCommandMessageTarget::StartStruct().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ mTarget

CommandMessageTarget& CommandMessageTargetDecorator::mTarget

Definition at line 116 of file CommandTargets.h.

Referenced by EndArray(), EndField(), EndStruct(), Flush(), StartArray(), StartStruct(), and Update().


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