Audacity  2.2.0
HelpText.cpp File Reference

Given a key, returns some html. More...

#include <wx/string.h>
#include <wx/intl.h>
#include "Audacity.h"
#include "HelpText.h"
#include "FileNames.h"
#include "AboutDialog.h"
#include "AllThemeResources.h"

Functions

wxString HtmlColourOfIndex (int i)
 
static wxString WrapText (const wxString &Text)
 
static wxString Link (const wxString &Key, const wxString &Text)
 
static wxString WikiLink (const wxString &Key, const wxString &Text)
 
static wxString FileLink (const wxString &Key, const wxString &Text)
 
static wxString TypedLink (const wxString &Key, const wxString &Text)
 
static wxString LinkExpand (const wxString &Text)
 
wxString TitleText (const wxString &Key)
 
static wxString HelpTextBuiltIn (const wxString &Key)
 
wxString HelpText (const wxString &Key)
 
wxString FormatHtmlText (const wxString &Text)
 

Detailed Description

Given a key, returns some html.

Function Documentation

static wxString FileLink ( const wxString &  Key,
const wxString &  Text 
)
static

References FileNames::HtmlHelpDir().

Referenced by LinkExpand().

wxString FormatHtmlText ( const wxString &  Text)
static wxString HelpTextBuiltIn ( const wxString &  Key)
static

TO-DO: Make the links to help here use the widgets/HelpSystem mechanism so that they are consistent

References _(), AUDACITY_VERSION_STRING, VerCheckHtml(), and WrapText().

Referenced by HelpText().

wxString HtmlColourOfIndex ( int  i)

References ThemeBase::Colour(), and theTheme.

Referenced by LinkExpand(), and WrapText().

static wxString Link ( const wxString &  Key,
const wxString &  Text 
)
static
static wxString LinkExpand ( const wxString &  Text)
static
wxString TitleText ( const wxString &  Key)
static wxString TypedLink ( const wxString &  Key,
const wxString &  Text 
)
static

Referenced by LinkExpand().

static wxString WikiLink ( const wxString &  Key,
const wxString &  Text 
)
static

Referenced by LinkExpand().

static wxString WrapText ( const wxString &  Text)
static