Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
MenuTable::CommandItem Struct Referencefinal

#include <CommandManager.h>

Inheritance diagram for MenuTable::CommandItem:
[legend]
Collaboration diagram for MenuTable::CommandItem:
[legend]

Public Member Functions

 CommandItem (const CommandID &name_, const TranslatableString &label_in_, CommandFunctorPointer callback_, CommandFlag flags_, const CommandManager::Options &options_, CommandHandlerFinder finder_)
 
template<typename Handler >
 CommandItem (const CommandID &name, const TranslatableString &label_in, void(Handler::*pmf)(const CommandContext &), CommandFlag flags, const CommandManager::Options &options={}, CommandHandlerFinder finder=FinderScope::DefaultFinder())
 
 CommandItem (const CommandID &name, const TranslatableString &label_in, CommandFunctorPointer::NonMemberFn callback, CommandFlag flags, const CommandManager::Options &options={})
 
 ~CommandItem () override
 
- Public Member Functions inherited from Registry::SingleItem
 ~SingleItem () override=0
 
- Public Member Functions inherited from Registry::detail::BaseItem
 BaseItem (const Identifier &internalName)
 
virtual ~BaseItem ()
 

Public Attributes

const TranslatableString label_in
 
CommandHandlerFinder finder
 
CommandFunctorPointer callback
 
CommandFlag flags
 
CommandManager::Options options
 
- Public Attributes inherited from Registry::detail::BaseItem
const Identifier name
 
OrderingHint orderingHint
 

Detailed Description

Definition at line 550 of file CommandManager.h.

Constructor & Destructor Documentation

◆ CommandItem() [1/3]

MenuTable::CommandItem::CommandItem ( const CommandID name_,
const TranslatableString label_in_,
CommandFunctorPointer  callback_,
CommandFlag  flags_,
const CommandManager::Options options_,
CommandHandlerFinder  finder_ 
)

Definition at line 212 of file Menus.cpp.

218: SingleItem{ name_ }, label_in{ label_in_ }
219, finder{ finder_ }, callback{ callback_ }
220, flags{ flags_ }, options{ options_ }
221{}
const TranslatableString label_in
CommandHandlerFinder finder
CommandFunctorPointer callback
CommandManager::Options options
Common abstract base class for items that are not groups.
Definition: Registry.h:224

◆ CommandItem() [2/3]

template<typename Handler >
MenuTable::CommandItem::CommandItem ( const CommandID name,
const TranslatableString label_in,
void(Handler::*)(const CommandContext &)  pmf,
CommandFlag  flags,
const CommandManager::Options options = {},
CommandHandlerFinder  finder = FinderScope::DefaultFinder() 
)
inline
Precondition
finder != nullptr

Definition at line 564 of file CommandManager.h.

568 {},
572 static_cast<CommandFunctorPointer::MemberFn>(pmf) },
574 { assert(finder); }
std::function< CommandHandlerObject &(AudacityProject &) > CommandHandlerFinder
static CommandHandlerFinder DefaultFinder()
CommandItem(const CommandID &name_, const TranslatableString &label_in_, CommandFunctorPointer callback_, CommandFlag flags_, const CommandManager::Options &options_, CommandHandlerFinder finder_)
Definition: Menus.cpp:212
const Identifier name
Definition: Registry.h:86
void(CommandHandlerObject::*)(const CommandContext &context) MemberFn

◆ CommandItem() [3/3]

MenuTable::CommandItem::CommandItem ( const CommandID name,
const TranslatableString label_in,
CommandFunctorPointer::NonMemberFn  callback,
CommandFlag  flags,
const CommandManager::Options options = {} 
)
inline

Definition at line 578 of file CommandManager.h.

582 {})
585 flags, options, nullptr)
586 {}

◆ ~CommandItem()

MenuTable::CommandItem::~CommandItem ( )
override

Definition at line 222 of file Menus.cpp.

222{}

Member Data Documentation

◆ callback

CommandFunctorPointer MenuTable::CommandItem::callback

◆ finder

CommandHandlerFinder MenuTable::CommandItem::finder

◆ flags

CommandFlag MenuTable::CommandItem::flags

◆ label_in

const TranslatableString MenuTable::CommandItem::label_in

◆ options

CommandManager::Options MenuTable::CommandItem::options

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