cli/flag_8hpp_source.html

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>

// SPDX-License-Identifier: MIT


#pragma once


#include <string>


#include <kaycxx/cli/switch_base.hpp>


namespace kaycxx::cli {


class flag : public switch_base {

public:

    using switch_base::switch_base;


    [[nodiscard]] std::string usage() const override;


    [[nodiscard]] bool expects_value() const noexcept override;

};


} // namespace kaycxx::cli

kaycxx::cli::flag
Command line flag definition.
Definition flag.hpp:22

kaycxx::cli::flag::expects_value
bool expects_value() const noexcept override
Checks whether this flag expects a value.

kaycxx::cli::flag::usage
std::string usage() const override
Returns generated help usage for this flag.

kaycxx::cli::option_handle
Handle for a registered option.
Definition option_handle.hpp:25

kaycxx::cli::switch_base
Common base class for command line switches.
Definition switch_base.hpp:22

kaycxx::cli::switch_base::switch_base
switch_base(std::string_view name, std::optional< std::string_view > description=std::nullopt)
Creates a switch without a short alias.

switch_base.hpp
Defines the common base class for flags and options.