ArgumentCompleter.h File Reference

Definition of the orxonox::ArgumentCompleter class that is used to execute argument completion functions. More...

#include "core/CorePrereqs.h"
#include "ArgumentCompletionListElement.h"

Go to the source code of this file.

Classes
class	orxonox::ArgumentCompleter
	This class executes an argument completion function and returns a list of the possible arguments. More...

Namespaces
	orxonox
	Die Wagnis Klasse hat die folgenden Aufgaben:

Detailed Description

Definition of the orxonox::ArgumentCompleter class that is used to execute argument completion functions.

An ArgumentCompleter can be assigned to an orxonox::ConsoleCommand using argumentCompleter(). The ArgumentCompleter calls an argument completion function that is defined in ArgumentCompletionFunctions.h. This can be used to list possible arguments for console commands and to allow auto-completion.

Instances of ArgumentCompleter are usually not created manually but rather by the macros defined in ArgumentCompletionFunctions.h. There you'll also find some examples.

See also

See the examples.