mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-25 10:20:18 -06:00
91 lines
4.3 KiB
C
91 lines
4.3 KiB
C
/********************************************************************\
|
|
* engine-helpers.h -- gnucash engine helper functions *
|
|
* Copyright (C) 2000 Linas Vepstas <linas@linas.org> *
|
|
* Copyright (C) 2001 Linux Developers Group, Inc. *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License as *
|
|
* published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License*
|
|
* along with this program; if not, contact: *
|
|
* *
|
|
* Free Software Foundation Voice: +1-617-542-5942 *
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org *
|
|
* *
|
|
\********************************************************************/
|
|
|
|
#ifndef ENGINE_HELPERS_H
|
|
#define ENGINE_HELPERS_H
|
|
|
|
#include <glib.h>
|
|
|
|
#include "gnc-engine.h"
|
|
#include "Account.h"
|
|
#include "Query.h"
|
|
#include "Transaction.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef void (*GncBOCb) (gpointer new_val, gpointer user_data);
|
|
|
|
/** Gets the transaction Number or split Action based on book option:
|
|
* if the book option is TRUE (split action is used for NUM) and a
|
|
* split is provided, split-action is returned; if book option is FALSE
|
|
* (tran-num is used for NUM) and a trans is provided, transaction-num
|
|
* is returned; if split is provided and tran is NULL, split-action is
|
|
* returned; if tran is provided and split is NULL, transaction-num is
|
|
* returned. Otherwise NULL is returned.*/
|
|
const char * gnc_get_num_action (const Transaction *trans, const Split *split);
|
|
|
|
/** Opposite of 'gnc_get_num_action'; if the book option is TRUE (split action
|
|
* is used for NUM) and a trans is provided, transaction-num is returned; if
|
|
* book option is FALSE (tran-num is used for NUM) and a split is provided,
|
|
* split-action is returned; if split is provided and tran is NULL,
|
|
* split-action is returned; if tran is provided and split is NULL,
|
|
* transaction-num is returned. Otherwise NULL is returned.*/
|
|
const char * gnc_get_action_num (const Transaction *trans, const Split *split);
|
|
|
|
/** Sets the transaction Number and/or split Action based on book option:
|
|
* if the book option is TRUE (split action is to be used for NUM) then 'num'
|
|
* sets split-action and, if 'tran' and 'action' are provided, 'action'
|
|
* sets transaction-num; if book option is FALSE (tran-num is to be used for NUM)
|
|
* then 'num' sets transaction-num and, if 'split' and 'action' are
|
|
* provided, 'action' sets 'split-action'. If any arguments are NULL,
|
|
* no change is made to the field that would otherwise be
|
|
* affected. If 'tran' and 'num' are passed with 'split and 'action' set to
|
|
* NULL, it is xaccTransSetNum (trans, num). Likewise, if 'split and 'action'
|
|
* are passed with 'tran' and 'num' set to NULL, it is xaccSplitSetAction (split,
|
|
* action). */
|
|
void gnc_set_num_action (Transaction *trans, Split *split,
|
|
const char *num, const char *action);
|
|
|
|
/** Calls registered callbacks when num_field_source book option changes so that
|
|
* registers/reports can update themselves */
|
|
void
|
|
gnc_book_option_num_field_source_change (gboolean num_action);
|
|
|
|
/** Registers callbacks to be called when the book option changes for the
|
|
* specified book option key */
|
|
void
|
|
gnc_book_option_register_cb (const gchar *key, GncBOCb func, gpointer user_data);
|
|
|
|
/** Removes previously registered callbacks for the specified book option key */
|
|
void
|
|
gnc_book_option_remove_cb (const gchar *key, GncBOCb func, gpointer user_data);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|