|
| ||||||||||||||||
| CliCommandMatch (const string& command_name, const string& help_string,
bool is_executable, bool can_pipe)
| CliCommandMatch |
| const string& command_name ()
| command_name |
[const]
Get the command name.
Returns: the command name.
| const string& help_string ()
| help_string |
[const]
Get the help string for the command.
Returns: the help string for the command.
| bool is_executable ()
| is_executable |
[const]
Test if the command is executable.
Returns: true if the command is executable, otherwise false.
| bool can_pipe ()
| can_pipe |
[const]
Test if the command supports pipes.
Returns: true if the command supports pipes, otherwise false.
| bool default_nomore_mode ()
| default_nomore_mode |
[const]
Test if "no-more" (i.e., unpaged) is the default output mode.
Returns: true if "no-more" (i.e., unpaged) is the default output mode, otherwise false.
| void set_default_nomore_mode (bool v)
| set_default_nomore_mode |
Set the default paging mode.
Parameters:
| v | if true, then "no-more" (i.e., unpaged) is the default output mode. |
| bool is_command_argument ()
| is_command_argument |
[const]
Test if the command actually represents a command argument.
Returns: true if the command actually represents a command argument.
| void set_is_command_argument (bool v)
| set_is_command_argument |
Set a flag whether the command actually represents a command argument.
Parameters:
| v | true if the command represents a command argument, otherwise false. |
| bool is_argument_expected ()
| is_argument_expected |
[const]
Test if the command expects an argument.
Returns: true if the command expects an argument, otherwise false.
| void set_is_argument_expected (bool v)
| set_is_argument_expected |
Set a flag whether the command expects an argument.
Parameters:
| v | true if the command expectes an argument, otherwise false. |
| const CliCommand::TypeMatchCb& type_match_cb ()
| type_match_cb |
[const]
Get a reference to the type matching callback.
Returns: a reference to the type matching callback.
| void set_type_match_cb (const CliCommand::TypeMatchCb& cb)
| set_type_match_cb |
Set the type matching callback.
Parameters:
| cb | the type matching callback. |
