Audacity 3.2.0
Typedefs | Functions
HelpText.h File Reference
#include "Identifier.h"
Include dependency graph for HelpText.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

using URLString = TaggedIdentifier< URLStringTag >
 Distinct type for URLs. More...
 

Functions

WX_INIT_API wxString HelpText (const wxString &Key)
 
WX_INIT_API TranslatableString TitleText (const wxString &Key)
 
WX_INIT_API const wxString VerCheckArgs ()
 
WX_INIT_API const URLString VerCheckUrl ()
 
WX_INIT_API const wxString VerCheckHtml ()
 
WX_INIT_API wxString FormatHtmlText (const wxString &Text)
 

Typedef Documentation

◆ URLString

using URLString = TaggedIdentifier< URLStringTag >

Distinct type for URLs.

Definition at line 20 of file HelpText.h.

Function Documentation

◆ FormatHtmlText()

WX_INIT_API wxString FormatHtmlText ( const wxString &  Text)

Definition at line 267 of file HelpText.cpp.

267 {
268
269 wxString localeStr = wxLocale::GetSystemEncodingName();
270
271 return
272 wxT("<html><head><META http-equiv=\"Content-Type\" content=\"text/html; charset=") +
273 localeStr +
274 wxT("\"></head>") +
275 WrapText( LinkExpand( Text ))+
276 wxT("</html>");
277}
wxT("CloseDown"))
static wxString WrapText(const wxString &Text)
Definition: HelpText.cpp:34
static wxString LinkExpand(const wxString &Text)
Definition: HelpText.cpp:77

References LinkExpand(), WrapText(), and wxT().

Referenced by anonymous_namespace{SplashDialog.cpp}::MakeWhatsNewText(), AboutDialog::PopulateAudacityPage(), AboutDialog::PopulateInformationPage(), and AboutDialog::PopulateLicensePage().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HelpText()

WX_INIT_API wxString HelpText ( const wxString &  Key)

Definition at line 247 of file HelpText.cpp.

248{
249
250 // Possible future enhancement...
251 // We could look for the text as a local file and use
252 // that if we find it...
253 // if( wxFileExists( Path+Key ) )
254 // ...
255
256 wxString Text;
257 Text = HelpTextBuiltIn( Key );
258
259 if( !Text.empty())
260 return LinkExpand( Text );
261
262 // Perhaps useful for debugging - we'll return key that we didn't find.
263 return WrapText( Key );
264}
static wxString HelpTextBuiltIn(const wxString &Key)
Definition: HelpText.cpp:192

References HelpTextBuiltIn(), LinkExpand(), and WrapText().

Referenced by ErrorDialog::OnHelp(), ErrorReportDialog::OnHelp(), LinkingHtmlWindow::OnLinkClicked(), SplashDialog::Populate(), and HelpSystem::ShowHelp().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TitleText()

WX_INIT_API TranslatableString TitleText ( const wxString &  Key)

Definition at line 127 of file HelpText.cpp.

128{
129 if(Key==wxT("welcome"))
130 {
131 return XO("Welcome!");
132 }
133
134 if(Key ==wxT("play") )
135 {
136 /* i18n-hint: Title for a topic.*/
137 return XO("Playing Audio");
138 }
139 if((Key ==wxT("record") ) || (Key ==wxT("norecord") ))
140 {
141 /* i18n-hint: Title for a topic.*/
142 return XO("Recording Audio");
143 }
144 if(Key ==wxT("inputdevice") )
145 {
146 /* i18n-hint: Title for a topic.*/
147 return XO("Recording - Choosing the Recording Device");
148 }
149 if(Key ==wxT("inputsource") )
150 {
151 /* i18n-hint: Title for a topic.*/
152 return XO("Recording - Choosing the Recording Source");
153 }
154 if(Key ==wxT("inputlevel") )
155 {
156 /* i18n-hint: Title for a topic.*/
157 return XO("Recording - Setting the Recording Level");
158 }
159 if((Key ==wxT("edit") ) || (Key==wxT("grey")))
160 {
161 /* i18n-hint: Title for a topic.*/
162 return XO("Editing and greyed out Menus");
163 }
164 if(Key ==wxT("export") )
165 {
166 /* i18n-hint: Title for a topic.*/
167 return XO("Exporting an Audio File");
168 }
169 if(Key ==wxT("save") )
170 {
171 /* i18n-hint: Title for a topic.*/
172 return XO("Saving an Audacity Project");
173 }
174 if(Key ==wxT("wma-proprietary") )
175 {
176 /* i18n-hint: Title for a topic.*/
177 return XO("Support for Other Formats");
178 }
179 if(Key ==wxT("burncd") )
180 {
181 /* i18n-hint: Title for a topic.*/
182 return XO("Burn to CD" );
183 }
184 if(Key == wxT("remotehelp") )
185 {
186 return XO("No Local Help");
187 }
188 // Uh oh, no translation...
189 return Verbatim( Key );
190}
XO("Cut/Copy/Paste")
TranslatableString Verbatim(wxString str)
Require calls to the one-argument constructor to go through this distinct global function name.

References Verbatim(), wxT(), and XO().

Referenced by ErrorDialog::OnHelp(), ErrorReportDialog::OnHelp(), and LinkingHtmlWindow::OnLinkClicked().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ VerCheckArgs()

WX_INIT_API const wxString VerCheckArgs ( )

◆ VerCheckHtml()

WX_INIT_API const wxString VerCheckHtml ( )

◆ VerCheckUrl()

WX_INIT_API const URLString VerCheckUrl ( )