All Functions and Procedures
| Name | Unit | Description |
|---|---|---|
| AppendToArray | Command.Helpers | Appends a string to an array of string automatically increasing its size |
| ChangeConsoleColor | Command.Colors | Changes default console color for text output. |
| ColorConsoleOutput | Command.Builder | Standard callback procedure that outputs the given text to the console using colors. In this implementation it only mirrors the use of the Write function, but before that it changes the color of the console. It is expected for this type of callback that the output is performed without a line break at the end of it. The original color is not restored impacting future outputs. |
| GetArgumentList | Command.Usage | Returns an argument list configured for CommandBuilder as a simple string. It will be used to display argument usage info to the user. |
| OutputPalleteColor | Command.Colors | This command outputs text for each color represented by the constant colors in this unit. You may add this command to the application using TCommandBuilder.AddCommand, so you can check how a given color is displayed on console. There is sample app called colors on the source code repository that shows how this command works. |
| Registry | Command.Usage | Configure UsageCommand with standard parameters. |
| Registry | Command.Version | Configure VersionCommand with standard parameters. |
| RemoveStartingDashes | Command.Helpers | Removes the first "-" and second "-" characters if found from the string passed as a parameter. Returns a new string without these characters. |
| SplitOptionAndValue | Command.Helpers | Given an option with value, split the option in two parts: the option name and the value. The option name is the part before the "=" character. The value is the part after the "=" character. If the option doesn't contain the "=" character, the value is empty. The function returns the value and keeps the only the option name in the parameter AOption. |
| StandardConsoleInputLn | Command.Builder | Standard callback function to read input from user. Automatically configured on CommandBuilder startup. |
| StandardConsoleOutput | Command.Builder | Standard callback procedure that outputs the given text to the console. In this implementation it just mirrors the use of the WriteLn function. It is expected for this type of callback that the output will be performed with a line break at the end of it. |
| UsageCommand | Command.Usage | Outputs text describing command usage according to commands, options and arguments configured using application command builder. If a different color theme is specified to the TCommandBuilder.ColorTheme, this command displays the usage info in different colors. |
| VersionCommand | Command.Version | Outputs application version information that was incorporated after the application was built. |
| WriteCommandUsage | Command.Usage | Outputs full usage information for a specific command. It´s used when the user requests help for a specific command. |
| WriteGeneralUsage | Command.Usage | Outputs general help information for the application, including command usage syntax, command list, command description, arguments that are acceptable. Also displays application title and version information. |
| WriteUsage | Command.Usage | Outputs simple usage command using provided parameters for the command provided. Display the usage in the following format 'EXECUTABLE [command] [options]'. |
Generated by PasDoc 0.16.0.