JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::ConsoleApplication::Command Struct Reference

Represents a command that can be executed if its command-line arguments are matched. More...

#include <juce_ConsoleApplication.h>

Collaboration diagram for juce::ConsoleApplication::Command:

Public Attributes

String argumentDescription
 A description of the command-line arguments needed for this command, which will be printed as part of the help text. More...
 
std::function< void(const ArgumentList &)> command
 The actual command that should be invoked to perform this action. More...
 
String commandOption
 The option string that must appear in the argument list for this command to be invoked. More...
 
String longDescription
 A longer description of this command, for use in extended help. More...
 
String shortDescription
 A short (one line) description of this command, which can be printed by ConsoleApplication::printCommandList(). More...
 

Detailed Description

Represents a command that can be executed if its command-line arguments are matched.

See also
ConsoleApplication::addCommand(), ConsoleApplication::findAndRunCommand()

@tags{Core}

Member Data Documentation

◆ argumentDescription

String juce::ConsoleApplication::Command::argumentDescription

A description of the command-line arguments needed for this command, which will be printed as part of the help text.

◆ command

std::function<void (const ArgumentList&)> juce::ConsoleApplication::Command::command

The actual command that should be invoked to perform this action.

◆ commandOption

String juce::ConsoleApplication::Command::commandOption

The option string that must appear in the argument list for this command to be invoked.

This can also be a list of different versions separated by pipes, e.g. "--help|-h"

◆ longDescription

String juce::ConsoleApplication::Command::longDescription

A longer description of this command, for use in extended help.

◆ shortDescription

String juce::ConsoleApplication::Command::shortDescription

A short (one line) description of this command, which can be printed by ConsoleApplication::printCommandList().


The documentation for this struct was generated from the following file: