HelpCommand Class Reference

Command to get help about other commands. More...

#include <HelpCommand.h>

Inheritance diagram for HelpCommand:

Collaboration diagram for HelpCommand:

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
bool	ApplyInner (const CommandContext &context)
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	mCommandName

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Help") }

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

Command to get help about other commands.

Command which returns information about the given command.

Definition at line 26 of file HelpCommand.h.

Member Function Documentation

Apply()

bool HelpCommand::Apply ( const CommandContext &  context )

override

Definition at line 83 of file HelpCommand.cpp.

{
   if( mFormat == kJson )
      return ApplyInner( context );
 
   if( mFormat == kLisp )
   {
      CommandContext LispyContext(
         context.project,
         std::make_unique<LispifiedCommandOutputTargets>( *context.pOutput.get() )
         );
      return ApplyInner( LispyContext );
   }
 
   if( mFormat == kBrief )
   {
      CommandContext BriefContext(
         context.project,
         std::make_unique<BriefCommandOutputTargets>( *context.pOutput.get() )
         );
      return ApplyInner( BriefContext );
   }
 
   return false;
}

References ApplyInner(), kBrief, kJson, kLisp, mFormat, CommandContext::pOutput, and CommandContext::project.

Here is the call graph for this function:

ApplyInner()

bool HelpCommand::ApplyInner

(

const CommandContext &

context

)

Definition at line 109 of file HelpCommand.cpp.

                                                          {
   PluginID ID = PluginManager::Get().GetByCommandIdentifier(mCommandName);
   if( ID.empty() )
      context.Status( "Command not found" );
   else
      EffectAndCommandPluginManager::Get().GetCommandDefinition(ID, context, 1);
   return true;
}

References PluginManager::Get(), EffectAndCommandPluginManager::Get(), PluginManager::GetByCommandIdentifier(), EffectAndCommandPluginManager::GetCommandDefinition(), mCommandName, and CommandContext::Status().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString HelpCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 34 of file HelpCommand.h.

{return XO("Gives help on a command.");};

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol HelpCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 33 of file HelpCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID HelpCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 43 of file HelpCommand.h.

{return L"Extra_Menu:_Scriptables_II#help";}

PopulateOrExchange()

void HelpCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 70 of file HelpCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(XXO("Command:"),mCommandName);
      S.TieChoice( XXO("Format:"),
         mFormat, Msgids( kFormats, nFormats ));
   }
   S.EndMultiColumn();
}

References kFormats, mCommandName, mFormat, Msgids(), nFormats, S, and XXO().

Here is the call graph for this function:

VisitSettings() [1/3]

bool HelpCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 67 of file HelpCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool HelpCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 64 of file HelpCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool HelpCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 59 of file HelpCommand.cpp.

                                                               {
   S.Define( mCommandName, wxT("Command"), wxString{"Help"} );
   S.DefineEnum( mFormat, wxT("Format"), 0, kFormats, nFormats );
   return true;
}

References kFormats, mCommandName, mFormat, nFormats, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

mCommandName

wxString HelpCommand::mCommandName

Definition at line 45 of file HelpCommand.h.

Referenced by ApplyInner(), PopulateOrExchange(), and VisitSettings().

mFormat

int HelpCommand::mFormat

Definition at line 30 of file HelpCommand.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

Symbol

const ComponentInterfaceSymbol HelpCommand::Symbol { XO("Help") }

static

Definition at line 29 of file HelpCommand.h.

Referenced by GetSymbol().

---

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

• HelpCommand.h
• HelpCommand.cpp