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

#include <OpenSaveCommands.h>

Inheritance diagram for ClearLogCommand:
Collaboration diagram for ClearLogCommand:

Public Member Functions

ComponentInterfaceSymbol GetSymbol () const override
TranslatableString GetDescription () const override
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
bool VisitSettings (SettingsVisitor &S) override
bool VisitSettings (ConstSettingsVisitor &S) override
bool PromptUser (wxWindow *parent) override
bool Apply (const CommandContext &context) override
ManualPageID ManualPage () override
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
virtual ~AudacityCommand ()
PluginPath GetPath () const override
VendorSymbol GetVendor () const override
wxString GetVersion () const override
ComponentInterfaceSymbol GetSymbol () const override=0
virtual TranslatableString GetDescription () const override
virtual ManualPageID ManualPage ()
virtual bool IsBatchProcessing () const
virtual void SetBatchProcessing (bool start)
virtual bool Apply (const CommandContext &WXUNUSED(context))
bool ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
bool SaveSettingsAsString (wxString &parms)
bool LoadSettingsFromString (const wxString &parms)
bool DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
int MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool Init ()
virtual bool PromptUser (wxWindow *parent)
virtual bool CheckWhetherSkipAudacityCommand ()
virtual void End ()
virtual void PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool TransferDataToWindow ()
virtual bool TransferDataFromWindow ()
virtual bool VisitSettings (SettingsVisitor &)
virtual bool VisitSettings (ConstSettingsVisitor &)
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
virtual PluginPath GetPath () const =0
virtual ComponentInterfaceSymbol GetSymbol () const =0
virtual VendorSymbol GetVendor () const =0
virtual wxString GetVersion () const =0
virtual TranslatableString GetDescription () const =0
TranslatableString GetName () const

Public Attributes

wxString mFileName

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Clear Log") }

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
- Protected Attributes inherited from AudacityCommand
wxDialog * mUIDialog
wxWindow * mUIParent

Detailed Description

Definition at line 114 of file OpenSaveCommands.h.

Member Function Documentation

◆ Apply()

bool ClearLogCommand::Apply ( const CommandContext context)

Definition at line 222 of file OpenSaveCommands.cpp.

224 auto logger = AudacityLogger::Get();
225 return logger->ClearLog();
static AudacityLogger * Get()

References AudacityLogger::Get().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString ClearLogCommand::GetDescription ( ) const

Reimplemented from AudacityCommand.

Definition at line 121 of file OpenSaveCommands.h.

121{return XO("Clears the log contents.");};

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol ClearLogCommand::GetSymbol ( ) const

Implements AudacityCommand.

Definition at line 120 of file OpenSaveCommands.h.

120{return Symbol;};
static const ComponentInterfaceSymbol Symbol

References Symbol.

◆ ManualPage()

ManualPageID ClearLogCommand::ManualPage ( )

Reimplemented from AudacityCommand.

Definition at line 129 of file OpenSaveCommands.h.

129{return L"Extra_Menu:_Scriptables_II#Clear_log";}

◆ PromptUser()

bool ClearLogCommand::PromptUser ( wxWindow *  parent)

Reimplemented from AudacityCommand.

Definition at line 217 of file OpenSaveCommands.cpp.

219 return true;

◆ VisitSettings() [1/3]

bool ClearLogCommand::VisitSettings ( ConstSettingsVisitor )

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 214 of file OpenSaveCommands.cpp.

215 { return VisitSettings<true>(S); }
#define S(N)
Definition: ToChars.cpp:64

References S.

◆ VisitSettings() [2/3]

bool ClearLogCommand::VisitSettings ( SettingsVisitor )

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 211 of file OpenSaveCommands.cpp.

212 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>
bool ClearLogCommand::VisitSettings ( SettingsVisitorBase< Const > &  S)

Definition at line 206 of file OpenSaveCommands.cpp.

208 return true;

Member Data Documentation

◆ mFileName

wxString ClearLogCommand::mFileName

Definition at line 131 of file OpenSaveCommands.h.

◆ Symbol

const ComponentInterfaceSymbol ClearLogCommand::Symbol { XO("Clear Log") }

Definition at line 117 of file OpenSaveCommands.h.

Referenced by GetSymbol().

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