C++ Utilities  4.17.0
Useful C++ classes and routines such as argument parser, IO and conversion utilities
Public Member Functions | Public Attributes | List of all members
ApplicationUtilities::ArgumentCompletionInfo Struct Reference

The ArgumentCompletionInfo struct holds information internally used for shell completion and suggestions. More...

Collaboration diagram for ApplicationUtilities::ArgumentCompletionInfo:
[legend]

Public Member Functions

 ArgumentCompletionInfo (const ArgumentReader &reader)
 Constructs a new completion info for the specified reader. More...
 

Public Attributes

const Argument *const lastDetectedArg
 
size_t lastDetectedArgIndex = 0
 
vector< Argument * > lastDetectedArgPath
 
list< const Argument * > relevantArgs
 
list< const Argument * > relevantPreDefinedValues
 
const char *const * lastSpecifiedArg = nullptr
 
unsigned int lastSpecifiedArgIndex = 0
 
bool nextArgumentOrValue = false
 
bool completeFiles = false
 
bool completeDirs = false
 

Detailed Description

The ArgumentCompletionInfo struct holds information internally used for shell completion and suggestions.

Definition at line 44 of file argumentparser.cpp.

Constructor & Destructor Documentation

◆ ArgumentCompletionInfo()

ApplicationUtilities::ArgumentCompletionInfo::ArgumentCompletionInfo ( const ArgumentReader reader)

Constructs a new completion info for the specified reader.

Remarks
Only assigns some defaults. Use ArgumentParser::determineCompletionInfo() to populate the struct with actual data.

Definition at line 62 of file argumentparser.cpp.

Member Data Documentation

◆ completeDirs

bool ApplicationUtilities::ArgumentCompletionInfo::completeDirs = false

Definition at line 55 of file argumentparser.cpp.

◆ completeFiles

bool ApplicationUtilities::ArgumentCompletionInfo::completeFiles = false

Definition at line 55 of file argumentparser.cpp.

◆ lastDetectedArg

const Argument* const ApplicationUtilities::ArgumentCompletionInfo::lastDetectedArg

Definition at line 47 of file argumentparser.cpp.

◆ lastDetectedArgIndex

size_t ApplicationUtilities::ArgumentCompletionInfo::lastDetectedArgIndex = 0

Definition at line 48 of file argumentparser.cpp.

◆ lastDetectedArgPath

vector<Argument *> ApplicationUtilities::ArgumentCompletionInfo::lastDetectedArgPath

Definition at line 49 of file argumentparser.cpp.

◆ lastSpecifiedArg

const char* const* ApplicationUtilities::ArgumentCompletionInfo::lastSpecifiedArg = nullptr

Definition at line 52 of file argumentparser.cpp.

◆ lastSpecifiedArgIndex

unsigned int ApplicationUtilities::ArgumentCompletionInfo::lastSpecifiedArgIndex = 0

Definition at line 53 of file argumentparser.cpp.

◆ nextArgumentOrValue

bool ApplicationUtilities::ArgumentCompletionInfo::nextArgumentOrValue = false

Definition at line 54 of file argumentparser.cpp.

◆ relevantArgs

list<const Argument *> ApplicationUtilities::ArgumentCompletionInfo::relevantArgs

Definition at line 50 of file argumentparser.cpp.

◆ relevantPreDefinedValues

list<const Argument *> ApplicationUtilities::ArgumentCompletionInfo::relevantPreDefinedValues

Definition at line 51 of file argumentparser.cpp.


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