CommandManager::Options Struct Reference

#include <CommandManager.h>

Collaboration diagram for CommandManager::Options:

Public Member Functions
	Options ()
	Options (const wxChar *accel_)
	Options (const wxChar *accel_, const TranslatableString &longName_)
Options &&	Accel (const wxChar *value) &&
Options &&	IsEffect (bool value=true) &&
Options &&	Parameter (const CommandParameter &value) &&
Options &&	LongName (const TranslatableString &value) &&
Options &&	IsGlobal () &&
Options &&	UseStrictFlags () &&
Options &&	WantKeyUp () &&
Options &&	SkipKeyDown () &&
Options &&	AllowDup () &&
Options &&	AllowInMacros (int value=1) &&
Options &&	CheckTest (const CheckFn &fn) &&
Options &&	CheckTest (const wxChar *key, bool defaultValue) &&
Options &&	CheckTest (const BoolSetting &setting) &&

Public Attributes
const wxChar *	accel { wxT("") }
CheckFn	checker
bool	bIsEffect { false }
CommandParameter	parameter {}
TranslatableString	longName {}
bool	global { false }
bool	useStrictFlags { false }
bool	wantKeyUp { false }
bool	skipKeyDown { false }
bool	allowDup { false }
int	allowInMacros { -1 }

Static Private Member Functions
static CheckFn	MakeCheckFn (const wxString key, bool defaultValue)
static CheckFn	MakeCheckFn (const BoolSetting &setting)

Detailed Description

Definition at line 100 of file CommandManager.h.

Constructor & Destructor Documentation

Options() [1/3]

CommandManager::Options::Options ( )

inline

Definition at line 102 of file CommandManager.h.

{}

Options() [2/3]

CommandManager::Options::Options ( const wxChar *  accel_ )

inline

Definition at line 105 of file CommandManager.h.

: accel{ accel_ } {}

Options() [3/3]

CommandManager::Options::Options ( const wxChar *  accel_, const TranslatableString &  longName_  )

inline

Definition at line 107 of file CommandManager.h.

      : accel{ accel_ }, longName{ longName_ } {}

Member Function Documentation

Accel()

Options && CommandManager::Options::Accel ( const wxChar *  value ) &&

inline

Definition at line 112 of file CommandManager.h.

         { accel = value; return std::move(*this); }

AllowDup()

Options && CommandManager::Options::AllowDup ( ) &&

inline

Definition at line 130 of file CommandManager.h.

         { allowDup = true; return std::move(*this); }

AllowInMacros()

Options && CommandManager::Options::AllowInMacros ( int  value = 1 ) &&

inline

Definition at line 133 of file CommandManager.h.

         { allowInMacros = value; return std::move(*this); }

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), and anonymous_namespace{BatchProcessDialog.cpp}::PopulateMacrosMenu().

Here is the caller graph for this function:

CheckTest() [1/3]

Options && CommandManager::Options::CheckTest ( const BoolSetting &  setting ) &&

inline

Definition at line 146 of file CommandManager.h.

                                                            {
         checker = MakeCheckFn( setting );
         return std::move(*this);
      }

CheckTest() [2/3]

Options && CommandManager::Options::CheckTest ( const CheckFn &  fn ) &&

inline

Definition at line 138 of file CommandManager.h.

         { checker = fn; return std::move(*this); }

References fn.

Referenced by anonymous_namespace{TimelineMenus.cpp}::ExtraSelectionMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), anonymous_namespace{TransportMenus.cpp}::TransportMenu(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the caller graph for this function:

CheckTest() [3/3]

Options && CommandManager::Options::CheckTest ( const wxChar *  key, bool  defaultValue  ) &&

inline

Definition at line 141 of file CommandManager.h.

                                                                    {
         checker = MakeCheckFn( key, defaultValue );
         return std::move(*this);
      }

References key.

IsEffect()

Options && CommandManager::Options::IsEffect ( bool  value = true ) &&

inline

Definition at line 114 of file CommandManager.h.

         { bIsEffect = value; return std::move(*this); }

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), and CommandManager::AddItemList().

Here is the caller graph for this function:

IsGlobal()

Options && CommandManager::Options::IsGlobal ( ) &&

inline

Definition at line 120 of file CommandManager.h.

         { global = true; return std::move(*this); }

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), and PluginMenuItems().

Here is the caller graph for this function:

LongName()

Options && CommandManager::Options::LongName ( const TranslatableString &  value ) &&

inline

Definition at line 118 of file CommandManager.h.

         { longName = value; return std::move(*this); }

Referenced by anonymous_namespace{ClipMenus.cpp}::ClipCursorItems(), anonymous_namespace{SelectMenus.cpp}::CursorMenu(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), and anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the caller graph for this function:

MakeCheckFn() [1/2]

auto CommandManager::Options::MakeCheckFn ( const BoolSetting &  setting )

staticprivate

Definition at line 579 of file CommandManager.cpp.

{
   return MakeCheckFn( setting.GetPath(), setting.GetDefault() );
}

MakeCheckFn() [2/2]

auto CommandManager::Options::MakeCheckFn ( const wxString  key, bool  defaultValue  )

staticprivate

Definition at line 573 of file CommandManager.cpp.

{
   return [=](AudacityProject&){ return gPrefs->ReadBool( key, defaultValue ); };
}

References gPrefs, key, and audacity::BasicSettings::ReadBool().

Here is the call graph for this function:

Parameter()

Options && CommandManager::Options::Parameter ( const CommandParameter &  value ) &&

inline

Definition at line 116 of file CommandManager.h.

         { parameter = value; return std::move(*this); }

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup().

Here is the caller graph for this function:

SkipKeyDown()

Options && CommandManager::Options::SkipKeyDown ( ) &&

inline

Definition at line 126 of file CommandManager.h.

         { skipKeyDown = true; return std::move(*this); }

UseStrictFlags()

Options && CommandManager::Options::UseStrictFlags ( ) &&

inline

Definition at line 122 of file CommandManager.h.

         { useStrictFlags = true; return std::move(*this); }

WantKeyUp()

Options && CommandManager::Options::WantKeyUp ( ) &&

inline

Definition at line 124 of file CommandManager.h.

         { wantKeyUp = true; return std::move(*this); }

Referenced by anonymous_namespace{ClipMenus.cpp}::ExtraTimeShiftItems().

Here is the caller graph for this function:

Member Data Documentation

accel

const wxChar* CommandManager::Options::accel { wxT("") }

Definition at line 151 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

allowDup

bool CommandManager::Options::allowDup { false }

Definition at line 160 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

allowInMacros

int CommandManager::Options::allowInMacros { -1 }

Definition at line 161 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

bIsEffect

bool CommandManager::Options::bIsEffect { false }

Definition at line 153 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

checker

CheckFn CommandManager::Options::checker

Definition at line 152 of file CommandManager.h.

Referenced by CommandManager::AddItem(), and CommandManager::NewIdentifier().

global

bool CommandManager::Options::global { false }

Definition at line 156 of file CommandManager.h.

Referenced by CommandManager::AddItem().

longName

TranslatableString CommandManager::Options::longName {}

Definition at line 155 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

parameter

CommandParameter CommandManager::Options::parameter {}

Definition at line 154 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

skipKeyDown

bool CommandManager::Options::skipKeyDown { false }

Definition at line 159 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

useStrictFlags

bool CommandManager::Options::useStrictFlags { false }

Definition at line 157 of file CommandManager.h.

Referenced by CommandManager::AddItem().

wantKeyUp

bool CommandManager::Options::wantKeyUp { false }

Definition at line 158 of file CommandManager.h.

Referenced by CommandManager::NewIdentifier().

---

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

• CommandManager.h
• CommandManager.cpp