gnc-option.hpp File Reference

C++ Public interface for individual options. More...

#include <glib.h>
#include <any>
#include <string>
#include <iostream>
#include <iomanip>
#include <type_traits>
#include <variant>
#include <memory>
#include <tuple>
#include "gnc-option-ui.hpp"
#include "gnc-option-date.hpp"
#include "guid.hpp"

Go to the source code of this file.

Data Structures
class	GncOptionValue< ValueType >
	The generic option-value class. More...
class	GncOptionRangeValue< ValueType >
	Used for numeric ranges and plot sizes. More...
struct	is_OptionClassifier< T >
struct	is_same_decayed< T, U >
struct	is_RangeValue< T >
class	GncOption
	Represents the public interface for an option. More...

Typedefs
using	GncOptionUIItemPtr = std::unique_ptr< GncOptionUIItem >
using	GncOwner = _gncOwner
using	QofQuery = _QofQuery
	A Query.
using	QofInstance = QofInstance_s
using	GncOptionDateFormat = std::tuple< QofDateFormat, GNCDateMonthFormat, bool, std::string >
using	GncOptionReportPlacement = std::tuple< uint32_t, uint32_t, uint32_t >
using	GncOptionReportPlacementVec = std::vector< GncOptionReportPlacement >
using	GncOptionVariant = std::variant< GncOptionValue< std::string >, GncOptionValue< bool >, GncOptionValue< int64_t >, GncOptionQofInstanceValue, GncOptionGncOwnerValue, GncOptionValue< const QofQuery * >, GncOptionValue< GncOptionReportPlacementVec >, GncOptionAccountListValue, GncOptionAccountSelValue, GncOptionMultichoiceValue, GncOptionRangeValue< int >, GncOptionRangeValue< double >, GncOptionCommodityValue, GncOptionDateValue, GncOptionValue< GncOptionDateFormat > >
using	GncOptionVariantPtr = std::unique_ptr< GncOptionVariant >

Enumerations
enum	GncOptionMultichoiceKeyType { SYMBOL, STRING, NUMBER }

Functions
bool	operator< (const GncOption &right, const GncOption &left)
std::ostream &	operator<< (std::ostream &oss, const GncOption &opt)
std::istream &	operator>> (std::istream &iss, GncOption &opt)
std::ostream &	output_color_value (std::ostream &oss, const std::string &value)
template<typename ValueType >
GncOption *	gnc_make_option (const char *section, const char *name, const char *key, const char *doc_string, ValueType value, GncOptionUIType ui_type)
	Free function wrapping GncOption's constructor. More...

Variables
template<typename T >
constexpr bool	is_OptionClassifier_v = is_OptionClassifier<T>::value
template<typename T , typename U >
constexpr bool	is_same_decayed_v = is_same_decayed<T, U>::value
template<typename T >
constexpr bool	is_RangeValue_v = is_RangeValue<T>::value

Detailed Description

C++ Public interface for individual options.

Author

Copyright 2020-2021 John Ralls jrall.nosp@m.s@ce.nosp@m.ridwe.nosp@m.n.us

Definition in file gnc-option.hpp.