GnuCash  4.12-558-g06612b8434
Public Member Functions
GncOptionAccountListValue Class Reference

Set one or more accounts on which to report, optionally restricted to certain account types. More...

#include <gnc-option-impl.hpp>

Inheritance diagram for GncOptionAccountListValue:
OptionClassifier

Public Member Functions

 GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, bool multi=true)
 
 GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const GncOptionAccountList &value, bool multi=true)
 
 GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, GncOptionAccountTypeList &&allowed, bool multi=true)
 
 GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const GncOptionAccountList &value, GncOptionAccountTypeList &&allowed, bool multi=true)
 
GncOptionAccountList get_value () const
 
GncOptionAccountList get_default_value () const
 
bool validate (const GncOptionAccountList &values) const
 
void set_value (GncOptionAccountList values)
 
void set_default_value (GncOptionAccountList values)
 
GList * account_type_list () const noexcept
 Create a GList of account types to pass to gnc_account_sel_set_acct_filters. More...
 
void reset_default_value ()
 
bool is_changed () const noexcept
 
GncOptionUIType get_ui_type () const noexcept
 
void make_internal ()
 
bool is_internal ()
 
bool is_multiselect () const noexcept
 
std::string serialize () const noexcept
 
bool deserialize (const std::string &str) noexcept
 

Additional Inherited Members

- Data Fields inherited from OptionClassifier
std::string m_section
 
std::string m_name
 
std::string m_sort_tag
 
std::string m_doc_string
 

Detailed Description

Set one or more accounts on which to report, optionally restricted to certain account types.

Many calls to make-account-list-option will pass a get-default function that retrieves all of the accounts of a list of types.

Some reports (examples/daily-reports.scm and standard/ account-piechart.scm, advanced-portfolio.scm, category-barchart.scm, net-charts.scm, and portfolio.scm) also provide a validator that rejects accounts that don't meet an account-type criterion.

There are two types of option, account-list which permits more than one account selection and account-sel, which doesn't.

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


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