Options

GnuCash Options System for Book, Report, and Stylesheet Options. More...

Files
file	gnc-option-date.hpp
	Relative date enumeration and manipulation functions.
file	gnc-option-impl.hpp
	Implementation templates and specializtions for GncOption values.
file	gnc-option-uitype.hpp
	OptionUITypes.
file	gnc-option.hpp
	C++ Public interface for individual options.
file	gnc-optiondb-impl.hpp
	Implementation details for GncOptionDB.
file	gnc-optiondb.h
	C public interface for the Options Database.
file	gnc-optiondb.hpp
	The primary C++ interface to options for books, reports, and stylesheets.

Data Structures
struct	OptionClassifier
	This class is the parent of all option implementations. More...
class	GncOptionValue< ValueType >
	The generic option-value class. More...
struct	GncOwnerDeleter
	class GncOptionGncOwnerValue More...
class	GncOptionGncOwnerValue
class	GncOptionQofInstanceValue
class	GncOptionCommodityValue
	class GncOptionCommodityValue Commodities are stored with their namespace and mnemonic instead of their gncGUID so that they can be correctly retrieved even if they're deleted and recreated. More...
struct	is_GncOwnerValue< T >
struct	is_QofInstanceValue< T >
struct	is_QofQueryValue< T >
class	GncOptionRangeValue< ValueType >
	Used for numeric ranges and plot sizes. More...
class	GncOptionMultichoiceValue
	Multichoice options have a vector of valid options (GncMultichoiceOptionChoices) and validate the selection as being one of those values. More...
class	GncOptionAccountListValue
	Set one or more accounts on which to report, optionally restricted to certain account types. More...
class	GncOptionAccountSelValue
class	GncOptionDateValue
	A legal date value is a pair of either a RelativeDatePeriod, the absolute flag and a time64, or for legacy purposes the absolute flag and a timespec. 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...
class	GncOptionSection
	class GncOptionSection The upper-level classification implementation. More...
struct	GncOptionDBCallback
class	GncOptionDB
	Holds all of the options for a book, report, or stylesheet, organized by GncOptionSections. More...

Typedefs
using	RelativeDatePeriodVec = std::vector< RelativeDatePeriod >
using	GncOwnerPtr = std::unique_ptr< GncOwner, GncOwnerDeleter >
using	GncItem = std::pair< QofIdTypeConst, GncGUID >
	class GncOptionQofinstanceValue More...
using	GncMultichoiceOptionEntry = std::tuple< const std::string, const std::string, GncOptionMultichoiceKeyType >
using	GncMultichoiceOptionIndexVec = std::vector< uint16_t >
using	GncMultichoiceOptionChoices = std::vector< GncMultichoiceOptionEntry >
using	GncOptionAccountList = std::vector< GncGUID >
using	GncOptionAccountTypeList = std::vector< GNCAccountType >
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 >
using	GncOptionVec = std::vector< GncOption >
using	GncOptionSectionPtr = std::shared_ptr< GncOptionSection >
using	GncOptionDBChangeCallback = void(*)(void *user_data)
using	GncCallbackVec = std::vector< GncOptionDBCallback >
using	GncOptionDBPtr = std::unique_ptr< GncOptionDB >
using	GncOptionAccountList = std::vector< GncGUID >
using	GncOptionAccountTypeList = std::vector< GNCAccountType >
using	GncMultichoiceOptionEntry = std::tuple< const std::string, const std::string, GncOptionMultichoiceKeyType >
using	GncMultichoiceOptionChoices = std::vector< GncMultichoiceOptionEntry >

Enumerations
enum	RelativeDatePeriod : int {   ABSOLUTE = -1, TODAY, ONE_WEEK_AGO, ONE_WEEK_AHEAD,   ONE_MONTH_AGO, ONE_MONTH_AHEAD, THREE_MONTHS_AGO, THREE_MONTHS_AHEAD,   SIX_MONTHS_AGO, SIX_MONTHS_AHEAD, ONE_YEAR_AGO, ONE_YEAR_AHEAD,   START_THIS_MONTH, END_THIS_MONTH, START_PREV_MONTH, END_PREV_MONTH,   START_NEXT_MONTH, END_NEXT_MONTH, START_CURRENT_QUARTER, END_CURRENT_QUARTER,   START_PREV_QUARTER, END_PREV_QUARTER, START_NEXT_QUARTER, END_NEXT_QUARTER,   START_CAL_YEAR, END_CAL_YEAR, START_PREV_YEAR, END_PREV_YEAR,   START_NEXT_YEAR, END_NEXT_YEAR, START_ACCOUNTING_PERIOD, END_ACCOUNTING_PERIOD }
	Reporting periods relative to the current date. More...
enum	GncOptionUIType : unsigned int {   INTERNAL, BOOLEAN, STRING, TEXT,   CURRENCY, COMMODITY, MULTICHOICE, DATE_ABSOLUTE,   DATE_RELATIVE, DATE_BOTH, ACCOUNT_LIST, ACCOUNT_SEL,   LIST, NUMBER_RANGE, COLOR, FONT,   PLOT_SIZE, BUDGET, PIXMAP, RADIOBUTTON,   DATE_FORMAT, OWNER, CUSTOMER, VENDOR,   EMPLOYEE, INVOICE, JOB, TAX_TABLE,   INV_REPORT, QUERY, REPORT_PLACEMENT, MAX_VALUE }
	Used by GncOptionClassifier to indicate to dialog-options what control should be displayed for the option.
enum	GncOptionMultichoiceKeyType { SYMBOL, STRING, NUMBER }
enum	RelativeDateUI : uint8_t { ABSOLUTE, RELATIVE, BOTH }

Functions
bool	gnc_relative_date_is_single (RelativeDatePeriod)
	Report whether the relative date represents a period offset to today's date rather than the beginning or end of a date range. More...
bool	gnc_relative_date_is_starting (RelativeDatePeriod)
	Report whether the relative date represents the beginning of a date range. More...
bool	gnc_relative_date_is_ending (RelativeDatePeriod)
	Report whether the relative date represents the end of a date range. More...
const char *	gnc_relative_date_storage_string (RelativeDatePeriod)
	Provide the string representation of a relative date for persisting the value. More...
const char *	gnc_relative_date_display_string (RelativeDatePeriod)
	Provide the string representation of a relative date for displaying value to a user. More...
const char *	gnc_relative_date_description (RelativeDatePeriod)
	Provide the description of a relative date. More...
RelativeDatePeriod	gnc_relative_date_from_storage_string (const char *)
	Convert a relative date storage string back to a RelativeDatePeriod value. More...
time64	gnc_relative_date_to_time64 (RelativeDatePeriod)
	Convert a RelativeDatePeriod value to a concrete time64 by applying the value to the current time. More...
std::ostream &	operator<< (std::ostream &, const RelativeDatePeriod)
	Add the display string to the provided std::ostream. More...
QofInstance *	qof_instance_from_string (const std::string &str, GncOptionUIType type)
QofInstance *	qof_instance_from_guid (GncGUID *, GncOptionUIType type)
std::string	qof_instance_to_string (const QofInstance *inst)
template<class OptType , typename std::enable_if_t< is_OptionClassifier_v< OptType > &&!(is_QofInstanceValue_v< OptType >||is_RangeValue_v< OptType >), int > = 0>
std::ostream &	operator<< (std::ostream &oss, const OptType &opt)
template<>
std::ostream &	operator<<< GncOptionValue< bool >> (std::ostream &oss, const GncOptionValue< bool > &opt)
std::ostream &	operator<< (std::ostream &oss, const GncOptionCommodityValue &opt)
template<class OptType , typename std::enable_if_t< is_OptionClassifier_v< OptType > &&!(is_QofInstanceValue_v< OptType >||is_RangeValue_v< OptType >), int > = 0>
std::istream &	operator>> (std::istream &iss, OptType &opt)
std::istream &	operator>> (std::istream &iss, GncOptionCommodityValue &opt)
template<>
std::istream &	operator>>< GncOptionValue< bool >> (std::istream &iss, GncOptionValue< bool > &opt)
template<>
std::istream &	operator>>< GncOptionValue< GncOptionReportPlacementVec >> (std::istream &iss, GncOptionValue< GncOptionReportPlacementVec > &opt)
template<>
std::ostream &	operator<<< GncOptionMultichoiceValue > (std::ostream &oss, const GncOptionMultichoiceValue &opt)
template<>
std::istream &	operator>>< GncOptionMultichoiceValue > (std::istream &iss, GncOptionMultichoiceValue &opt)
template<>
std::ostream &	operator<<< GncOptionAccountListValue > (std::ostream &oss, const GncOptionAccountListValue &opt)
template<>
std::istream &	operator>>< GncOptionAccountListValue > (std::istream &iss, GncOptionAccountListValue &opt)
template<>
std::ostream &	operator<<< GncOptionAccountSelValue > (std::ostream &oss, const GncOptionAccountSelValue &opt)
template<>
std::istream &	operator>>< GncOptionAccountSelValue > (std::istream &iss, GncOptionAccountSelValue &opt)
template<>
std::ostream &	operator<<< GncOptionDateValue > (std::ostream &oss, const GncOptionDateValue &opt)
template<>
std::istream &	operator>>< GncOptionDateValue > (std::istream &iss, GncOptionDateValue &opt)
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...
bool	operator< (const GncOptionSectionPtr &right, const GncOptionSectionPtr &left)
GncOptionDB *	gnc_option_db_new (void)
	Create an empty option database. More...
void	gnc_option_db_destroy (GncOptionDB *odb)
	Destruct and release a GncOptionDB. More...
GList *	gnc_option_db_commit (GncOptionDB *odb)
	Write all changed ui_item values to their options. More...
void	gnc_option_db_clean (GncOptionDB *odb)
	Reset all ui_items to the option value. More...
void	gnc_option_db_load (GncOptionDB *odb, QofBook *book)
	Load a book's options into the GncOptionDB. More...
void	gnc_option_db_save (GncOptionDB *odb, QofBook *book, gboolean clear_options)
	Save the GncOptionDB contents into a book's options store. More...
void	gnc_option_db_book_options (GncOptionDB *)
	Register the standard option set for a QofBook. More...
const QofInstance *	gnc_option_db_lookup_qofinstance_value (GncOptionDB *, const char *, const char *)
	Retrieve the QofInstance value of an option in the GncOptionDB. More...
GncOptionAccountList	gnc_account_list_from_types (QofBook *book, const GncOptionAccountTypeList &types)
	Extract a list of accounts in the book having one of the GNCAccountTypes in types. More...
void	gnc_register_string_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new string option and register it in the options database. More...
void	gnc_register_string_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_text_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new text option and register it in the options database. More...
void	gnc_register_text_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_font_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new font option and register it in the options database. More...
void	gnc_register_font_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_budget_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, GncBudget *value)
	Create a new budget option and register it in the options database. More...
void	gnc_register_budget_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, GncBudget *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_commodity_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, gnc_commodity *value)
	Create a new commodity option and register it in the options database. More...
void	gnc_register_commodity_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, gnc_commodity *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_commodity_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const char *value)
	As above but with a const char* value, which should be the symbol for the commodity. More...
void	gnc_register_commodity_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const char *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_simple_boolean_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, bool value)
	Create a new simple boolean option and register it in the options database. More...
void	gnc_register_simple_boolean_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, bool value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_pixmap_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new pixmap option and register it in the options database. More...
void	gnc_register_pixmap_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_account_list_limited_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const GncOptionAccountList &value, GncOptionAccountTypeList &&allowed)
	Create a new limited account list option and register it in the options database. More...
void	gnc_register_account_list_limited_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const GncOptionAccountList &value, GncOptionAccountTypeList &&allowed)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_account_list_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const GncOptionAccountList &value)
	Create a new account list option and register it in the options database. More...
void	gnc_register_account_list_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const GncOptionAccountList &value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_account_sel_limited_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const Account *value, GncOptionAccountTypeList &&allowed)
	Create a limited account selection option and register it in the options database. More...
void	gnc_register_account_sel_limited_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const Account *value, GncOptionAccountTypeList &&allowed)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_multichoice_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const char *default_val, GncMultichoiceOptionChoices &&value)
	Create a new multichoice option and register it in the options database. More...
void	gnc_register_multichoice_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const char *default_val, GncMultichoiceOptionChoices &&value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_list_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const char *value, GncMultichoiceOptionChoices &&list)
	Create a new list option and register it in the options database. More...
void	gnc_register_list_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const char *value, GncMultichoiceOptionChoices &&list)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
template<typename ValueType >
void	gnc_register_number_range_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, ValueType value, ValueType min, ValueType max, ValueType step)
	Create a new number range option and register it in the options database. More...
template<typename ValueType >
void	gnc_register_number_range_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, ValueType value, ValueType min, ValueType max, ValueType step)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_number_plot_size_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, int value)
	Create a new plot-size option and register it in the options database. More...
void	gnc_register_number_plot_size_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, float value)
void	gnc_register_number_plot_size_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, int value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_number_plot_size_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, float value)
void	gnc_register_query_option (GncOptionDB *db, const char *section, const char *name, const QofQuery *value)
	Create a new QofQuery option and register it in the options database. More...
void	gnc_register_query_option (GncOptionDBPtr &db, const char *section, const char *name, const QofQuery *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_owner_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const GncOwner *value, GncOwnerType type)
	Create a new GncOwner option and register it in the options database. More...
void	gnc_register_owner_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const GncOwner *value, GncOwnerType type)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_color_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new color option and register it in the options database. More...
void	gnc_register_color_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_internal_option (GncOptionDBPtr &db, const char *section, const char *name, const std::string &value)
void	gnc_register_internal_option (GncOptionDBPtr &db, const char *section, const char *name, bool value)
void	gnc_register_report_placement_option (GncOptionDBPtr &db, const char *section, const char *name)
void	gnc_register_currency_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, gnc_commodity *value)
	Create a new currency option and register it in the options database. More...
void	gnc_register_currency_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, gnc_commodity *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_currency_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, const char *value)
	As above but with a const char* value, which must be the ISO4217 three-letter symbol for the currency.
void	gnc_register_currency_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, const char *value)
void	gnc_register_invoice_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, GncInvoice *value)
	Create a new invoice option and register it in the options database. More...
void	gnc_register_invoice_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, GncInvoice *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_taxtable_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, GncTaxTable *value)
	Create a new taxtable option and register it in the options database. More...
void	gnc_register_taxtable_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, GncTaxTable *value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_invoice_print_report_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new print report option and register it in the options database. More...
void	gnc_register_invoice_print_report_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_counter_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, int value)
	Create a new counter option and register it in the options database. More...
void	gnc_register_counter_option (const GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, double value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_counter_format_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	Create a new counter format option and register it in the options database. More...
void	gnc_register_counter_format_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, std::string value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_dateformat_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, GncOptionDateFormat &&value)
	Create a new date format option and register it in the options database. More...
void	gnc_register_dateformat_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, GncOptionDateFormat &&value)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_date_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, RelativeDatePeriod period=RelativeDatePeriod::TODAY, RelativeDateUI ui=RelativeDateUI::BOTH)
	Create a new date option and register it in the options database. More...
void	gnc_register_date_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, RelativeDatePeriod period=RelativeDatePeriod::TODAY, RelativeDateUI ui=RelativeDateUI::BOTH)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_date_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, time64 time, RelativeDateUI ui=RelativeDateUI::BOTH)
	Create a new date option and register it in the options database. More...
void	gnc_register_date_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, time64 time, RelativeDateUI ui=RelativeDateUI::BOTH)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_date_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, RelativeDatePeriodVec &period_set, bool both=true)
	Create a new date option and register it in the options database. More...
void	gnc_register_date_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, RelativeDatePeriodVec &period_set, bool both=true)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_start_date_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, bool both=true)
	Create a new start-date option and register it in the options database. More...
void	gnc_register_start_date_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, bool both=true)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.
void	gnc_register_end_date_option (GncOptionDB *db, const char *section, const char *name, const char *key, const char *doc_string, bool both=true)
	Create a new end-date option and register it in the options database. More...
void	gnc_register_end_date_option (GncOptionDBPtr &db, const char *section, const char *name, const char *key, const char *doc_string, bool both=true)
	As above but takes a const GncOptionDBPtr& (const std::unique_ptr<GncOptionDB>&) for calling from C++.

Variables
constexpr unsigned	relative_date_periods
size_t constexpr	classifier_size_max {50}
size_t constexpr	sort_tag_size_max {10}
auto constexpr	uint16_t_max = std::numeric_limits<uint16_t>::max()
template<typename T >
constexpr bool	is_GncOwnerValue_v = is_GncOwnerValue<T>::value
template<typename T >
constexpr bool	is_QofInstanceValue_v = is_QofInstanceValue<T>::value
template<typename T >
constexpr bool	is_QofQueryValue_v = is_QofQueryValue<T>::value
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

GnuCash Options System for Book, Report, and Stylesheet Options.

The GnuCash Options System supports two somewhat different purposes:

• File properties, such as business information and whether to use automatic trading accounts.
• Report options for configuring and customizing reports. Most report options are user-configurable through a report options dialog but some are used as a way of passing enumeration values between the scheme modules that generate the report.

The options system is centered on an options database or optiondb. A separate optionsdb is created and instantiated for every use, so the book gets one at the beginning of the session with its values loaded from KVP, and every report gets one when the report is run, as do report stylesheets when they are edited. Customized report and stylesheet options are saved as Scheme code fragments in files in the user's GnuCash Config directory.

Note

Persistence via text scheme code is a security vulnerability as it enables an attacker to make GnuCash execute arbitrary code. The Guile interpreter affords full system access with at least the user's privileges.

Typedef Documentation

GncItem

using GncItem = std::pair<QofIdTypeConst, GncGUID>

class GncOptionQofinstanceValue

QofInstances know what type they are but getting them to tell you is a pain so we put them in a pair with a type identifier.

Definition at line 172 of file gnc-option-impl.hpp.

Enumeration Type Documentation

RelativeDatePeriod

enum RelativeDatePeriod : int

strong

Reporting periods relative to the current date.

The original design allowed custom RelativeDatePeriods, but that facility is unused so we'll go with compiled-in enums.

Definition at line 44 of file gnc-option-date.hpp.

                              : int
{
    ABSOLUTE = -1,
    TODAY,
    ONE_WEEK_AGO,
    ONE_WEEK_AHEAD,
    ONE_MONTH_AGO,
    ONE_MONTH_AHEAD,
    THREE_MONTHS_AGO,
    THREE_MONTHS_AHEAD,
    SIX_MONTHS_AGO,
    SIX_MONTHS_AHEAD,
    ONE_YEAR_AGO,
    ONE_YEAR_AHEAD,
    START_THIS_MONTH,
    END_THIS_MONTH,
    START_PREV_MONTH,
    END_PREV_MONTH,
    START_NEXT_MONTH,
    END_NEXT_MONTH,
    START_CURRENT_QUARTER,
    END_CURRENT_QUARTER,
    START_PREV_QUARTER,
    END_PREV_QUARTER,
    START_NEXT_QUARTER,
    END_NEXT_QUARTER,
    START_CAL_YEAR,
    END_CAL_YEAR,
    START_PREV_YEAR,
    END_PREV_YEAR,
    START_NEXT_YEAR,
    END_NEXT_YEAR,
    START_ACCOUNTING_PERIOD,
    END_ACCOUNTING_PERIOD,
};

Function Documentation

gnc_account_list_from_types()

GncOptionAccountList gnc_account_list_from_types	(	QofBook *	book,
		const GncOptionAccountTypeList &	types
	)

Extract a list of accounts in the book having one of the GNCAccountTypes in types.

Note that in Scheme it's important to use this function and not to create a list of accounts using gnc-get-descendants-sorted because the latter method produces a SWIGTYPE for the accounts that's incompatible with the SWIGTYPE used in this module.

Parameters

book	The book whose accounts to search
types	A std::vector of GNCAccountType containing the Account types to include in ther result

Returns

A std::vector<const Account*> of all accounts in the book having the Account types in the types parameter.

Definition at line 780 of file gnc-optiondb.cpp.

{
    GncOptionAccountList list;
    AccountPair funcdata{list, types};
    Account* base_acct = gnc_book_get_root_account(book);
    gnc_account_foreach_descendant(base_acct, (AccountCb)find_children,
                                   &funcdata);
    return list;
}

gnc_make_option()

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.

The type of GncOptionValue to create is determined from the UI type. Some GncOptionValue types require more parameters for their constructors and can't be created with this function.

Definition at line 264 of file gnc-option.hpp.

{
    return new GncOption(section, name, key, doc_string, value, ui_type);
}

gnc_option_db_book_options()

void gnc_option_db_book_options

(

GncOptionDB *

)

Register the standard option set for a QofBook.

Parameters

odb	The GncOptionDB

Definition at line 1199 of file gnc-optiondb.cpp.

{
    constexpr const char* business_section{N_("Business")};
    constexpr const char* counter_section{N_("Counters")};
    static const std::string empty_string{""};

//Accounts Tab

    gnc_register_number_range_option<double>(odb, OPTION_SECTION_ACCOUNTS,
                                     OPTION_NAME_AUTO_READONLY_DAYS, "a",
                                     N_("Choose the number of days after which transactions will be read-only and cannot be edited anymore. This threshold is marked by a red line in the account register windows. If zero, all transactions can be edited and none are read-only."),
                                     0.0, 0.0, 3650.0, 1.0);

    gnc_register_simple_boolean_option(odb, OPTION_SECTION_ACCOUNTS,
                                       OPTION_NAME_NUM_FIELD_SOURCE, "b",
                                       N_("Check to have split action field used in registers for 'Num' field in place of transaction number; transaction number shown as 'T-Num' on second line of register. Has corresponding effect on business features, reporting and imports/exports."),
                                       false);
    gnc_register_simple_boolean_option(odb, OPTION_SECTION_ACCOUNTS,
                                       OPTION_NAME_TRADING_ACCOUNTS, "a",
                                       N_("Check to have trading accounts used for transactions involving more than one currency or commodity."),
                                       false);

//Budgeting Tab

    gnc_register_budget_option(odb, OPTION_SECTION_BUDGETING,
                               OPTION_NAME_DEFAULT_BUDGET, "a",
                               N_("Budget to be used when none has been otherwise specified."),
                               nullptr);

//Counters Tab

    gnc_register_counter_option(odb, counter_section,
                                N_("Customer number"), "gncCustomera",
                                N_("The previous customer number generated. This number will be incremented to generate the next customer number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Customer number format"),
                                       "gncCustomerb",
                                       N_("The format string to use for generating customer numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Employee number"), "gncEmployeea",
                                N_("The previous employee number generated. This number will be incremented to generate the next employee number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Employee number format"),
                                       "gncEmployeeb",
                                       N_("The format string to use for generating employee numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Invoice number"), "gncInvoicea",
                                N_("The previous invoice number generated. This number will be incremented to generate the next invoice number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Invoice number format"),
                                       "gncInvoiceb",
                                       N_("The format string to use for generating invoice numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Bill number"), "gncBilla",
                                N_("The previous bill number generated. This number will be incremented to generate the next bill number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Bill number format"), "gncBillb",
                                       N_("The format string to use for generating bill numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Expense voucher number"), "gncExpVouchera",
                                N_("The previous expense voucher number generated. This number will be incremented to generate the next voucher number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Expense voucher number format"),
                                       "gncExpVoucherb",
                                       N_("The format string to use for generating expense voucher numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Job number"), "gncJoba",
                                N_("The previous job number generated. This number will be incremented to generate the next job number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Job number format"), "gncJobb",
                                       N_("The format string to use for generating job numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Order number"), "gncOrdera",
                                N_("The previous order number generated. This number will be incremented to generate the next order number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Order number format"), "gncOrderb",
                                       N_("The format string to use for generating order numbers. This is a printf-style format string."),
                                       empty_string);
    gnc_register_counter_option(odb, counter_section,
                                N_("Vendor number"), "gncVendora",
                                N_("The previous vendor number generated. This number will be incremented to generate the next vendor number."),
                                0);
    gnc_register_counter_format_option(odb, counter_section,
                                       N_("Vendor number format"), "gncVendorb",
                                       N_("The format string to use for generating vendor numbers. This is a printf-style format string."),
                                       empty_string);

//Business Tab

    gnc_register_string_option(odb, business_section, N_("Company Name"), "a",
                               N_("The name of your business."),
                               empty_string);
    gnc_register_text_option(odb, business_section, N_("Company Address"), "b1",
                             N_("The address of your business."),
                             empty_string);
    gnc_register_string_option(odb, business_section,
                               N_("Company Contact Person"), "b2",
                               N_("The contact person to print on invoices."),
                               empty_string);
    gnc_register_string_option(odb, business_section,
                               N_("Company Phone Number"), "c1",
                               N_("The contact person to print on invoices."),
                               empty_string);
    gnc_register_string_option(odb, business_section,
                               N_("Company Fax Number"), "c2",
                               N_("The fax number of your business."),
                               empty_string);
    gnc_register_string_option(odb, business_section,
                               N_("Company Email Address"), "c3",
                               N_ ("The email address of your business."),
                               empty_string);
    gnc_register_string_option(odb, business_section,
                               N_("Company Website URL"), "c4",
                               N_("The URL address of your website."),
                               empty_string);
    gnc_register_string_option(odb, business_section, N_("Company ID"), "c5",
                               N_("The ID for your company (eg 'Tax-ID: 00-000000)."),
                               empty_string);
    gnc_register_invoice_print_report_option(odb, business_section,
                                 OPTION_NAME_DEFAULT_INVOICE_REPORT, "e1",
                                 N_("The invoice report to be used for printing."),
                                 empty_string);
    gnc_register_number_range_option<double>(odb, business_section,
                                     OPTION_NAME_DEFAULT_INVOICE_REPORT_TIMEOUT, "e2",
                                     N_("Length of time to change the used invoice report. A value of 0 means disabled."),
                                     0.0, 0.0, 20.0, 1.0);
    gnc_register_taxtable_option(odb, business_section,
                                 N_("Default Customer TaxTable"), "f1",
                                 N_("The default tax table to apply to customers."),
                                 nullptr);
    gnc_register_taxtable_option(odb, business_section,
                                 N_("Default Vendor TaxTable"), "f2",
                                 N_("The default tax table to apply to vendors."),
                                 nullptr);

    gnc_register_dateformat_option(odb, business_section,
                                   N_("Fancy Date Format"), "g",
                                   N_("The default date format used for fancy printed dates."),
                                   {QOF_DATE_FORMAT_UNSET, GNCDATE_MONTH_NUMBER, true, ""});

//Tax Tab

    gnc_register_string_option(odb, N_("Tax"), N_("Tax Number"), "a",
                               N_("The electronic tax number of your business"),
                               empty_string);
}

gnc_option_db_clean()

void gnc_option_db_clean

(

GncOptionDB *

odb

)

Reset all ui_items to the option value.

Parameters

odb	The GncOptionDB.

Definition at line 1175 of file gnc-optiondb.cpp.

{
        odb->foreach_section(
        [](GncOptionSectionPtr& section){
            section->foreach_option(
                [](GncOption& option) {
                    option.set_ui_item_from_option();
                });
        });
}

gnc_option_db_commit()

GList* gnc_option_db_commit

(

GncOptionDB *

odb

)

Write all changed ui_item values to their options.

Parameters

odb	The GncOptionDB.

Returns

A GList* conatining the names of options that raised exceptions when attempting to set their values. The names are const, free only the list.

Definition at line 1149 of file gnc-optiondb.cpp.

{
    GList* errors{};
    odb->foreach_section(
        [&errors](GncOptionSectionPtr& section){
            section->foreach_option(
                [&errors](GncOption& option) {
                    try
                    {
                        option.set_option_from_ui_item();
                    }
                    catch (const std::invalid_argument& err)
                    {
                        PWARN("Option %s:%s failed to set its value %s",
                              option.get_section().c_str(),
                              option.get_name().c_str(), err.what());
                        errors = g_list_prepend(errors,
                                                (void*)option.get_name().c_str());
                    } });
        });
    if (!errors)
        odb->run_callbacks();
    return errors;
}

gnc_option_db_destroy()

void gnc_option_db_destroy

(

GncOptionDB *

odb

)

Destruct and release a GncOptionDB.

Parameters

odb	The GncOptionDB.

Definition at line 1143 of file gnc-optiondb.cpp.

{
    PWARN("Direct Destroy called on GncOptionDB %" G_GUINT64_FORMAT, (uint64_t)odb);
}

gnc_option_db_load()

void gnc_option_db_load	(	GncOptionDB *	odb,
		QofBook *	book
	)

Load a book's options into the GncOptionDB.

Parameters

odb	The GncOptionDB
book	The book in which the options are saved.

Definition at line 1186 of file gnc-optiondb.cpp.

{
    odb->load_from_kvp(book);
}

gnc_option_db_lookup_qofinstance_value()

const QofInstance* gnc_option_db_lookup_qofinstance_value	(	GncOptionDB *	,
		const char *	,
		const char *
	)

Retrieve the QofInstance value of an option in the GncOptionDB.

Parameters

odb	the GncOptionDB
section	the section in which the option is stored
name	the option name

Returns

the const QofInstance* of the value or nullptr if the option isn't found or if its value isn't a QofInstance*.

Definition at line 1359 of file gnc-optiondb.cpp.

{
    auto option{odb->find_option(section, name)};
    if (option)
        return option->get_value<const QofInstance*>();
    else
        return nullptr;
}

gnc_option_db_new()

GncOptionDB* gnc_option_db_new

(

void

)

Create an empty option database.

Returns

A newly allocated GncOptionDB. Use delete to destroy it.

Definition at line 1137 of file gnc-optiondb.cpp.

{
    return new GncOptionDB;
}

gnc_option_db_save()

void gnc_option_db_save	(	GncOptionDB *	odb,
		QofBook *	book,
		gboolean	clear_options
	)

Save the GncOptionDB contents into a book's options store.

Parameters

odb	The GncOptionDB
book	The book in which the options are saved.
clear_options	TRUE if the books existing options should be removed first.

Definition at line 1192 of file gnc-optiondb.cpp.

{
    odb->save_to_kvp(book, static_cast<bool>(clear_options));
}

gnc_register_account_list_limited_option()

void gnc_register_account_list_limited_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const GncOptionAccountList &	value,
		GncOptionAccountTypeList &&	allowed
	)

Create a new limited account list option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default values for the option.
allowed	The accounts which are available for selection.

Definition at line 746 of file gnc-optiondb.cpp.

{
    try
    {
        GncOption option{GncOptionAccountListValue{section, name, key, doc_string,
                    GncOptionUIType::ACCOUNT_LIST, value, std::move(allowed)}};
        db->register_option(section, std::move(option));
    }
    catch (const std::invalid_argument& err)
    {
        PWARN("Account List Limited Option, value failed validation, option not registered.");
    }
}

gnc_register_account_list_option()

void gnc_register_account_list_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const GncOptionAccountList &	value
	)

Create a new account list option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default values for the option.

Definition at line 735 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionAccountListValue{section, name, key, doc_string,
                GncOptionUIType::ACCOUNT_LIST, value}};
    db->register_option(section, std::move(option));
}

gnc_register_account_sel_limited_option()

void gnc_register_account_sel_limited_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const Account *	value,
		GncOptionAccountTypeList &&	allowed
	)

Create a limited account selection option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.
allowed	The accounts which are available for selection.

Definition at line 793 of file gnc-optiondb.cpp.

{
    try
    {
        GncOption option{GncOptionAccountSelValue{section, name, key, doc_string,
                    GncOptionUIType::ACCOUNT_SEL, value, std::move(allowed)}};
    db->register_option(section, std::move(option));
    }
    catch (const std::invalid_argument& err)
    {
        PWARN("Account Sel Limited Option, value failed validation, option not registerd.");
    }
}

gnc_register_budget_option()

void gnc_register_budget_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		GncBudget *	value
	)

Create a new budget option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 657 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionQofInstanceValue{section, name, key, doc_string,
                                               (const QofInstance*)value,
                                               GncOptionUIType::BUDGET}};
    db->register_option(section, std::move(option));
}

gnc_register_color_option()

void gnc_register_color_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new color option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 668 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::COLOR};
    db->register_option(section, std::move(option));
}

gnc_register_commodity_option() [1/2]

void gnc_register_commodity_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		gnc_commodity *	value
	)

Create a new commodity option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 678 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionCommodityValue{section, name, key, doc_string,
                                               value,
                                               GncOptionUIType::COMMODITY}};
    db->register_option(section, std::move(option));
}

gnc_register_commodity_option() [2/2]

void gnc_register_commodity_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const char *	value
	)

As above but with a const char* value, which should be the symbol for the commodity.

All security editor namespaces will be searched to retrieve it.

Definition at line 689 of file gnc-optiondb.cpp.

{
    gnc_commodity* commodity{};
    const auto book{qof_session_get_book(gnc_get_current_session())};
    const auto commodity_table{gnc_commodity_table_get_table(book)};
    const auto namespaces{gnc_commodity_table_get_namespaces(commodity_table)};
    for (auto node = namespaces; node && commodity == nullptr;
         node = g_list_next(node))
    {
        commodity = gnc_commodity_table_lookup(commodity_table,
                                               (const char*)(node->data),
                                               value);
        if (commodity)
            break;
    }
    GncOption option{GncOptionCommodityValue{section, name, key, doc_string,
                commodity,
                GncOptionUIType::COMMODITY}};
    db->register_option(section, std::move(option));
    g_list_free (namespaces);
}

gnc_register_counter_format_option()

void gnc_register_counter_format_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new counter format option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 958 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::STRING};
    db->register_option(section, std::move(option));
}

gnc_register_counter_option()

void gnc_register_counter_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		int	value
	)

Create a new counter option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 947 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionRangeValue<int>{section, name, key, doc_string,
                value, 0, 999999999, 1}};
    option.set_alternate(true);
    db->register_option(section, std::move(option));
}

gnc_register_currency_option()

void gnc_register_currency_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		gnc_commodity *	value
	)

Create a new currency option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option. It is checked with gnc_commodity_is_currency.

Definition at line 979 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionCommodityValue{
        section, name, key, doc_string, value, GncOptionUIType::CURRENCY
        }};
    db->register_option(section, std::move(option));
}

gnc_register_date_option() [1/3]

void gnc_register_date_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		RelativeDatePeriod	period = RelativeDatePeriod::TODAY,
		RelativeDateUI	ui = RelativeDateUI::BOTH
	)

Create a new date option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
period	The default/starting relative date value for the option.
ui	What UI to display, relative, absolute, or both.

Definition at line 1020 of file gnc-optiondb.cpp.

{
    auto ui_type = ui == RelativeDateUI::BOTH ? GncOptionUIType::DATE_BOTH :
        ui == RelativeDateUI::RELATIVE ? GncOptionUIType::DATE_RELATIVE :
        GncOptionUIType::DATE_ABSOLUTE;
    GncOption option{GncOptionDateValue(section, name, key, doc_string,
                                        ui_type, period)};
    db->register_option(section, std::move(option));
}

gnc_register_date_option() [2/3]

void gnc_register_date_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		time64	time,
		RelativeDateUI	ui = RelativeDateUI::BOTH
	)

Create a new date option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
time	The initial time to set in the option.
ui	What UI to display, relative, absolute, or both.

Definition at line 1006 of file gnc-optiondb.cpp.

{
    auto ui_type = ui == RelativeDateUI::BOTH ? GncOptionUIType::DATE_BOTH :
        ui == RelativeDateUI::RELATIVE ? GncOptionUIType::DATE_RELATIVE :
        GncOptionUIType::DATE_ABSOLUTE;
    GncOption option{GncOptionDateValue(section, name, key, doc_string,
                                        ui_type, time)};
    db->register_option(section, std::move(option));
}

gnc_register_date_option() [3/3]

void gnc_register_date_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		RelativeDatePeriodVec &	period_set,
		bool	both = true
	)

Create a new date option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
period_set	A vector of relative date periods to display in the relative control.
both	Whether to display both a relative and absolute control or a onla a relative control.

Definition at line 1034 of file gnc-optiondb.cpp.

{
    auto is_absolute = period_set.size() == 1 &&
                       period_set.front() == RelativeDatePeriod::ABSOLUTE;
    auto ui_type = both ? GncOptionUIType::DATE_BOTH :
        is_absolute ? GncOptionUIType::DATE_ABSOLUTE : GncOptionUIType::DATE_RELATIVE;
    GncOption option{GncOptionDateValue(section, name, key, doc_string,
                                        ui_type, period_set)};
    if (is_absolute)
        option.set_default_value(gnc_time(nullptr));
    db->register_option(section, std::move(option));
}

gnc_register_dateformat_option()

void gnc_register_dateformat_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		GncOptionDateFormat &&	value
	)

Create a new date format option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 969 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, std::move(value),
            GncOptionUIType::DATE_FORMAT};
    db->register_option(section, std::move(option));
}

gnc_register_end_date_option()

void gnc_register_end_date_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		bool	both = true
	)

Create a new end-date option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
both	Whether to display both a relative and absolute control or a onla a relative control.

Definition at line 1089 of file gnc-optiondb.cpp.

{
    auto ui_type = both ? GncOptionUIType::DATE_BOTH :
        GncOptionUIType::DATE_RELATIVE;
    GncOption option{GncOptionDateValue(section, name, key, doc_string,
                                        ui_type, end_dates)};
    db->register_option(section, std::move(option));
}

gnc_register_font_option()

void gnc_register_font_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new font option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 647 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::FONT};
    db->register_option(section, std::move(option));
}

gnc_register_invoice_option()

void gnc_register_invoice_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		GncInvoice *	value
	)

Create a new invoice option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 915 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionQofInstanceValue{section, name, key, doc_string,
                                               (const QofInstance*)value,
                                               GncOptionUIType::INVOICE}};
    db->register_option(section, std::move(option));
}

gnc_register_invoice_print_report_option()

void gnc_register_invoice_print_report_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new print report option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 937 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string,
                     value, GncOptionUIType::INV_REPORT};
    db->register_option(section, std::move(option));
}

gnc_register_list_option()

void gnc_register_list_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const char *	value,
		GncMultichoiceOptionChoices &&	list
	)

Create a new list option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.
list	The values available for selection. Note that this parameter will be moved from so using it after this call will result in undefined behavior.

Definition at line 831 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionMultichoiceValue{section, name, key, doc_string,
                value,  std::move(list), GncOptionUIType::LIST}};
    db->register_option(section, std::move(option));
}

gnc_register_multichoice_option()

void gnc_register_multichoice_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const char *	default_val,
		GncMultichoiceOptionChoices &&	value
	)

Create a new multichoice option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The set of possible values for the option. Only one can be selected. Note that the value will be moved from the parameter and using the parameter after this call will result in undefined behavior.

Definition at line 812 of file gnc-optiondb.cpp.

{
    std::string defval{default_val};
    auto found{std::find_if(choices.begin(), choices.end(),
                            [&defval](auto& choice)->bool {
                                return defval == std::get<0>(choice);
                            })};
    if (found == choices.end())
        defval = (choices.empty() ? std::string{"None"} :
                  std::get<0>(choices.at(0)));
    GncOption option{GncOptionMultichoiceValue{section, name, key, doc_string,
                defval.c_str(), std::move(choices)}};
    db->register_option(section, std::move(option));
}

gnc_register_number_plot_size_option()

void gnc_register_number_plot_size_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		int	value
	)

Create a new plot-size option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 865 of file gnc-optiondb.cpp.

{
//65K is 10x reasonable, but it's a convenient constant.
    GncOption option{GncOptionRangeValue<int>{section, name, key, doc_string,
            value, 10, UINT16_MAX, 1, GncOptionUIType::PLOT_SIZE}};
    db->register_option(section, std::move(option));
}

gnc_register_number_range_option()

template<typename ValueType >

void gnc_register_number_range_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		ValueType	value,
		ValueType	min,
		ValueType	max,
		ValueType	step
	)

Create a new number range option and register it in the options database.

These are normally associated with spin controls and ValueType is normally double, but it's templated to permit other numeric types if needed.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.
min	The minimum value for the spin control.
max	The maximum value for the spin control.
step	The step size (increment) of the spin control.

Definition at line 845 of file gnc-optiondb.cpp.

{
    try
    {
        GncOption option{GncOptionRangeValue<ValueType>{section, name, key,
                                                        doc_string, value, min,
                                                        max, step}};
        db->register_option(section, std::move(option));
    }
    catch(const std::invalid_argument& err)
    {
        PWARN("Number Range Option %s, option not registerd.",
              err.what());
    }
}

gnc_register_owner_option()

void gnc_register_owner_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		const GncOwner *	value,
		GncOwnerType	type
	)

Create a new GncOwner option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.
type	The type of owner, determines the UI type.

Definition at line 886 of file gnc-optiondb.cpp.

{
    GncOptionUIType uitype;
    switch (type)
    {
    case GNC_OWNER_CUSTOMER:
        uitype = GncOptionUIType::CUSTOMER;
        break;
    case GNC_OWNER_EMPLOYEE:
        uitype = GncOptionUIType::EMPLOYEE;
        break;
    case GNC_OWNER_JOB:
        uitype = GncOptionUIType::JOB;
        break;
    case GNC_OWNER_VENDOR:
        uitype = GncOptionUIType::VENDOR;
        break;
    default:
        uitype = GncOptionUIType::INTERNAL;
    };
    GncOption option{GncOptionGncOwnerValue{section, name, key, doc_string,
                                            value, uitype}};
    db->register_option(section, std::move(option));
}

gnc_register_pixmap_option()

void gnc_register_pixmap_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new pixmap option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 725 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::PIXMAP};
    db->register_option(section, std::move(option));
}

gnc_register_query_option()

void gnc_register_query_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const QofQuery *	value
	)

Create a new QofQuery option and register it in the options database.

Query options have no UI component so they don't get a key or a docstring.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
value	The initial and default value for the option.

Definition at line 877 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, "", "", value,
            GncOptionUIType::INTERNAL};
    db->register_option(section, std::move(option));
}

gnc_register_simple_boolean_option()

void gnc_register_simple_boolean_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		bool	value
	)

Create a new simple boolean option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 714 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::BOOLEAN};
    db->register_option(section, std::move(option));
}

gnc_register_start_date_option()

void gnc_register_start_date_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		bool	both = true
	)

Create a new start-date option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
both	Whether to display both a relative and absolute control or a onla a relative control.

Definition at line 1065 of file gnc-optiondb.cpp.

{
    auto ui_type = both ? GncOptionUIType::DATE_BOTH :
        GncOptionUIType::DATE_RELATIVE;
    GncOption option{GncOptionDateValue(section, name, key, doc_string,
                                        ui_type, begin_dates)};
    db->register_option(section, std::move(option));
}

gnc_register_string_option()

void gnc_register_string_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new string option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 626 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::STRING};
    db->register_option(section, std::move(option));
}

gnc_register_taxtable_option()

void gnc_register_taxtable_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		GncTaxTable *	value
	)

Create a new taxtable option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 926 of file gnc-optiondb.cpp.

{
    GncOption option{GncOptionQofInstanceValue{section, name, key, doc_string,
                                               (const QofInstance*)value,
                                               GncOptionUIType::TAX_TABLE}};
    db->register_option(section, std::move(option));
}

gnc_register_text_option()

void gnc_register_text_option	(	GncOptionDB *	db,
		const char *	section,
		const char *	name,
		const char *	key,
		const char *	doc_string,
		std::string	value
	)

Create a new text option and register it in the options database.

Parameters

db	A GncOptionDB* for calling from C. Caller retains ownership.
section	The database section for the option.
name	The option name.
key	A short tag used to sort the controls in the dialog.
doc_string	A description of the option. This will be used in tooltips and should be marked for translation.
value	The initial and default value for the option.

Definition at line 636 of file gnc-optiondb.cpp.

{
    GncOption option{section, name, key, doc_string, value,
            GncOptionUIType::TEXT};
    db->register_option(section, std::move(option));

}

gnc_relative_date_description()

const char* gnc_relative_date_description

(

RelativeDatePeriod

)

Provide the description of a relative date.

This string is localizable.

Parameters

period

The relative date period.

Returns

A constant string or nullptr if the period is ABSOLUTE. The string's lifetime will be that of the Relative Date Period. It must not be freed and should be copied if the period might be destroyed before the using code is finished.

Definition at line 374 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return nullptr;
    return checked_reldate(per).m_description;
}

gnc_relative_date_display_string()

const char* gnc_relative_date_display_string

(

RelativeDatePeriod

)

Provide the string representation of a relative date for displaying value to a user.

This string is localizable.

Parameters

period

The relative date period.

Returns

A constant string or nullptr if the period is ABSOLUTE. The string's lifetime will be that of the Relative Date Period. It must not be freed and should be copied if the period might be destroyed before the using code is finished.

Definition at line 367 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return nullptr;
    return checked_reldate(per).m_display;
}

gnc_relative_date_from_storage_string()

RelativeDatePeriod gnc_relative_date_from_storage_string

(

const char *

)

Convert a relative date storage string back to a RelativeDatePeriod value.

Parameters

A	string representation obtained from gnc_relative_date_storage_string.

Returns

A RelativeDatePeriod value.

Definition at line 382 of file gnc-option-date.cpp.

{
    auto per = std::find_if(reldates.begin(), reldates.end(),
                         [str](auto rel) -> bool
                         {
                             return strcmp(str, rel.m_storage) == 0;
                         });
    return per != reldates.end() ? per->m_period : RelativeDatePeriod::ABSOLUTE;
}

gnc_relative_date_is_ending()

bool gnc_relative_date_is_ending

(

RelativeDatePeriod

)

Report whether the relative date represents the end of a date range.

For example END_LAST_MONTH is the end of a range.

Parameters

period

The Relative Date Period to check.

Returns

true if the date is the end of a date range.

Definition at line 351 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return false;
    return checked_reldate(per).m_type == RelativeDateType::END;
}

gnc_relative_date_is_single()

bool gnc_relative_date_is_single

(

RelativeDatePeriod

)

Report whether the relative date represents a period offset to today's date rather than the beginning or end of a date range.

For example ONE_MONTH_AGO will be made concrete as the same day as today in the previous month.

Parameters

period

The Relative Date Period to check.

Returns

true if the date is stand-alone.

Definition at line 333 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return false;
    auto reldate = checked_reldate(per);
    return reldate.m_type == RelativeDateType::LAST ||
        reldate.m_type == RelativeDateType::NEXT;
}

gnc_relative_date_is_starting()

bool gnc_relative_date_is_starting

(

RelativeDatePeriod

)

Report whether the relative date represents the beginning of a date range.

For example START_LAST_MONTH is the beginning of a range.

Parameters

period

The Relative Date Period to check.

Returns

true if the date is the beginning of a date range

Definition at line 343 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return false;
    return checked_reldate(per).m_type == RelativeDateType::START;
}

gnc_relative_date_storage_string()

const char* gnc_relative_date_storage_string

(

RelativeDatePeriod

)

Provide the string representation of a relative date for persisting the value.

This string is not localizable.

Parameters

period

The relative date period.

Returns

A constant string or nullptr if the period is ABSOLUTE. The string's lifetime will be that of the Relative Date Period. It must not be freed and should be copied if the period might be destroyed before the using code is finished.

Definition at line 359 of file gnc-option-date.cpp.

{
    if (per == RelativeDatePeriod::ABSOLUTE)
        return nullptr;
    return checked_reldate(per).m_storage;
}

gnc_relative_date_to_time64()

time64 gnc_relative_date_to_time64

(

RelativeDatePeriod

)

Convert a RelativeDatePeriod value to a concrete time64 by applying the value to the current time.

For example if it is now 3:15:42 PM local time 3 June, calling this with a period RelativeDatePeriod::ONE_WEEK_AHEAD will return a time64 representing 3:15:42 PM local time 10 June of this year. Times for START periods are changed to midnight local time and for END periods to 23:59:59 local time so for example if the period is instead RelativeDatePeriod::START_THIS_MONTH the time64 will represent 00:00:00 1 June and if it is RelativeDatePeriod::END_THIS_MONTH the time64 will be for 23:59:59 30 June, both in the current time zone.

Parameters

period

The relative date period to use to calculate the concrete date.

Returns

a time64.

Definition at line 487 of file gnc-option-date.cpp.

{
    if (period == RelativeDatePeriod::TODAY)
        return static_cast<time64>(GncDateTime());
    if (period == RelativeDatePeriod::START_ACCOUNTING_PERIOD)
        return gnc_accounting_period_fiscal_start();
    if (period == RelativeDatePeriod::END_ACCOUNTING_PERIOD)
        return gnc_accounting_period_fiscal_end();

    GncDateTime now_t;
    if (period == RelativeDatePeriod::TODAY)
        return static_cast<time64>(now_t);
    auto now{static_cast<tm>(now_t)};
    struct tm acct_per{};
    if (gnc_prefs_get_bool (GNC_PREFS_GROUP_ACCT_SUMMARY,
                            GNC_PREF_START_CHOICE_ABS))
        acct_per = static_cast<tm>(GncDateTime(gnc_accounting_period_fiscal_start()));

    switch(reldate_offset(period))
    {
        case RelativeDateOffset::NONE:
// Report on today so nothing to do
            break;
        case RelativeDateOffset::YEAR:
            if (reldate_is_prev(period))
                --now.tm_year;
            else if (reldate_is_next(period))
                ++now.tm_year;
            if (gnc_relative_date_is_starting(period))
                now.tm_mon = 0;
            else if (gnc_relative_date_is_ending(period))
                now.tm_mon = 11;
            break;
       case RelativeDateOffset::SIX:
            if (reldate_is_prev(period))
                now.tm_mon -= 6;
            else if (reldate_is_next(period))
                now.tm_mon += 6;
            break;
        case RelativeDateOffset::QUARTER:
        {
            auto delta = (now.tm_mon >= acct_per.tm_mon ?
                          ( now.tm_mon - acct_per.tm_mon) % 3 :
                          3 - ((acct_per.tm_mon - now.tm_mon) % 3));
            now.tm_mon = now.tm_mon - delta;
        }
            [[fallthrough]];
        case RelativeDateOffset::THREE:
            if (reldate_is_prev(period))
                now.tm_mon -= 3;
            else if (reldate_is_next(period))
                now.tm_mon += 3;
            if (gnc_relative_date_is_ending(period))
                now.tm_mon += 2;
            break;
       case RelativeDateOffset::MONTH:
            if (reldate_is_prev(period))
                --now.tm_mon;
            else if (reldate_is_next(period))
                ++now.tm_mon;
            break;
        case RelativeDateOffset::WEEK:
            if (reldate_is_prev(period))
                now.tm_mday -= 7;
            else if (reldate_is_next(period))
                now.tm_mday += 7;
    }
    reldate_set_day_and_time(now, checked_reldate(period).m_type);
    normalize_reldate_tm(now);
    return static_cast<time64>(GncDateTime(now));
}

operator<<()

std::ostream& operator<<	(	std::ostream &	,
		const RelativeDatePeriod
	)

Add the display string to the provided std::ostream.

Parameters

stream	the std::ostream to which to write the period value
period	the period value to write

Returns

A reference to stream so that the operator can be chained.

Definition at line 560 of file gnc-option-date.cpp.

{
    ostr << "'reldate . " << gnc_relative_date_display_string(per);
    return ostr;
}

Variable Documentation

relative_date_periods

constexpr unsigned relative_date_periods

Initial value:

=
    static_cast<unsigned>(RelativeDatePeriod::END_ACCOUNTING_PERIOD) + 2

Definition at line 80 of file gnc-option-date.hpp.