#include <HelpCommand.h>

Inheritance diagram for CommentCommand:

Collaboration diagram for CommentCommand:

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

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 () 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 (const CommandContext &context, bool shouldPrompt=true)

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

virtual bool	Init ()

virtual bool	PromptUser (AudacityProject &)

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
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 }

Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress

wxDialog *	mUIDialog

wxWindow *	mUIParent

Detailed Description

Definition at line 48 of file HelpCommand.h.

Member Function Documentation

◆ Apply()

bool CommentCommand::Apply ( const CommandContext & context )

inlineoverride

Definition at line 61 of file HelpCommand.h.

                                                       {
      return true;
   };

◆ GetDescription()

TranslatableString CommentCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 56 of file HelpCommand.h.

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

XO

XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol CommentCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 55 of file HelpCommand.h.

55{return Symbol;};

CommentCommand::Symbol

static const ComponentInterfaceSymbol Symbol

Definition: HelpCommand.h:51

References Symbol.

◆ ManualPage()

ManualPageID CommentCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 65 of file HelpCommand.h.

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

◆ PopulateOrExchange()

void CommentCommand::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 130 of file HelpCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(XXO("_"),mComment,80);
   }
   S.EndMultiColumn();
}

References mComment, S, and XXO().

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool CommentCommand::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 127 of file HelpCommand.cpp.

128 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool CommentCommand::VisitSettings ( SettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 124 of file HelpCommand.cpp.

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

References S.

◆ VisitSettings() [3/3]

template<bool Const>

bool CommentCommand::VisitSettings ( SettingsVisitorBase< Const > & S )

Definition at line 119 of file HelpCommand.cpp.

                                                                  {
   S.Define( mComment, wxT("_"),  wxString{} );
   return true;
}

References mComment, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mComment

wxString CommentCommand::mComment

Definition at line 67 of file HelpCommand.h.

Referenced by PopulateOrExchange(), and VisitSettings().

◆ mFormat

int CommentCommand::mFormat

Definition at line 52 of file HelpCommand.h.

◆ Symbol

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

static

Definition at line 51 of file HelpCommand.h.

Referenced by GetSymbol().

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

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Apply()

◆ GetDescription()

◆ GetSymbol()

◆ ManualPage()

◆ PopulateOrExchange()

◆ VisitSettings() [1/3]

◆ VisitSettings() [2/3]

◆ VisitSettings() [3/3]

Member Data Documentation

◆ mComment

◆ mFormat

◆ Symbol