## class SG_EXPORT osg::ApplicationUsage

### Public Methods

static ApplicationUsage* instance()
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 UsageMap& getCommandLineOptions() const
void addEnvironmentalVariable(const std::string& option, const std::string& explanation)
const UsageMap& getEnvironmentalVariables() const
void addKeyboardMouseBinding(const std::string& option, const std::string& explanation)
const UsageMap& getKeyboardMouseBindings() const
void getFormatedString(std::string& str, const UsageMap& um, unsigned int widthOfOutput=80)
void write(std::ostream& output, const UsageMap& um, unsigned int widthOfOutput=80)
void write(std::ostream& output, unsigned int type=COMMAND_LINE_OPTION|ENVIRONMENTAL_VARIABLE|KEYBOARD_MOUSE_BINDING, unsigned int widthOfOutput=80)

### Public Members

typedef std::map<std::string,std::string> UsageMap
enum Type

### Protected Fields

std::string _applicationName
std::string _description
std::string _commandLineUsage
UsageMap _commandLineOptions
UsageMap _environmentalVariables
UsageMap _keyboardMouse

## Documentation

`static ApplicationUsage* instance()`

`ApplicationUsage()`

`ApplicationUsage(const std::string& commandLineUsage)`

`typedef std::map<std::string,std::string> UsageMap`

`void setApplicationName(const std::string& name)`

`const std::string& getApplicationName() const`

`void setDescription(const std::string& desc)`

`const std::string& getDescription() const`

`enum Type`

`COMMAND_LINE_OPTION`

`ENVIRONMENTAL_VARIABLE`

`KEYBOARD_MOUSE_BINDING`

`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 UsageMap& getCommandLineOptions() const`

`void addEnvironmentalVariable(const std::string& option, const std::string& explanation)`

`const UsageMap& getEnvironmentalVariables() const`

`void addKeyboardMouseBinding(const std::string& option, const std::string& explanation)`

`const UsageMap& getKeyboardMouseBindings() const`

`void getFormatedString(std::string& str, const UsageMap& um, unsigned int widthOfOutput=80)`

`void write(std::ostream& output, const UsageMap& um, unsigned int widthOfOutput=80)`

`void write(std::ostream& output, unsigned int type=COMMAND_LINE_OPTION|ENVIRONMENTAL_VARIABLE|KEYBOARD_MOUSE_BINDING, unsigned int widthOfOutput=80)`

`std::string _applicationName`

`std::string _description`

`std::string _commandLineUsage`

`UsageMap _commandLineOptions`

`UsageMap _environmentalVariables`

`UsageMap _keyboardMouse`

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.