TranslatableString Class Reference

Holds a msgid for the translation catalog; may also bind format arguments. More...

#include <TranslatableString.h>

Collaboration diagram for TranslatableString:

Classes
struct	PluralTemp

Public Types
enum	StripOptions : unsigned { MenuCodes = 0x1 , Ellipses = 0x2 }
using	Formatter = std::function< wxString(const wxString &, Request) >
	A multi-purpose function, depending on the enum argument. More...

Public Member Functions
	TranslatableString ()
	TranslatableString (wxString str, Formatter formatter)
	TranslatableString (const TranslatableString &)=default
TranslatableString &	operator= (const TranslatableString &)=default
	TranslatableString (TranslatableString &&str)
TranslatableString &	operator= (TranslatableString &&str)
bool	empty () const
Identifier	MSGID () const
	MSGID is the English lookup key in the catalog, not necessarily for user's eyes if locale is some other. More...
wxString	Translation () const
wxString	Debug () const
	Format as an English string for debugging logs and developers' eyes, not for end users. More...
bool	IsVerbatim () const
	Returns true if context is NullContextFormatter. More...
template<typename... Args>
TranslatableString &	Format (Args &&...args) &
	Capture variadic format arguments (by copy) when there is no plural. More...
template<typename... Args>
TranslatableString &&	Format (Args &&...args) &&
TranslatableString &	Context (const wxString &context) &
	Choose a non-default and non-null disambiguating context for lookups. More...
TranslatableString &&	Context (const wxString &context) &&
TranslatableString &	Join (TranslatableString arg, const wxString &separator={}) &
	Append another translatable string. More...
TranslatableString &&	Join (TranslatableString arg, const wxString &separator={}) &&
TranslatableString &	operator+= (TranslatableString arg)
template<size_t N>
PluralTemp< N >	Plural (const wxString &pluralStr) &&
	Implements the XP macro. More...
TranslatableString &	Strip (unsigned options=MenuCodes) &
TranslatableString &&	Strip (unsigned options=MenuCodes) &&
TranslatableString	Stripped (unsigned options=MenuCodes) const
	non-mutating, constructs another TranslatableString object More...
wxString	StrippedTranslation () const

Static Public Attributes
static const TranslatableString	Inaudible { wxT("\a") }
	A special string value that will have no screen reader pronunciation. More...

Private Types
enum class	Request { Context , Format , DebugFormat }

Private Member Functions
	TranslatableString (wxString str)
	Construct a TranslatableString that does no translation but passes str verbatim. More...
wxString	DoFormat (bool debug) const

Static Private Member Functions
static wxString	DoGetContext (const Formatter &formatter)
static wxString	DoSubstitute (const Formatter &formatter, const wxString &format, const wxString &context, bool debug)
static wxString	DoChooseFormat (const Formatter &formatter, const wxString &singular, const wxString &plural, unsigned nn, bool debug)
template<typename T >
static const T &	TranslateArgument (const T &arg, bool)
template<typename T >
static auto	TranslateArgument (const std::reference_wrapper< T > &arg, bool debug) -> decltype(TranslatableString::TranslateArgument(arg.get(), debug))
	This allows you to wrap arguments of Format in std::cref. More...
static wxString	TranslateArgument (const TranslatableString &arg, bool debug)

Private Attributes
wxString	mMsgid
Formatter	mFormatter

Static Private Attributes
static const Formatter	NullContextFormatter
static const wxChar *const	NullContextName = wxT("*")

Friends
bool	operator== (const TranslatableString &x, const TranslatableString &y)
	Warning: comparison of msgids only, which is not all of the information! More...
bool	operator!= (const TranslatableString &x, const TranslatableString &y)
TranslatableString	Verbatim (wxString str)
	Require calls to the one-argument constructor to go through this distinct global function name. More...

Detailed Description

Holds a msgid for the translation catalog; may also bind format arguments.

Different string-valued accessors for the msgid itself, and for the user-visible translation with substitution of captured format arguments. Also an accessor for format substitution into the English msgid, for debug- only outputs. The msgid should be used only in unusual cases and the translation more often

Implicit conversions to and from wxString are intentionally disabled

Definition at line 32 of file TranslatableString.h.

Member Typedef Documentation

Formatter

using TranslatableString::Formatter = std::function< wxString(const wxString &, Request) >

A multi-purpose function, depending on the enum argument.

the string argument is unused in some cases If there is no function, defaults are empty context string, no plurals, and no substitutions

Definition at line 45 of file TranslatableString.h.

Member Enumeration Documentation

Request

enum class TranslatableString::Request

strongprivate

Enumerator
Context	return a disambiguating context string
Format	Given the msgid, format the string for end users.
DebugFormat	Given the msgid, format the string for developers.

Definition at line 215 of file TranslatableString.h.

                      {
      Context,     
      Format,      
      DebugFormat, 
   };

StripOptions

enum TranslatableString::StripOptions : unsigned

Translated strings may still contain menu hot-key codes (indicated by &) that wxWidgets interprets, and also trailing ellipses, that should be removed for other uses.

Enumerator
MenuCodes
Ellipses

Definition at line 188 of file TranslatableString.h.

                     : unsigned {
      // Values to be combined with bitwise OR
      MenuCodes = 0x1,
      Ellipses = 0x2,
   };

Constructor & Destructor Documentation

TranslatableString() [1/5]

TranslatableString::TranslatableString ( )

inline

Definition at line 47 of file TranslatableString.h.

{}

TranslatableString() [2/5]

TranslatableString::TranslatableString ( wxString  str, Formatter  formatter  )

inlineexplicit

Supply {} for the second argument to cause lookup of the msgid with empty context string (default context) rather than the null context

Definition at line 51 of file TranslatableString.h.

      : mFormatter{ std::move(formatter) }
   {
      mMsgid.swap( str );
   }

References str.

TranslatableString() [3/5]

TranslatableString::TranslatableString ( const TranslatableString &  )

default

TranslatableString() [4/5]

TranslatableString::TranslatableString ( TranslatableString &&  str )

inline

Definition at line 60 of file TranslatableString.h.

      : mFormatter( std::move( str.mFormatter ) )
   {
      mMsgid.swap( str.mMsgid );
   }

References str.

TranslatableString() [5/5]

TranslatableString::TranslatableString ( wxString  str )

inlineexplicitprivate

Construct a TranslatableString that does no translation but passes str verbatim.

Definition at line 207 of file TranslatableString.h.

      : mFormatter{ NullContextFormatter }
   {
      mMsgid.swap( str );
   }

References str.

Member Function Documentation

Context() [1/2]

TranslatableString & TranslatableString::Context ( const wxString &  context ) &

inline

Choose a non-default and non-null disambiguating context for lookups.

This is meant to be the first of chain-call modifications of the TranslatableString object; it will destroy any previously captured information

Definition at line 137 of file TranslatableString.h.

   {
      this->mFormatter = [context]
      (const wxString &str, Request request) -> wxString {
         switch ( request ) {
            case Request::Context:
               return context;
            case Request::DebugFormat:
               return DoSubstitute( {}, str, context, true );
            case Request::Format:
            default:
               return DoSubstitute( {}, str, context, false );
         }
      };
      return *this;
   }

References str.

Context() [2/2]

TranslatableString && TranslatableString::Context ( const wxString &  context ) &&

inline

Definition at line 153 of file TranslatableString.h.

   {
      return std::move( Context( context ) );
   }

Debug()

wxString TranslatableString::Debug ( ) const

inline

Format as an English string for debugging logs and developers' eyes, not for end users.

Definition at line 82 of file TranslatableString.h.

{ return DoFormat( true ); }

Referenced by CommandManager::Populator::NewIdentifier(), XMLFileReader::ParseBuffer(), Sequence::Paste(), AUPImportFileHandle::SetError(), and AUPImportFileHandle::SetWarning().

Here is the caller graph for this function:

DoChooseFormat()

wxString TranslatableString::DoChooseFormat ( const Formatter &  formatter, const wxString &  singular, const wxString &  plural, unsigned  nn, bool  debug  )

staticprivate

Definition at line 103 of file TranslatableString.cpp.

{
   // come here for translatable strings that choose among forms by number;
   // if not debugging, then two keys are passed to an overload of
   // wxGetTranslation, and also a number.
   // Some languages might choose among more or fewer than two forms
   // (e.g. Arabic has duals and Russian has complicated declension rules)
   wxString context;
   return ( debug || NullContextName == (context = DoGetContext(formatter)) )
      ? ( nn == 1 ? singular : plural )
      : wxGetTranslation(
            singular, plural, nn
#if HAS_I18N_CONTEXTS
            , wxString{} // domain
            , context
#endif
         );
}

References DoGetContext(), HAS_I18N_CONTEXTS, and NullContextName.

Referenced by TranslatableString::PluralTemp< N >::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

DoFormat()

wxString TranslatableString::DoFormat ( bool  debug ) const

inlineprivate

Definition at line 228 of file TranslatableString.h.

   {  return DoSubstitute(
      mFormatter, mMsgid, DoGetContext(mFormatter), debug ); }

Referenced by TranslateArgument().

Here is the caller graph for this function:

DoGetContext()

wxString TranslatableString::DoGetContext ( const Formatter &  formatter )

staticprivate

Definition at line 89 of file TranslatableString.cpp.

{
   return formatter ? formatter( {}, Request::Context ) : wxString{};
}

References Context.

Referenced by DoChooseFormat(), Format(), IsVerbatim(), Join(), TranslatableString::PluralTemp< N >::operator()(), and Strip().

Here is the caller graph for this function:

DoSubstitute()

wxString TranslatableString::DoSubstitute ( const Formatter &  formatter, const wxString &  format, const wxString &  context, bool  debug  )

staticprivate

Definition at line 94 of file TranslatableString.cpp.

{
   return formatter
      ? formatter( format, debug ? Request::DebugFormat : Request::Format )
      : // come here for most translatable strings, which have no formatting
         ( debug ? format : wxGetTranslation( format, wxString{}, context ) );
}

References DebugFormat, Format, and anonymous_namespace{ExportPCM.cpp}::format.

Referenced by Format(), Join(), and Strip().

Here is the caller graph for this function:

empty()

bool TranslatableString::empty ( ) const

inline

Definition at line 72 of file TranslatableString.h.

{ return mMsgid.empty(); }

Referenced by anonymous_namespace{MenuHelper.cpp}::AddGroupedEffectMenuItems(), ShuttleGuiBase::AddPrompt(), anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), ShuttleGuiBase::AddTitle(), ShuttleGuiBase::AddUnits(), BatchEvalCommand::Apply(), PluginDataModel::ApplyChanges(), ShuttleGuiBase::ApplyItem(), anonymous_namespace{ClipMenus.cpp}::ClipBoundaryMessage(), MessageBoxException::DelayedHandlerAction(), CommandManager::DescribeCommandsAndShortcuts(), ProjectFileManager::DoImport(), EffectUIServices::DoMessageBox(), EQUtils::DoMessageBox(), anonymous_namespace{ClipMenus.cpp}::DoSelectClip(), anonymous_namespace{ProjectFileManager.cpp}::FindHelpUrl(), PopupSubMenu::GetProperties(), LWSlider::GetTip(), LWSlider::GetWidestTips(), CellularPanel::HandleMotion(), Importer::Import(), AUPImportFileHandle::Import(), audacity::cloud::audiocom::sync::LinkAccountDialog::LinkAccountDialog(), MP3Exporter::LoadLibrary(), AudacityCommand::MessageBox(), MessageBoxException::MessageBoxException(), EffectUIHost::OnMenu(), anonymous_namespace{PopupMenuTable.cpp}::PopupMenuBuilder::PopupMenuBuilder(), SelectHandle::Preview(), NyquistBase::ProcessOne(), DBConnection::SetDBError(), AUPImportFileHandle::SetError(), DBConnection::SetError(), ProgressDialog::SetMessage(), EffectPresetsDialog::SetPrefix(), SetupAccessibility(), AUPImportFileHandle::SetWarning(), ShuttleGuiBase::StartStatic(), NumericConverter::UpdateFormatter(), RealtimeEffectStateUI::UpdateTitle(), and EffectPresetsDialog::UpdateUI().

Here is the caller graph for this function:

Format() [1/2]

template<typename... Args>

TranslatableString & TranslatableString::Format ( Args &&...  args ) &

inline

Capture variadic format arguments (by copy) when there is no plural.

The substitution is computed later in a call to Translate() after msgid is looked up in the translation catalog. Any format arguments that are also of type TranslatableString will be translated too at substitution time, for non-debug formatting

Definition at line 103 of file TranslatableString.h.

   {
      auto prevFormatter = mFormatter;
      this->mFormatter = [prevFormatter, args...]
      (const wxString &str, Request request) -> wxString {
         switch ( request ) {
            case Request::Context:
               return TranslatableString::DoGetContext( prevFormatter );
            case Request::Format:
            case Request::DebugFormat:
            default: {
               bool debug = request == Request::DebugFormat;
               return wxString::Format(
                  TranslatableString::DoSubstitute(
                     prevFormatter,
                     str, TranslatableString::DoGetContext( prevFormatter ),
                     debug ),
                  TranslatableString::TranslateArgument( args, debug )...
               );
            }
         }
      };
      return *this;
   }

References DoGetContext(), DoSubstitute(), str, and TranslateArgument().

Referenced by EqualizationBandSliders::AddBandSliders(), CommandManager::DescribeCommandsAndShortcuts(), TrackUtilities::DoMoveTrack(), anonymous_namespace{Contrast.cpp}::FormatRMSMessage(), CommandManager::GetPrefixedLabelFromName(), LWSlider::GetTip(), ThemeBase::LoadOneThemeComponents(), KeyConfigPrefs::OnSet(), PitchName_Absolute(), AboutDialog::PopulateInformationPage(), EffectScienFilter::PopulateOrExchange(), NyquistBase::Process(), ControlToolBar::StateForStatusBar(), and VelocitySliderHandle::Tip().

Here is the call graph for this function:

Here is the caller graph for this function:

Format() [2/2]

template<typename... Args>

TranslatableString && TranslatableString::Format ( Args &&...  args ) &&

inline

Definition at line 128 of file TranslatableString.h.

   {
      return std::move( Format( std::forward<Args>(args)... ) );
   }

IsVerbatim()

bool TranslatableString::IsVerbatim

(

)

const

Returns true if context is NullContextFormatter.

Definition at line 36 of file TranslatableString.cpp.

{
   return DoGetContext( mFormatter ) == NullContextName;
}

References DoGetContext(), mFormatter, and NullContextName.

Here is the call graph for this function:

Join() [1/2]

TranslatableString & TranslatableString::Join	(	TranslatableString	arg,
		const wxString &	separator = {}
	)		&

Append another translatable string.

lookup of msgids for this and for the argument are both delayed until Translate() is invoked on this, and then the formatter concatenates the translations

Definition at line 124 of file TranslatableString.cpp.

{
   auto prevFormatter = mFormatter;
   mFormatter =
   [prevFormatter,
    arg /* = std::move( arg ) */,
    separator](const wxString &str, Request request)
      -> wxString {
      switch ( request ) {
         case Request::Context:
            return TranslatableString::DoGetContext( prevFormatter );
         case Request::Format:
         case Request::DebugFormat:
         default: {
            bool debug = request == Request::DebugFormat;
            return
               TranslatableString::DoSubstitute( prevFormatter,
                  str, TranslatableString::DoGetContext( prevFormatter ),
                  debug )
                  + separator
                  + arg.DoFormat( debug );
         }
      }
   };
   return *this;
}

References DoGetContext(), DoSubstitute(), and str.

Referenced by MacroCommandsCatalog::MacroCommandsCatalog(), SelectHandle::Preview(), PrefsDialog::ShowModal(), and TrackPanel::UpdateStatusMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

Join() [2/2]

TranslatableString && TranslatableString::Join ( TranslatableString  arg, const wxString &  separator = {}  ) &&

inline

Definition at line 164 of file TranslatableString.h.

                                                          {} ) &&
   { return std::move( Join( std::move(arg), separator ) ); }

MSGID()

Identifier TranslatableString::MSGID

(

)

const

MSGID is the English lookup key in the catalog, not necessarily for user's eyes if locale is some other.

The MSGID might not be all the information TranslatableString holds. This is a deliberately ugly-looking function name. Use with caution.

Definition at line 17 of file TranslatableString.cpp.

{
   return Identifier{ mMsgid };
}

References mMsgid.

Referenced by anonymous_namespace{ProjectFileManager.cpp}::FindHelpUrl(), CommandManager::Populator::NewIdentifier(), and AudioUnitEffectOptionsDialog::OnOk().

Here is the caller graph for this function:

operator+=()

TranslatableString & TranslatableString::operator+= ( TranslatableString  arg )

inline

Definition at line 168 of file TranslatableString.h.

   {
      Join( std::move( arg ) );
      return *this;
   }

References Join().

Here is the call graph for this function:

operator=() [1/2]

TranslatableString & TranslatableString::operator= ( const TranslatableString &  )

default

operator=() [2/2]

TranslatableString & TranslatableString::operator= ( TranslatableString &&  str )

inline

Definition at line 65 of file TranslatableString.h.

   {
      mFormatter = std::move( str.mFormatter );
      mMsgid.swap( str.mMsgid );
      return *this;
   }

References str.

Plural()

template<size_t N>

PluralTemp< N > TranslatableString::Plural ( const wxString &  pluralStr ) &&

inline

Implements the XP macro.

That macro specifies a second msgid, a list of format arguments, and which of those format arguments selects among messages; the translated strings to select among, depending on language, might actually be more or fewer than two. See Internat.h.

Definition at line 180 of file TranslatableString.h.

   {
     return PluralTemp< N >{ *this, pluralStr };
   }

Strip() [1/2]

TranslatableString & TranslatableString::Strip

(

unsigned

options = MenuCodes

)

&

Definition at line 41 of file TranslatableString.cpp.

{
   auto prevFormatter = mFormatter;
   mFormatter = [prevFormatter, codes]
   ( const wxString & str, TranslatableString::Request request ) -> wxString {
      switch ( request ) {
         case Request::Context:
            return TranslatableString::DoGetContext( prevFormatter );
         case Request::Format:
         case Request::DebugFormat:
         default: {
            bool debug = request == Request::DebugFormat;
            auto result =
               TranslatableString::DoSubstitute(
                  prevFormatter,
                  str, TranslatableString::DoGetContext( prevFormatter ),
                  debug );
            if ( codes & MenuCodes ) {
               // Don't use this, it's in wxCore
               // result = wxStripMenuCodes( result );
               decltype( result ) temp;
               temp.swap(result);
               for ( auto iter = temp.begin(), end = temp.end();
                    iter != end; ++iter ) {
                  // Stop at trailing hot key name
                  if ( *iter == '\t' )
                     break;
                  // Strip & (unless escaped by another preceding &)
                  if ( *iter == '&' && ++iter == end )
                     break;
                  result.append( 1, *iter );
               }
            }
            if ( codes & Ellipses ) {
               if (result.EndsWith(wxT("...")))
                  result = result.Left( result.length() - 3 );
               // Also check for the single-character Unicode ellipsis
               else if (result.EndsWith(wxT("\u2026")))
                  result = result.Left( result.length() - 1 );
            }
            return result;
         }
      }
   };
   
   return *this;
}

References DoGetContext(), DoSubstitute(), details::end(), str, and wxT().

Referenced by MacroCommandsCatalog::MacroCommandsCatalog(), KeyView::RefreshBindings(), and Stripped().

Here is the call graph for this function:

Here is the caller graph for this function:

Strip() [2/2]

TranslatableString && TranslatableString::Strip ( unsigned  options = MenuCodes ) &&

inline

Definition at line 194 of file TranslatableString.h.

   { return std::move( Strip( options ) ); }

Stripped()

TranslatableString TranslatableString::Stripped ( unsigned  options = MenuCodes ) const

inline

non-mutating, constructs another TranslatableString object

Definition at line 198 of file TranslatableString.h.

   { return TranslatableString{ *this }.Strip( options ); }

References Strip().

Referenced by ShuttleGuiBase::AddCheckBoxOnRight(), ShuttleGuiBase::AddChoice(), BatchEvalCommand::Apply(), ShuttleGuiBase::ApplyItem(), MacroCommands::ApplyMacro(), CommandManager::GetPrefixedLabelFromName(), CommandManager::Populator::NewIdentifier(), ControlToolBar::Populate(), SnappingToolBar::Populate(), AButton::SetLabel(), wxPanelWrapper::SetToolTip(), AButton::SetToolTip(), Grabber::SetToolTip(), AdornedRulerPanel::ShowMenu(), and ComponentInterfaceSymbol::Stripped().

Here is the call graph for this function:

Here is the caller graph for this function:

StrippedTranslation()

wxString TranslatableString::StrippedTranslation ( ) const

inline

Definition at line 201 of file TranslatableString.h.

{ return Stripped().Translation(); }

Referenced by ShuttleGuiBase::AddChoice(), and ShuttleGui::SetMinSize().

Here is the caller graph for this function:

TranslateArgument() [1/3]

template<typename T >

static auto TranslatableString::TranslateArgument ( const std::reference_wrapper< T > &  arg, bool  debug  ) -> decltype( TranslatableString::TranslateArgument( arg.get(), debug ) )

inlinestaticprivate

This allows you to wrap arguments of Format in std::cref.

(So that they are captured (as if) by reference rather than by value)

Definition at line 240 of file TranslatableString.h.

   { return TranslatableString::TranslateArgument( arg.get(), debug ); }

References TranslateArgument().

Here is the call graph for this function:

TranslateArgument() [2/3]

template<typename T >

static const T & TranslatableString::TranslateArgument ( const T &  arg, bool    )

inlinestaticprivate

Definition at line 236 of file TranslatableString.h.

   { return arg; }

Referenced by Format(), TranslatableString::PluralTemp< N >::operator()(), and TranslateArgument().

Here is the caller graph for this function:

TranslateArgument() [3/3]

static wxString TranslatableString::TranslateArgument ( const TranslatableString &  arg, bool  debug  )

inlinestaticprivate

Definition at line 245 of file TranslatableString.h.

   { return arg.DoFormat( debug ); }

References DoFormat().

Here is the call graph for this function:

Translation()

wxString TranslatableString::Translation ( ) const

inline

Definition at line 79 of file TranslatableString.h.

{ return DoFormat( false ); }

Referenced by ShuttleGuiBase::AddButton(), audacity::cloud::audiocom::sync::AudioComDialogBase::AddButton(), ShuttleGuiBase::AddCheckBox(), ShuttleGuiBase::AddCheckBoxOnRight(), ShuttleGuiBase::AddChoice(), ShuttleGuiBase::AddCombo(), ShuttleGuiBase::AddConstTextBox(), ShuttleGuiBase::AddFixedText(), ShuttleGuiBase::AddNumericTextBox(), audacity::cloud::audiocom::sync::AudioComDialogBase::AddParagraph(), ShuttleGuiBase::AddPrompt(), ShuttleGuiBase::AddReadOnlyText(), ShuttleGuiBase::AddSlider(), ShuttleGuiBase::AddSpinControl(), ShuttleGuiBase::AddSpinCtrl(), ShuttleGuiBase::AddTextBox(), ShuttleGuiBase::AddTitle(), ShuttleGuiBase::AddUnits(), ShuttleGuiBase::AddVariableText(), MacroCommands::ApplyCommand(), ShuttleGuiBase::ApplyItem(), AudacityMessageBox(), LV2Editor::BuildPlain(), ProgressDialog::Create(), FileDialogWrapper::Create(), audacity::cloud::audiocom::sync::anonymous_namespace{CloudLocationDialog.cpp}::CreateButton(), ShuttleGuiBase::DoAddRadioButton(), HistoryDialog::DoUpdate(), CommandManager::CommandListEntry::FormatLabelForMenu(), DistortionBase::GetFactoryPresets(), EqualizationBase::GetFactoryPresets(), ReverbBase::GetFactoryPresets(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::GetStringValue(), audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetText(), NyquistBase::GetVersion(), CellularPanel::HandleMotion(), ImportStreamDialog::ImportStreamDialog(), MacroCommandsCatalog::MacroCommandsCatalog(), audacity::cloud::audiocom::sync::MakeClientFailure(), TrackPanelAx::MessageForScreenReader(), MultiDialog::MultiDialog(), TimerRecordDialog::NewPathControl(), DependencyDialog::OnCopyToClipboard(), LinkingHtmlWindow::OnLinkClicked(), TipWindow::OnPaint(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup(), DirectoriesPrefs::OnTempText(), FrequencyPlotDialog::PlotPaint(), SnappingToolBar::Populate(), TranscriptionToolBar::Populate(), AccessibleLinksFormatter::Populate(), LabelDialog::PopulateLabels(), DependencyDialog::PopulateList(), TagsEditorDialog::PopulateOrExchange(), LV2Effect::PopulateUI(), anonymous_namespace{PopupMenuTable.cpp}::PopupMenuBuilder::PopupMenuBuilder(), NyquistBase::Process(), NyquistBase::ProcessOne(), UndoManager::PushState(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectsMenuVisitor::RealtimeEffectsMenuVisitor(), KeyView::RefreshBindings(), SelectFile(), Importer::SetDefaultOpenType(), wxPanelWrapper::SetLabel(), AButton::SetLabel(), wxDialogWrapper::SetLabel(), Importer::SetLastOpenType(), ProgressDialog::SetMessage(), EffectPresetsDialog::SetPrefix(), ProjectManager::SetStatusText(), ProjectStatus::ProjectStatusTextField::SetText(), wxPanelWrapper::SetToolTip(), AButton::SetToolTip(), Grabber::SetToolTip(), ReadOnlyText::SetValue(), AdornedRulerPanel::ShowMenu(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::SnapModePopup(), ShuttleGuiBase::StartStatic(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBoxOnRight(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieIntegerTextBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumberAsChoice(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumericTextBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSlider(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSpinCtrl(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieTextBox(), TipWindow::TipWindow(), TagsEditorDialog::TransferDataToWindow(), TranslationLess(), NyquistBase::UnQuote(), PluginDataModel::UpdateFilter(), and EffectLegacyCompressor::UpdateUI().

Friends And Related Function Documentation

operator!=

bool operator!= ( const TranslatableString &  x, const TranslatableString &  y  )

friend

Definition at line 90 of file TranslatableString.h.

   { return !(x == y); }

operator==

bool operator== ( const TranslatableString &  x, const TranslatableString &  y  )

friend

Warning: comparison of msgids only, which is not all of the information!

This operator makes it easier to define a std::unordered_map on TranslatableStrings

Definition at line 86 of file TranslatableString.h.

   { return x.mMsgid == y.mMsgid; }

Verbatim

TranslatableString Verbatim ( wxString  str )

friend

Require calls to the one-argument constructor to go through this distinct global function name.

This makes it easier to locate and review the uses of this function, separately from the uses of the type.

Definition at line 321 of file TranslatableString.h.

{ return TranslatableString( std::move( str ) ); }

Member Data Documentation

Inaudible

const TranslatableString TranslatableString::Inaudible { wxT("\a") }

static

A special string value that will have no screen reader pronunciation.

Definition at line 38 of file TranslatableString.h.

Referenced by EffectPanel::EffectPanel().

mFormatter

Formatter TranslatableString::mFormatter

private

Definition at line 286 of file TranslatableString.h.

Referenced by IsVerbatim(), and TranslatableString::PluralTemp< N >::operator()().

mMsgid

wxString TranslatableString::mMsgid

private

Definition at line 285 of file TranslatableString.h.

Referenced by MSGID().

NullContextFormatter

const TranslatableString::Formatter TranslatableString::NullContextFormatter

staticprivate

Initial value:

{
   [](const wxString & str, TranslatableString::Request request) -> wxString {
      switch ( request ) {
         case Request::Context:
            return NullContextName;
         case Request::Format:
         case Request::DebugFormat:
         default:
            return str;
      }
   }
}

Definition at line 204 of file TranslatableString.h.

NullContextName

const wxChar *const TranslatableString::NullContextName = wxT("*")

staticprivate

Definition at line 221 of file TranslatableString.h.

Referenced by DoChooseFormat(), and IsVerbatim().

---

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

• TranslatableString.h
• TranslatableString.cpp