WizardHelpKeywords.h File Reference

Which words of a wizard's command a "Help on" button might be offered for. More...

#include <wx/string.h>
#include <vector>

Include dependency graph for WizardHelpKeywords.h:

Go to the source code of this file.

Functions
std::vector< wxString >	wxm::WizardHelpKeywords (const wxString &commandRule)
	The words and operators of a wizard's command rule that might have help.

Detailed Description

Which words of a wizard's command a "Help on" button might be offered for.

Function Documentation

WizardHelpKeywords()

std::vector< wxString > wxm::WizardHelpKeywords

(

const wxString &

commandRule

)

The words and operators of a wizard's command rule that might have help.

commandRule is the template the wizard fills in, e.g. "ode2(#1#,#2#,#3#);". The result lists, in the order they first appear and each once, every identifier ("ode2") and every operator the manual might document ("'", "''", "!", "#", "\\", and ";" or "$" when they separate two statements). Whether the manual actually has an entry for each of them is for the caller to check: this only does the text analysis, so it can be tested without a manual. Two things this deliberately leaves out: - The "#1#", "#2#", ... placeholders: they become the user's input. - The ";" or "$" that ends the command. Every wizard's command ends with one, so offering help on it says nothing about this particular wizard – and the Solve ODE wizard used to offer nothing else, since its "ode2" contains a digit and wasn't recognized as a word at all.