Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 3 and Version 4 of code/doc/ArgumentCompletionFunctions


Ignore:
Timestamp:
Apr 12, 2017, 10:32:47 PM (3 years ago)
Author:
landauf
Comment:

fixed links

Legend:

Unmodified
Added
Removed
Modified
  • code/doc/ArgumentCompletionFunctions

    v3 v4  
    11= !ArgumentCompletionFunctions =
    2 [[TracNav(TracNav/TOC_Development)]]
    32
    43== Description ==
    5 An ArgumentCompletionFunction returns an [wiki:ArgumentCompletionList] used by the [wiki:CommandExecutor] to complete arguments of a [wiki:ConsoleCommand]. To bind an ArgumentCompletionFunction to an argument, an [wiki:ArgumentCompleter] is use.
     4An !ArgumentCompletionFunction returns an [wiki:ArgumentCompletionList] used by the [wiki:CommandExecutor] to complete arguments of a [wiki:ConsoleCommand]. To bind an !ArgumentCompletionFunction to an argument, an [wiki:ArgumentCompleter] is use.
    65
    76== Arguments ==
    8 An ArgumentCompletionFunction may take several parameters. The first parameter is the currently given argument fragment, the second parameter is the last finished argument, the third parameter is the second last finished argument etc.
     7An !ArgumentCompletionFunction may take several parameters. The first parameter is the currently given argument fragment, the second parameter is the last finished argument, the third parameter is the second last finished argument etc.
    98
    109Example:
     
    1514}}}
    1615
    17 Then the ArgumentCompletionFunction of the fourth argument gets called the following way:
     16Then the !ArgumentCompletionFunction of the fourth argument gets called the following way:
    1817{{{
    1918ac_function(fragment, argument3, argument2, argument1);
     
    2322
    2423== Usage ==
    25 === Defining a new ArgumentCompletionFunction ===
     24=== Defining a new !ArgumentCompletionFunction ===
    2625In {{{core/ArgumentCompletionFunctions.h}}} write:
    2726{{{
     
    3332}}}
    3433
    35 === Implementing a new ArgumentCompletionFunction ===
     34=== Implementing a new !ArgumentCompletionFunction ===
    3635In {{{core/ArgumentCompletionFunctions.cc}}} write:
    3736{{{
     
    5958}
    6059}}}
    61 Note: ''lowercase'' and ''display'' in the constructor of ArgumentCompletionListElement are optional. If not specified, the first string (''argument'') is used.
     60Note: ''lowercase'' and ''display'' in the constructor of !ArgumentCompletionListElement are optional. If not specified, the first string (''argument'') is used.
    6261
    6362== Example ==