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

BriefCommandMessageTarget is a CommandOutputTarget that provides status in a briefer listing. More...

#include <CommandTargets.h>

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

Public Member Functions

 BriefCommandMessageTarget (CommandMessageTarget &target)
 
virtual void StartArray () override
 
virtual void EndArray () override
 
virtual void StartStruct () override
 
virtual void EndStruct () override
 
virtual void AddItem (const wxString &value, const wxString &name={}) override
 
virtual void AddBool (const bool value, const wxString &name={}) override
 
virtual void AddItem (const double value, const wxString &name={}) override
 
virtual void StartField (const wxString &name={}) override
 
virtual void EndField () override
 
- Public Member Functions inherited from CommandMessageTargetDecorator
 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)
 

Additional Inherited Members

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

Detailed Description

BriefCommandMessageTarget is a CommandOutputTarget that provides status in a briefer listing.

Definition at line 134 of file CommandTargets.h.

Constructor & Destructor Documentation

◆ BriefCommandMessageTarget()

BriefCommandMessageTarget::BriefCommandMessageTarget ( CommandMessageTarget target)
inline

Definition at line 137 of file CommandTargets.h.

CommandMessageTargetDecorator(CommandMessageTarget &target)

Member Function Documentation

◆ AddBool()

void BriefCommandMessageTarget::AddBool ( const bool  value,
const wxString &  name = {} 
)
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 230 of file CommandTargets.cpp.

230 {
231 if( mCounts.size() <= 3 )
232 Update( wxString::Format( "%s%s", (mCounts.back()>0)?" ":"",value?"True":"False"));
233 mCounts.back() += 1;
234}
void Update(const wxString &message) override
std::vector< int > mCounts

References CommandMessageTarget::mCounts, and CommandMessageTargetDecorator::Update().

Here is the call graph for this function:

◆ AddItem() [1/2]

virtual void BriefCommandMessageTarget::AddItem ( const double  value,
const wxString &  name = {} 
)
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

◆ AddItem() [2/2]

virtual void BriefCommandMessageTarget::AddItem ( const wxString &  value,
const wxString &  name = {} 
)
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

◆ EndArray()

void BriefCommandMessageTarget::EndArray ( )
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 203 of file CommandTargets.cpp.

203 {
204 if( mCounts.size() > 1 ){
205 mCounts.pop_back();
206 }
207 if( mCounts.size() <= 3 )
208 Update( " " );
209}

References CommandMessageTarget::mCounts, and CommandMessageTargetDecorator::Update().

Here is the call graph for this function:

◆ EndField()

void BriefCommandMessageTarget::EndField ( )
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 246 of file CommandTargets.cpp.

246 {
247 if( mCounts.size() > 1 ){
248 mCounts.pop_back();
249 }
250}

References CommandMessageTarget::mCounts.

◆ EndStruct()

void BriefCommandMessageTarget::EndStruct ( )
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 218 of file CommandTargets.cpp.

218 {
219 if( mCounts.size() > 1 ){
220 mCounts.pop_back();
221 }
222 if( mCounts.size() <= 3 )
223 Update( " " );
224}

References CommandMessageTarget::mCounts, and CommandMessageTargetDecorator::Update().

Here is the call graph for this function:

◆ StartArray()

void BriefCommandMessageTarget::StartArray ( )
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 193 of file CommandTargets.cpp.

194{
195 wxString Padding;
196 Padding.Pad( mCounts.size() *2 -2);
197 if( mCounts.size() <= 3 )
198 Update( wxString::Format( "%s%s ", ( mCounts.back() > 0 ) ? " \n" : "", Padding ));
199 mCounts.back() += 1;
200 mCounts.push_back( 0 );
201}

References CommandMessageTarget::mCounts, and CommandMessageTargetDecorator::Update().

Here is the call graph for this function:

◆ StartField()

void BriefCommandMessageTarget::StartField ( const wxString &  name = {})
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 241 of file CommandTargets.cpp.

241 {
242 mCounts.back() += 1;
243 mCounts.push_back( 0 );
244}

References CommandMessageTarget::mCounts.

◆ StartStruct()

void BriefCommandMessageTarget::StartStruct ( )
overridevirtual

Reimplemented from CommandMessageTargetDecorator.

Definition at line 210 of file CommandTargets.cpp.

210 {
211 wxString Padding;
212 Padding.Pad( mCounts.size() *2 -2);
213 if( mCounts.size() <= 3 )
214 Update( wxString::Format( "%s%s ", ( mCounts.back() > 0 ) ? " \n" : "", Padding ));
215 mCounts.back() += 1;
216 mCounts.push_back( 0 );
217}

References CommandMessageTarget::mCounts, and CommandMessageTargetDecorator::Update().

Here is the call graph for this function:

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