Public Types | |
typedef std::map< std::string, std::string > | UsageMap |
enum | Type { COMMAND_LINE_OPTION = 0x1, ENVIRONMENTAL_VARIABLE = 0x2, KEYBOARD_MOUSE_BINDING = 0x4 } |
Public Member Functions | |
ApplicationUsage () | |
ApplicationUsage (const std::string &commandLineUsage) | |
void | setApplicationName (const std::string &name) |
const std::string & | getApplicationName () const |
void | setDescription (const std::string &desc) |
const std::string & | getDescription () const |
void | addUsageExplanation (Type type, const std::string &option, const std::string &explanation) |
void | setCommandLineUsage (const std::string &explanation) |
const std::string & | getCommandLineUsage () const |
void | addCommandLineOption (const std::string &option, const std::string &explanation, const std::string &defaultValue="") |
void | setCommandLineOptions (const UsageMap &usageMap) |
const UsageMap & | getCommandLineOptions () const |
void | setCommandLineOptionsDefaults (const UsageMap &usageMap) |
const UsageMap & | getCommandLineOptionsDefaults () const |
void | addEnvironmentalVariable (const std::string &option, const std::string &explanation, const std::string &defaultValue="") |
void | setEnvironmentalVariables (const UsageMap &usageMap) |
const UsageMap & | getEnvironmentalVariables () const |
void | setEnvironmentalVariablesDefaults (const UsageMap &usageMap) |
const UsageMap & | getEnvironmentalVariablesDefaults () const |
void | addKeyboardMouseBinding (const std::string &option, const std::string &explanation) |
void | setKeyboardMouseBindings (const UsageMap &usageMap) |
const UsageMap & | getKeyboardMouseBindings () const |
void | getFormattedString (std::string &str, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap()) |
void | write (std::ostream &output, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap()) |
void | write (std::ostream &output, unsigned int type=COMMAND_LINE_OPTION, unsigned int widthOfOutput=80, bool showDefaults=false) |
void | writeEnvironmentSettings (std::ostream &output) |
Static Public Member Functions | |
ApplicationUsage * | instance () |
Protected Attributes | |
std::string | _applicationName |
std::string | _description |
std::string | _commandLineUsage |
UsageMap | _commandLineOptions |
UsageMap | _environmentalVariables |
UsageMap | _keyboardMouse |
UsageMap | _environmentalVariablesDefaults |
UsageMap | _commandLineOptionsDefaults |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|