AccessibleLinksFormatter.h

Go to the documentation of this file.

/*!********************************************************************
 
 Audacity: A Digital Audio Editor
 
 @file AccessibleLinksFormatter.h
 @brief Define a helper class to format text with link in a way, accessible to VI users.
 
 Dmitry Vedenko
 **********************************************************************/
 
#pragma once
 
#include <functional>
#include <vector>
 
#include "TranslatableString.h"
 
class ShuttleGui;
 
class WX_INIT_API AccessibleLinksFormatter final
{
public:
   using LinkClickedHandler = std::function<void()>;
 
   explicit AccessibleLinksFormatter(TranslatableString message);
 
   AccessibleLinksFormatter& FormatLink(
      wxString placeholder, TranslatableString value, std::string targetURL);
   
   AccessibleLinksFormatter& FormatLink(
      wxString placeholder, TranslatableString value,
      LinkClickedHandler handler);
 
   void Populate(ShuttleGui& S) const;
private:
   struct FormatArgument final
   {
      wxString Placeholder;
      TranslatableString Value;
 
      LinkClickedHandler Handler;
      std::string TargetURL;
   };
 
   struct ProcessedArgument final
   {
      const FormatArgument* Argument { nullptr };
      size_t PlaceholderPosition { wxString::npos };
   };
 
   /* Find the positions of the placeholders and sort 
    * arguments according to the positions. 
    */
   std::vector<ProcessedArgument>
   ProcessArguments(wxString translatedMessage) const;
 
   TranslatableString mMessage;
   std::vector<FormatArgument> mFormatArguments;
};