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

#include <HelpCommand.h>

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

Public Member Functions

ComponentInterfaceSymbol GetSymbol () override
 
TranslatableString GetDescription () override
 
bool DefineParams (ShuttleParams &S) override
 
void PopulateOrExchange (ShuttleGui &S) 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 PromptUser (wxWindow *parent)
 
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

int mFormat
 
wxString mComment
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Comment") }
 

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 46 of file HelpCommand.h.

Member Function Documentation

◆ Apply()

bool CommentCommand::Apply ( const CommandContext context)
inlineoverride

Definition at line 57 of file HelpCommand.h.

57  {
58  return true;
59  };

◆ DefineParams()

bool CommentCommand::DefineParams ( ShuttleParams S)
override

Definition at line 110 of file HelpCommand.cpp.

110  {
111  S.Define( mComment, wxT("_"), "" );
112  return true;
113 }

References ShuttleParams::Define(), and mComment.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString CommentCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 54 of file HelpCommand.h.

54 {return XO("For comments in a macro.");};

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol CommentCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 53 of file HelpCommand.h.

53 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID CommentCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 61 of file HelpCommand.h.

61 {return L"Extra_Menu:_Scriptables_II#comment";}

◆ PopulateOrExchange()

void CommentCommand::PopulateOrExchange ( ShuttleGui S)
override

Definition at line 115 of file HelpCommand.cpp.

116 {
117  S.AddSpace(0, 5);
118 
119  S.StartMultiColumn(2, wxALIGN_CENTER);
120  {
121  S.TieTextBox(XXO("_"),mComment,80);
122  }
123  S.EndMultiColumn();
124 }

References ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), mComment, ShuttleGuiBase::StartMultiColumn(), ShuttleGuiBase::TieTextBox(), and XXO.

Here is the call graph for this function:

Member Data Documentation

◆ mComment

wxString CommentCommand::mComment

Definition at line 63 of file HelpCommand.h.

Referenced by DefineParams(), and PopulateOrExchange().

◆ mFormat

int CommentCommand::mFormat

Definition at line 50 of file HelpCommand.h.

◆ Symbol

const ComponentInterfaceSymbol CommentCommand::Symbol { XO("Comment") }
static

Definition at line 49 of file HelpCommand.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files:
ShuttleGui::AddSpace
wxSizerItem * AddSpace(int width, int height, int prop=0)
Definition: ShuttleGui.cpp:2459
XO
#define XO(s)
Definition: Internat.h:31
ShuttleGuiBase::EndMultiColumn
void EndMultiColumn()
Definition: ShuttleGui.cpp:1238
ShuttleGuiBase::TieTextBox
wxTextCtrl * TieTextBox(const TranslatableString &Caption, wxString &Value, const int nChars=0)
Definition: ShuttleGui.cpp:1652
XXO
#define XXO(s)
Definition: Internat.h:44
ShuttleGuiBase::StartMultiColumn
void StartMultiColumn(int nCols, int PositionFlags=wxALIGN_LEFT)
Definition: ShuttleGui.cpp:1229
CommentCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: HelpCommand.h:49
ShuttleParams::Define
virtual void Define(bool &var, const wxChar *key, const bool vdefault, const bool vmin=false, const bool vmax=false, const bool vscl=false)
Definition: Shuttle.cpp:332
CommentCommand::mComment
wxString mComment
Definition: HelpCommand.h:63