anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx Struct Reference

Inheritance diagram for anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx:

Collaboration diagram for anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx:

Public Member Functions
	~CommandListEntryEx () final
void	UpdateCheckmark (AudacityProject &project) final
	Default implementation does nothing. More...
void	Modify (const TranslatableString &newLabel) final
	Default implementation simply assigns this->label More...
bool	GetEnabled () const final
	Default implementation simply returns this->enabled More...
void	Check (bool checked) final
	Default implementation does nothing. More...
void	Enable (bool enabled) final
	Default implementation simply assigns this->enabled More...
void	EnableMultiItem (bool enabled) final
	Default implementation simply assigns this->enabled More...
Public Member Functions inherited from CommandManager::CommandListEntry
virtual	~CommandListEntry ()
virtual void	UpdateCheckmark (AudacityProject &project)
	Default implementation does nothing. More...
virtual void	Modify (const TranslatableString &newLabel)
	Default implementation simply assigns this->label More...
virtual bool	GetEnabled () const
	Default implementation simply returns this->enabled More...
virtual void	Check (bool checked)
	Default implementation does nothing. More...
virtual void	Enable (bool enabled)
	Default implementation simply assigns this->enabled More...
virtual void	EnableMultiItem (bool enabled)
	Default implementation simply assigns this->enabled More...
wxString	FormatLabelForMenu () const

Public Attributes
wxMenu *	menu {}
Public Attributes inherited from CommandManager::CommandListEntry
int	id
CommandID	name
TranslatableString	longLabel
NormalizedKeyString	key
NormalizedKeyString	defaultKey
TranslatableString	label
TranslatableString	labelPrefix
TranslatableString	labelTop
CommandHandlerFinder	finder
CommandFunctorPointer	callback
CommandParameter	parameter
CheckFn	checkmarkFn
bool	multi
int	index
int	count
bool	enabled
bool	skipKeydown
bool	wantKeyup
bool	allowDup
bool	isGlobal
bool	isOccult
bool	isEffect
bool	excludeFromMacros
CommandFlag	flags
bool	useStrictFlags { false }

Additional Inherited Members
Public Types inherited from CommandManager::CommandListEntry
using	CheckFn = std::function< bool(AudacityProject &) >
Static Public Member Functions inherited from CommandManager::CommandListEntry
static wxString	FormatLabelForMenu (const TranslatableString &translatableLabel, const NormalizedKeyString &keyStr)

Detailed Description

Definition at line 147 of file MenuCreator.cpp.

Constructor & Destructor Documentation

~CommandListEntryEx()

anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::~CommandListEntryEx ( )

finaldefault

Member Function Documentation

Check()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::Check ( bool  checked )

finalvirtual

Default implementation does nothing.

Reimplemented from CommandManager::CommandListEntry.

Definition at line 212 of file MenuCreator.cpp.

{
   if (!menu || isOccult)
      return;
   menu->Check(id, checked);
}

Enable()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::Enable ( bool  enabled )

finalvirtual

Default implementation simply assigns this->enabled

Reimplemented from CommandManager::CommandListEntry.

Definition at line 219 of file MenuCreator.cpp.

{
   if (!menu) {
      enabled = b;
      return;
   }
 
   // LL:  Refresh from real state as we can get out of sync on the
   //      Mac due to its reluctance to enable menus when in a modal
   //      state.
   enabled = menu->IsEnabled(id);
 
   // Only enabled if needed
   if (enabled != b) {
      menu->Enable(id, b);
      enabled = menu->IsEnabled(id);
   }
}

EnableMultiItem()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::EnableMultiItem ( bool  enabled )

finalvirtual

Default implementation simply assigns this->enabled

Reimplemented from CommandManager::CommandListEntry.

Definition at line 238 of file MenuCreator.cpp.

{
   if (menu) {
      const auto item = menu->FindItem(id);
      if (item) {
         item->Enable(b);
         return;
      }
   }
   // using GET in a log message for devs' eyes only
   wxLogDebug(wxT("Warning: Menu entry with id %i in %s not found"),
       id, name.GET());
}

References name, and wxT().

Here is the call graph for this function:

GetEnabled()

bool anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::GetEnabled ( ) const

finalvirtual

Default implementation simply returns this->enabled

Reimplemented from CommandManager::CommandListEntry.

Definition at line 205 of file MenuCreator.cpp.

{
   if (!menu)
      return false;
   return enabled;
}

Modify()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::Modify ( const TranslatableString &  newLabel )

finalvirtual

Default implementation simply assigns this->label

Reimplemented from CommandManager::CommandListEntry.

Definition at line 197 of file MenuCreator.cpp.

{
   if (menu) {
      label = newLabel;
      menu->SetLabel(id, FormatLabelForMenu());
   }
}

References label.

UpdateCheckmark()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::UpdateCheckmark ( AudacityProject &  project )

finalvirtual

Default implementation does nothing.

Reimplemented from CommandManager::CommandListEntry.

Definition at line 189 of file MenuCreator.cpp.

{
   if (menu && checkmarkFn && !isOccult) {
      menu->Check(id, checkmarkFn(project));
   }
}

References project.

Member Data Documentation

menu

wxMenu* anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::CommandListEntryEx::menu {}

Definition at line 156 of file MenuCreator.cpp.

---

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

• MenuCreator.cpp