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

#include <OpenSaveCommands.h>

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

Public Member Functions

ComponentInterfaceSymbol GetSymbol () override
 
TranslatableString GetDescription () override
 
bool DefineParams (ShuttleParams &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 () override
 
VendorSymbol GetVendor () override
 
wxString GetVersion () override
 
virtual bool IsBatchProcessing ()
 
virtual void SetBatchProcessing (bool start)
 
virtual bool Apply (const CommandContext &WXUNUSED(context))
 
bool ShowInterface (wxWindow *parent, bool forceModal=false)
 
virtual void SetHostUI (EffectUIHostInterface *WXUNUSED(host))
 
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
 
virtual bool GetAutomationParameters (wxString &parms)
 
virtual bool SetAutomationParameters (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 CheckWhetherSkipAudacityCommand ()
 
virtual void End ()
 
virtual void PopulateOrExchange (ShuttleGui &WXUNUSED(S))
 
virtual bool TransferDataToWindow ()
 
virtual bool TransferDataFromWindow ()
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
TranslatableString GetName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

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 }
 
using VetoDialogHook = bool(*)(wxDialog *)
 
- Static Public Member Functions inherited from AudacityCommand
static VetoDialogHook SetVetoDialogHook (VetoDialogHook hook)
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 
int mUIResultID
 

Detailed Description

Definition at line 106 of file OpenSaveCommands.h.

Member Function Documentation

◆ Apply()

bool ClearLogCommand::Apply ( const CommandContext context)
override

Definition at line 183 of file OpenSaveCommands.cpp.

184 {
185  auto logger = AudacityLogger::Get();
186  return logger->ClearLog();
187 }

References AudacityLogger::Get().

Here is the call graph for this function:

◆ DefineParams()

bool ClearLogCommand::DefineParams ( ShuttleParams S)
override

Definition at line 173 of file OpenSaveCommands.cpp.

174 {
175  return true;
176 }

◆ GetDescription()

TranslatableString ClearLogCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 113 of file OpenSaveCommands.h.

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

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol ClearLogCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 112 of file OpenSaveCommands.h.

112 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID ClearLogCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 119 of file OpenSaveCommands.h.

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

◆ PromptUser()

bool ClearLogCommand::PromptUser ( wxWindow *  parent)
overridevirtual

Reimplemented from AudacityCommand.

Definition at line 178 of file OpenSaveCommands.cpp.

179 {
180  return true;
181 }

Member Data Documentation

◆ mFileName

wxString ClearLogCommand::mFileName

Definition at line 121 of file OpenSaveCommands.h.

◆ Symbol

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

Definition at line 109 of file OpenSaveCommands.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files:
XO
#define XO(s)
Definition: Internat.h:31
AudacityLogger::Get
static AudacityLogger * Get()
Definition: AudacityLogger.cpp:35
ClearLogCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:109