ComponentInterfaceSymbol Class Reference

ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional, different string as msgid for lookup in a translation catalog. More...

#include <ComponentInterfaceSymbol.h>

Collaboration diagram for ComponentInterfaceSymbol:

Public Member Functions
	ComponentInterfaceSymbol ()=default
	ComponentInterfaceSymbol (const TranslatableString &msgid)
	ComponentInterfaceSymbol (const wxString &internal)
	ComponentInterfaceSymbol (const wxChar *msgid)
	ComponentInterfaceSymbol (const Identifier &internal, const TranslatableString &msgid)
const wxString &	Internal () const
const TranslatableString &	Msgid () const
const TranslatableString	Stripped () const
const wxString	Translation () const
const wxString	StrippedTranslation () const
bool	empty () const

Private Attributes
wxString	mInternal
TranslatableString	mMsgid

Friends
bool	operator== (const ComponentInterfaceSymbol &a, const ComponentInterfaceSymbol &b)
	Comparator for such as find_if, using internal name only. More...
bool	operator!= (const ComponentInterfaceSymbol &a, const ComponentInterfaceSymbol &b)
bool	operator< (const ComponentInterfaceSymbol &a, const ComponentInterfaceSymbol &b)
	Comparator for use in ordered containers, using internal name only. More...

Detailed Description

ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional, different string as msgid for lookup in a translation catalog.

If there is need to change a msgid in a later version of the program, change the constructor call to supply a second argument but leave the first the same, so that compatibility of older configuration files containing that internal string is not broken.

Definition at line 26 of file ComponentInterfaceSymbol.h.

Constructor & Destructor Documentation

ComponentInterfaceSymbol() [1/5]

ComponentInterfaceSymbol::ComponentInterfaceSymbol ( )

default

ComponentInterfaceSymbol() [2/5]

ComponentInterfaceSymbol::ComponentInterfaceSymbol ( const TranslatableString &  msgid )

inline

Definition at line 32 of file ComponentInterfaceSymbol.h.

      : mInternal{ msgid.MSGID().GET(), }, mMsgid{ msgid }
   {}

ComponentInterfaceSymbol() [3/5]

ComponentInterfaceSymbol::ComponentInterfaceSymbol ( const wxString &  internal )

inline

Definition at line 37 of file ComponentInterfaceSymbol.h.

      : mInternal{ internal }, mMsgid{ internal, {} }
   {}

ComponentInterfaceSymbol() [4/5]

ComponentInterfaceSymbol::ComponentInterfaceSymbol ( const wxChar *  msgid )

inline

Definition at line 42 of file ComponentInterfaceSymbol.h.

      : mInternal{ msgid }, mMsgid{ msgid, {} }
   {}

ComponentInterfaceSymbol() [5/5]

ComponentInterfaceSymbol::ComponentInterfaceSymbol ( const Identifier &  internal, const TranslatableString &  msgid  )

inline

Definition at line 48 of file ComponentInterfaceSymbol.h.

      : mInternal{ internal.GET() }
      // Do not permit non-empty msgid with empty internal
      , mMsgid{ internal.empty() ? TranslatableString{} : msgid }
   {}

Member Function Documentation

empty()

bool ComponentInterfaceSymbol::empty ( ) const

inline

Definition at line 62 of file ComponentInterfaceSymbol.h.

{ return mInternal.empty(); }

Internal()

const wxString & ComponentInterfaceSymbol::Internal ( ) const

inline

Definition at line 55 of file ComponentInterfaceSymbol.h.

{ return mInternal; }

Referenced by ApplyAndSendResponse::Apply(), ChangeSpeedBase::ChangeSpeedBase(), OldStyleCommandType::Describe(), ChangeSpeedBase::DoLoadFactoryDefaults(), BasicEffectUIServices::ExportPresets(), NumericConverterRegistry::Find(), PluginManager::GetCommandIdentifier(), PluginManager::GetID(), ModuleManager::GetID(), EnumValueSymbols::GetInternals(), CapturedParameters< EffectType, Parameters >::GetOne(), Effect::GetPath(), PrefsPanel::GetPath(), AudacityCommand::GetPath(), Effect::GetSelectionFormat(), Grid::Grid(), BasicEffectUIServices::ImportPresets(), PluginManager::OldGetID(), LabelDialog::OnFreqUpdate(), EffectChangeSpeed::OnTimeCtrlUpdate(), LabelDialog::OnUpdate(), EffectChangeSpeed::PopulateOrExchange(), ChoiceSetting::Read(), PluginManager::RegisterPlugin(), NumericConverter::SetFormatName(), PluginManager::SettingsPath(), HelpSystem::ShowHelp(), ShuttleGuiBase::TieChoice(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice(), and ShuttleGuiBase::TieRadioButton().

Here is the caller graph for this function:

Msgid()

const TranslatableString & ComponentInterfaceSymbol::Msgid ( ) const

inline

Definition at line 56 of file ComponentInterfaceSymbol.h.

{ return mMsgid; }

Referenced by anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), anonymous_namespace{MenuHelper.cpp}::FixBatchFlags(), EnumValueSymbols::GetMsgids(), ComponentInterface::GetName(), PluginManager::GetName(), Msgids(), and LV2Effect::PopulateUI().

Here is the caller graph for this function:

Stripped()

const TranslatableString ComponentInterfaceSymbol::Stripped ( ) const

inline

Definition at line 57 of file ComponentInterfaceSymbol.h.

{ return mMsgid.Stripped(); }

References TranslatableString::Stripped().

Referenced by SetTrackVisualsCommand::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

StrippedTranslation()

const wxString ComponentInterfaceSymbol::StrippedTranslation ( ) const

inline

Definition at line 59 of file ComponentInterfaceSymbol.h.

      { return Stripped().Translation(); }

Referenced by MacroCommandsCatalog::ByFriendlyName(), and MacroCommandsCatalog::MacroCommandsCatalog().

Here is the caller graph for this function:

Translation()

const wxString ComponentInterfaceSymbol::Translation ( ) const

inline

Definition at line 58 of file ComponentInterfaceSymbol.h.

{ return mMsgid.Translation(); }

Referenced by anonymous_namespace{MenuHelper.cpp}::ComapareEffectsByTypeAndPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByName(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisherAndName(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByType(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByTypeAndName(), VampEffect::Process(), and ShuttleGuiBase::TieRadioButton().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator!=

bool operator!= ( const ComponentInterfaceSymbol &  a, const ComponentInterfaceSymbol &  b  )

friend

Definition at line 69 of file ComponentInterfaceSymbol.h.

   { return !( a == b ); }

operator<

bool operator< ( const ComponentInterfaceSymbol &  a, const ComponentInterfaceSymbol &  b  )

friend

Comparator for use in ordered containers, using internal name only.

Definition at line 74 of file ComponentInterfaceSymbol.h.

   { return a.mInternal < b.mInternal; }

operator==

bool operator== ( const ComponentInterfaceSymbol &  a, const ComponentInterfaceSymbol &  b  )

friend

Comparator for such as find_if, using internal name only.

Definition at line 65 of file ComponentInterfaceSymbol.h.

   { return a.mInternal == b.mInternal; }

Member Data Documentation

mInternal

wxString ComponentInterfaceSymbol::mInternal

private

Definition at line 79 of file ComponentInterfaceSymbol.h.

mMsgid

TranslatableString ComponentInterfaceSymbol::mMsgid

private

Definition at line 80 of file ComponentInterfaceSymbol.h.

---

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

• ComponentInterfaceSymbol.h