Audacity  2.2.2
Public Member Functions | Public Attributes | List of all members
HelpCommand Class Reference

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

#include <HelpCommand.h>

Inheritance diagram for HelpCommand:
AudacityCommand CommandDefinitionInterface IdentInterface ParamsInterface

Public Member Functions

IdentInterfaceSymbol GetSymbol () override
 
wxString GetDescription () override
 
bool DefineParams (ShuttleParams &S) override
 
void PopulateOrExchange (ShuttleGui &S) override
 
bool Apply (const CommandContext &context) override
 
wxString ManualPage () override
 
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
 
virtual ~AudacityCommand ()
 
wxString GetPath () override
 
IdentInterfaceSymbol GetVendor () override
 
wxString GetVersion () override
 
virtual bool IsBatchProcessing ()
 
virtual void SetBatchProcessing (bool start)
 
virtual bool Apply (const CommandContext &WXUNUSED(context))
 
virtual bool Apply ()
 
bool ShowInterface (wxWindow *parent, bool forceModal=false)
 
virtual void SetHostUI (EffectUIHostInterface *WXUNUSED(host))
 
bool PopulateUI (wxWindow *parent)
 
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 wxString &message, long style=DefaultMessageBoxStyle, const wxString &titleStr=wxString{})
 
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 CommandDefinitionInterface
virtual ~CommandDefinitionInterface ()
 
- Public Member Functions inherited from IdentInterface
virtual ~IdentInterface ()
 
const wxString & GetTranslatedName ()
 
- Public Member Functions inherited from ParamsInterface
virtual ~ParamsInterface ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Public Attributes

wxString mCommandName
 

Additional Inherited Members

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

Detailed Description

Command to get help about other commands.

Command which returns information about the given command.

Definition at line 28 of file HelpCommand.h.

Member Function Documentation

bool HelpCommand::Apply ( const CommandContext context)
override

Definition at line 39 of file HelpCommand.cpp.

References EffectManager::Get(), EffectManager::GetCommandDefinition(), EffectManager::GetEffectByIdentifier(), mCommandName, and CommandContext::Status().

39  {
42  if( ID.IsEmpty() )
43  context.Status( "Command not found" );
44  else
45  em.GetCommandDefinition( ID, context, 1);
46  return true;
47 }
const PluginID & GetEffectByIdentifier(const wxString &strTarget)
virtual void Status(const wxString &message, bool bFlush=false) const
wxString PluginID
Definition: Types.h:209
wxString mCommandName
Definition: HelpCommand.h:39
EffectManager is the class that handles effects and effect categories.
Definition: EffectManager.h:45
static EffectManager & Get()
void GetCommandDefinition(const PluginID &ID, const CommandContext &context, int flags)
bool HelpCommand::DefineParams ( ShuttleParams S)
override

Definition at line 23 of file HelpCommand.cpp.

References ShuttleParams::Define(), and mCommandName.

23  {
24  S.Define( mCommandName, wxT("Command"), "Help" );
25  return true;
26 }
wxString mCommandName
Definition: HelpCommand.h:39
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:339
wxString HelpCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 33 of file HelpCommand.h.

References _().

33 {return _("Gives help on a command.");};
_("Move Track &Down")+wxT("\t")+(GetActiveProject() -> GetCommandManager() ->GetKeyFromName(wxT("TrackMoveDown")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveTopID, _("Move Track to &Top")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveTop")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveBottomID, _("Move Track to &Bottom")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveBottom")).Raw()), OnMoveTrack)#define SET_TRACK_NAME_PLUGIN_SYMBOLclass SetTrackNameCommand:public AudacityCommand
IdentInterfaceSymbol HelpCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 32 of file HelpCommand.h.

References HELP_PLUGIN_SYMBOL.

32 {return HELP_PLUGIN_SYMBOL;};
#define HELP_PLUGIN_SYMBOL
Definition: HelpCommand.h:26
wxString HelpCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 39 of file HelpCommand.h.

39 {return wxT("Help");};
void HelpCommand::PopulateOrExchange ( ShuttleGui S)
override

Definition at line 28 of file HelpCommand.cpp.

References _(), ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), mCommandName, ShuttleGuiBase::StartMultiColumn(), and ShuttleGuiBase::TieTextBox().

29 {
30  S.AddSpace(0, 5);
31 
32  S.StartMultiColumn(2, wxALIGN_CENTER);
33  {
34  S.TieTextBox(_("Command:"),mCommandName);
35  }
36  S.EndMultiColumn();
37 }
void EndMultiColumn()
void StartMultiColumn(int nCols, int PositionFlags=wxALIGN_LEFT)
wxString mCommandName
Definition: HelpCommand.h:39
_("Move Track &Down")+wxT("\t")+(GetActiveProject() -> GetCommandManager() ->GetKeyFromName(wxT("TrackMoveDown")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveTopID, _("Move Track to &Top")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveTop")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveBottomID, _("Move Track to &Bottom")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveBottom")).Raw()), OnMoveTrack)#define SET_TRACK_NAME_PLUGIN_SYMBOLclass SetTrackNameCommand:public AudacityCommand
wxSizerItem * AddSpace(int width, int height)
wxTextCtrl * TieTextBox(const wxString &Prompt, WrappedType &WrappedRef, const int nChars)

Member Data Documentation

wxString HelpCommand::mCommandName

Definition at line 39 of file HelpCommand.h.

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


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