kaycxx-cli
C++ CLI library
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
kaycxx::cli::flag_handle Class Reference

Handle for a registered flag. More...

#include <kaycxx/cli/flag_handle.hpp>

Public Member Functions

flag_handle action () noexcept
 Marks the flag as a mutually exclusive command action.
 
switch_base constdefinition () const noexcept
 Returns the underlying flag definition.
 

Friends

class command
 

Detailed Description

Handle for a registered flag.

The handle does not own the flag definition. It references data owned by the command that created it.

Member Function Documentation

◆ action()

flag_handle kaycxx::cli::flag_handle::action ( )
inlinenoexcept

Marks the flag as a mutually exclusive command action.

Returns
This handle for chaining.

◆ definition()

switch_base const & kaycxx::cli::flag_handle::definition ( ) const
inlinenoexcept

Returns the underlying flag definition.

Returns
Flag definition owned by the command.

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