Audacity  2.2.2
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:
CommandMessageTarget BriefCommandMessageTarget LispyCommandMessageTarget ShuttleGetDefinition ShuttleGuiGetDefinition

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 ()
 
wxString Escaped (const wxString &str)
 

Public Attributes

CommandMessageTargetmTarget
 
- Public Attributes inherited from CommandMessageTarget
wxArrayInt 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 95 of file CommandTargets.h.

Constructor & Destructor Documentation

CommandMessageTargetDecorator::CommandMessageTargetDecorator ( CommandMessageTarget target)
inline

Definition at line 98 of file CommandTargets.h.

98 : mTarget(target) {}
CommandMessageTarget & mTarget
CommandMessageTargetDecorator::~CommandMessageTargetDecorator ( )
inlineoverride

Definition at line 99 of file CommandTargets.h.

99 { }

Member Function Documentation

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

Reimplemented from CommandMessageTarget.

Reimplemented in BriefCommandMessageTarget, and LispyCommandMessageTarget.

Definition at line 107 of file CommandTargets.h.

References CommandMessageTarget::AddBool(), mTarget, and name.

Referenced by ShuttleGuiGetDefinition::TieCheckBox(), and ShuttleGuiGetDefinition::TieCheckBoxOnRight().

108  { mTarget.AddBool(value,name);}
CommandMessageTarget & mTarget
const wxChar * name
Definition: Distortion.cpp:94
virtual void AddBool(const bool value, const wxString &name="")
void CommandMessageTargetDecorator::AddItem ( const wxString &  value,
const wxString &  name = "" 
)
inlineoverridevirtual
void CommandMessageTargetDecorator::AddItem ( const double  value,
const wxString &  name = "" 
)
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in BriefCommandMessageTarget, and LispyCommandMessageTarget.

Definition at line 109 of file CommandTargets.h.

References CommandMessageTarget::AddItem(), mTarget, and name.

110  { mTarget.AddItem(value,name);}
CommandMessageTarget & mTarget
virtual void AddItem(const wxString &value, const wxString &name="")
const wxChar * name
Definition: Distortion.cpp:94
void CommandMessageTargetDecorator::EndArray ( )
inlineoverridevirtual
void CommandMessageTargetDecorator::EndField ( )
inlineoverridevirtual
void CommandMessageTargetDecorator::EndStruct ( )
inlineoverridevirtual
void CommandMessageTargetDecorator::Flush ( )
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Definition at line 115 of file CommandTargets.h.

References CommandMessageTarget::Flush(), and mTarget.

116  { mTarget.Flush();}
CommandMessageTarget & mTarget
virtual void Flush()
void CommandMessageTargetDecorator::StartArray ( )
inlineoverridevirtual
void CommandMessageTargetDecorator::StartField ( const wxString &  name = "")
inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Reimplemented in BriefCommandMessageTarget, and LispyCommandMessageTarget.

Definition at line 111 of file CommandTargets.h.

References mTarget, name, and CommandMessageTarget::StartField().

Referenced by ShuttleGetDefinition::DefineEnum(), and ShuttleGuiGetDefinition::TieChoice().

112  { mTarget.StartField(name);}
CommandMessageTarget & mTarget
virtual void StartField(const wxString &name="")
const wxChar * name
Definition: Distortion.cpp:94
void CommandMessageTargetDecorator::StartStruct ( )
inlineoverridevirtual
void CommandMessageTargetDecorator::Update ( const wxString &  message)
inlineoverridevirtual

Member Data Documentation

CommandMessageTarget& CommandMessageTargetDecorator::mTarget

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