StockTransactionFeesEntry Class Reference

Specialized Entry for fees, taxes, commissions, and so on. More...

Inheritance diagram for StockTransactionFeesEntry:

Public Member Functions
	StockTransactionFeesEntry (const char *action, const char *tag)
void	set_fieldmask (FieldMask mask) override
	Set up the state variables from the FieldMask.
void	set_capitalize (bool capitalize) override
bool	do_capitalize () const override
void	validate_amount (Logger &logger) const override
void	create_split (Transaction *trans, AccountVec &commits) const override
Public Member Functions inherited from StockTransactionEntry
	StockTransactionEntry (const char *action, const char *kvp_tag)
	StockTransactionEntry (const StockTransactionEntry &)=default
virtual bool	enabled () const
virtual bool	debit_side () const
virtual bool	input_new_balance () const
virtual void	set_account (Account *account)
virtual Account *	account () const
virtual const char *	print_account () const
virtual void	set_memo (const char *memo)
virtual const char *	get_kvp_tag ()
virtual const char *	memo () const
virtual void	set_value (gnc_numeric amount)
virtual GncNumeric	value ()
virtual void	set_amount (gnc_numeric)
virtual gnc_numeric	amount () const
virtual bool	has_amount () const
virtual bool	marker_split () const
virtual void	set_balance (gnc_numeric balance)
virtual gnc_numeric	get_balance () const
virtual const char *	print_value () const
virtual const char *	print_amount (gnc_numeric amt) const
virtual std::string	amount_str_for_display () const
	Generate a string representation of the value.
virtual gnc_numeric	calculate_price () const
	Calculate the price (amount/value) for non-currency accounts.
virtual const char *	print_price () const

Additional Inherited Members
Protected Attributes inherited from StockTransactionEntry
bool	m_enabled
bool	m_debit_side
bool	m_allow_zero
bool	m_allow_negative
bool	m_input_new_balance = false
Account *	m_account
gnc_numeric	m_value
const char *	m_memo
const char *	m_action
gnc_numeric	m_balance = gnc_numeric_zero()
const char *	m_kvp_tag
int	m_qof_event_handler

Detailed Description

Specialized Entry for fees, taxes, commissions, and so on.

It can optionally create its balancing split in a user-provided account or as a 0-amount split on the stock account.

Definition at line 1012 of file assistant-stock-transaction.cpp.

Constructor & Destructor Documentation

StockTransactionFeesEntry() [1/2]

StockTransactionFeesEntry::StockTransactionFeesEntry ( )

inline

Definition at line 1016 of file assistant-stock-transaction.cpp.

: StockTransactionEntry{}, m_capitalize{false} {}

StockTransactionFeesEntry() [2/2]

StockTransactionFeesEntry::StockTransactionFeesEntry ( const char *  action, const char *  tag  )

inline

Definition at line 1017 of file assistant-stock-transaction.cpp.

: StockTransactionEntry{action, tag}, m_capitalize{false} {}

Member Function Documentation

create_split()

void StockTransactionFeesEntry::create_split ( Transaction *  trans, AccountVec &  commits  ) const

overridevirtual

Reimplemented from StockTransactionEntry.

Definition at line 1062 of file assistant-stock-transaction.cpp.

{
  g_return_if_fail(trans);
  if ((!m_account && !m_capitalize) || gnc_numeric_check(m_value))
      return;
  auto split = xaccMallocSplit(qof_instance_get_book(trans));
  xaccSplitSetParent(split, trans);
  if (m_capitalize)
  {
      xaccSplitSetAccount(split, commits[0]); // Should be the stock account
  }
  else
  {
      xaccAccountBeginEdit(m_account);
      commits.push_back(m_account);
      xaccSplitSetAccount(split, m_account);
      xaccSplitSetAmount(split, amount());
  }
  xaccSplitSetMemo(split, m_memo);
  xaccSplitSetValue(split, m_debit_side ? m_value : gnc_numeric_neg(m_value));
  PINFO("creating %s split in Acct(%s): Val(%s), Amt(%s) => Val(%s), Amt(%s)",
        m_action, m_account ? xaccAccountGetName (m_account) : "Empty!",
        gnc_num_dbg_to_string(m_value),
        gnc_num_dbg_to_string(amount()),
        gnc_num_dbg_to_string(xaccSplitGetValue(split)),
        gnc_num_dbg_to_string(xaccSplitGetAmount(split)));
  gnc_set_num_action(nullptr, split, nullptr,
                     g_dpgettext2(nullptr, "Stock Assistant: Action field",
                                  m_action));
}

do_capitalize()

bool StockTransactionFeesEntry::do_capitalize ( ) const

inlineoverridevirtual

Reimplemented from StockTransactionEntry.

Definition at line 1020 of file assistant-stock-transaction.cpp.

{ return m_capitalize; }

set_capitalize()

void StockTransactionFeesEntry::set_capitalize ( bool  capitalize )

inlineoverridevirtual

Reimplemented from StockTransactionEntry.

Definition at line 1019 of file assistant-stock-transaction.cpp.

{ m_capitalize = capitalize; }

set_fieldmask()

void StockTransactionFeesEntry::set_fieldmask ( FieldMask  mask )

overridevirtual

Set up the state variables from the FieldMask.

Parameters

A	Fieldmast to configure the StockTransactionEntry.

Reimplemented from StockTransactionEntry.

Definition at line 1026 of file assistant-stock-transaction.cpp.

{
    StockTransactionEntry::set_fieldmask(mask);
    m_capitalize = mask & FieldMask::CAPITALIZE_DEFAULT;
}

validate_amount()

void StockTransactionFeesEntry::validate_amount ( Logger &  logger ) const

overridevirtual

Reimplemented from StockTransactionEntry.

Definition at line 1033 of file assistant-stock-transaction.cpp.

{
    auto add_error = [&logger](const char* format_str, const char* arg)
    {
        char *buf = g_strdup_printf (_(format_str),
                                      g_dpgettext2 (nullptr, "Stock Assistant: Page name", arg));
        logger.error(buf);
        g_free (buf);
    };
 
 
    if (gnc_numeric_check (m_value))
    {
        if (!m_allow_zero)
            add_error (N_("Amount for %s is missing."), m_action);
        return;
    }
 
    if (gnc_numeric_negative_p (m_value) && !m_allow_negative && m_allow_zero)
        add_error (N_("Amount for %s must not be negative."), m_action);
 
    if (!m_allow_zero && !gnc_numeric_positive_p (m_value))
        add_error (N_("Amount for %s must be positive."), m_action);
 
    if (!gnc_numeric_zero_p(m_value) && !m_account && !m_capitalize)
        add_error(N_("The %s amount has no associated account."), m_action);
}

---

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

• assistant-stock-transaction.cpp