This class is used in argument completion lists and contains up to three different strings, used in different situations.
More...
#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/command/ArgumentCompletionListElement.h>
This class is used in argument completion lists and contains up to three different strings, used in different situations.
A list containing elements of type ArgumentCompletionListElement is returned by an argument completion function. These elements are composed of up to three strings with different usage:
- normal: What is used as the actual argument
- comparable: What is used to compere the argument to the input of the user (usually lowercase, except for case-sensitive arguments)
- display: This is displayed in the list of possible arguments - can differ from what is actually used for better readability
orxonox::ArgumentCompletionListElement::ArgumentCompletionListElement |
( |
const std::string & |
normalcase | ) |
|
|
inline |
Constructor: Normal, comparable, and display string are all the same.
orxonox::ArgumentCompletionListElement::ArgumentCompletionListElement |
( |
const std::string & |
normalcase, |
|
|
const std::string & |
lowercase |
|
) |
| |
|
inline |
Constructor: Normal and display string are the same, a different (usually lowercase) string is used for comparison.
orxonox::ArgumentCompletionListElement::ArgumentCompletionListElement |
( |
const std::string & |
normalcase, |
|
|
const std::string & |
lowercase, |
|
|
const std::string & |
display |
|
) |
| |
|
inline |
Constructor: Normal, comparable, and display are all different strings.
const std::string& orxonox::ArgumentCompletionListElement::getComparable |
( |
| ) |
const |
|
inline |
Returns the comparable string which is used to compare arguments and user input.
const std::string& orxonox::ArgumentCompletionListElement::getDisplay |
( |
| ) |
const |
|
inline |
Returns the display string which is used in the displayed list of possible arguments.
const std::string& orxonox::ArgumentCompletionListElement::getString |
( |
| ) |
const |
|
inline |
Returns the normal string which is used as the actual argument.
bool orxonox::ArgumentCompletionListElement::hasComparable |
( |
| ) |
const |
|
inline |
Returns true if there's a different string for comparison.
bool orxonox::ArgumentCompletionListElement::hasDisplay |
( |
| ) |
const |
|
inline |
Returns true if there's a different string to display.
Overloaded operator for usage in maps and sets.
std::string orxonox::ArgumentCompletionListElement::comparable_ |
|
private |
The comparable (usually lowercase) string.
std::string orxonox::ArgumentCompletionListElement::display_ |
|
private |
unsigned char orxonox::ArgumentCompletionListElement::mode_ |
|
private |
std::string orxonox::ArgumentCompletionListElement::normal_ |
|
private |
The documentation for this class was generated from the following file: