API for checkbook register display area. More...

#include <glib.h>
#include "Transaction.h"
#include "table-allgui.h"

Data Structures
struct	SplitRegister
	The type, style and table for the register. More...

Macros
Cell Names
T* cells are transaction summary cells
#define	ACTN_CELL "action"

#define	DOCLINK_CELL "doclink"

#define	BALN_CELL "balance"

#define	CRED_CELL "credit"

#define	DATE_CELL "date"

#define	DDUE_CELL "date-due"

#define	DEBT_CELL "debit"

#define	DESC_CELL "description"

#define	FCRED_CELL "credit-formula"

#define	FDEBT_CELL "debit-formula"

#define	MEMO_CELL "memo"

#define	MXFRM_CELL "transfer"

#define	NOTES_CELL "notes"

#define	NUM_CELL "num"

#define	TNUM_CELL "trans-num"

#define	PRIC_CELL "price"

#define	RATE_CELL "exchrate"

#define	RECN_CELL "reconcile"

#define	SHRS_CELL "shares"

#define	TBALN_CELL "trans-balance"

#define	TCRED_CELL "trans-credit"

#define	TDEBT_CELL "trans-debit"

#define	TSHRS_CELL "trans-shares"

#define	TYPE_CELL "split-type"

#define	XFRM_CELL "account"

#define	VNOTES_CELL "void-notes"

#define	RBALN_CELL "reg-run-balance"

Cursor Names
Cursors ending in 'NUM_ACTN' use the split action field for the NUM_CELL rather than the transaction number field which is shown in the TNUM_CELL
#define	CURSOR_SINGLE_LEDGER "cursor-single-ledger"

#define	CURSOR_DOUBLE_LEDGER "cursor-double-ledger"

#define	CURSOR_DOUBLE_LEDGER_NUM_ACTN "cursor-double-ledger-num-actn"

#define	CURSOR_SINGLE_JOURNAL "cursor-single-journal"

#define	CURSOR_DOUBLE_JOURNAL "cursor-double-journal"

#define	CURSOR_DOUBLE_JOURNAL_NUM_ACTN "cursor-double-journal-num-actn"

#define	CURSOR_SPLIT "cursor-split"

Typedefs
typedef GtkWidget (	SRGetParentCallback) (gpointer user_data)
	Callback function type.

Enumerations
enum	SplitRegisterType { BANK_REGISTER , CASH_REGISTER , ASSET_REGISTER , CREDIT_REGISTER , LIABILITY_REGISTER , INCOME_REGISTER , EXPENSE_REGISTER , EQUITY_REGISTER , STOCK_REGISTER , CURRENCY_REGISTER , RECEIVABLE_REGISTER , PAYABLE_REGISTER , TRADING_REGISTER , NUM_SINGLE_REGISTER_TYPES , GENERAL_JOURNAL = NUM_SINGLE_REGISTER_TYPES , INCOME_LEDGER , PORTFOLIO_LEDGER , SEARCH_LEDGER , NUM_REGISTER_TYPES }
	Register types. More...

enum	SplitRegisterTypeGroup { REG_TYPE_GROUP_UNKNOWN , REG_TYPE_GROUP_CURRENCY , REG_TYPE_GROUP_APAR , REG_TYPE_GROUP_STOCK , REG_TYPE_GROUP_JOURNAL , REG_TYPE_GROUP_PORTFOLIO }
	Register group types. More...

enum	SplitRegisterStyle { REG_STYLE_LEDGER , REG_STYLE_AUTO_LEDGER , REG_STYLE_JOURNAL }
	Register styles. More...

enum	CursorClass { CURSOR_CLASS_NONE = -1 , CURSOR_CLASS_SPLIT , CURSOR_CLASS_TRANS , NUM_CURSOR_CLASSES }
	Types of cursors. More...

Functions
SplitRegister *	gnc_split_register_new (SplitRegisterType type, SplitRegisterStyle style, gboolean use_double_line, gboolean is_template, gboolean mismatched_commodities)
	Creates a new split register.

void	gnc_split_register_destroy (SplitRegister *reg)
	Destroys a split register.

void	gnc_split_register_config (SplitRegister *reg, SplitRegisterType type, SplitRegisterStyle style, gboolean use_double_line)
	Sets a split register's type, style or line use.

void	gnc_split_register_set_reverse_sort (SplitRegister *reg, gboolean reverse_sort)
	Sets a split register's reverse sort order based on register.

void	gnc_split_register_set_auto_complete (SplitRegister *reg, gboolean do_auto_complete)
	Sets whether a register uses auto-completion.

void	gnc_split_register_set_read_only (SplitRegister *reg, gboolean read_only)
	Sets whether a register window is "read only".

SplitRegisterTypeGroup	gnc_split_register_get_register_group (SplitRegister *reg)
	Group registers for common layouts.

void	gnc_split_register_set_template_account (SplitRegister reg, Account template_account)
	Set the template account for use in a template register.

void	gnc_split_register_set_data (SplitRegister *reg, gpointer user_data, SRGetParentCallback get_parent)
	Sets the user data and callback hooks for the register.

CursorClass	gnc_split_register_get_current_cursor_class (SplitRegister *reg)
	Returns the class of a register's current cursor.

CursorClass	gnc_split_register_get_cursor_class (SplitRegister *reg, VirtualCellLocation vcell_loc)
	Returns the class of the cursor at the given virtual cell location.

Transaction *	gnc_split_register_get_current_trans (SplitRegister *reg)
	Gets the transaction at the current cursor location, which may be on the transaction itself or on any of its splits.

Split *	gnc_split_register_get_current_trans_split (SplitRegister reg, VirtualCellLocation vcell_loc)
	Gets the anchoring split of the transaction at the current cursor location, which may be on the transaction itself or on any of its splits.

Split *	gnc_split_register_get_current_split (SplitRegister *reg)
	Returns the split at which the cursor is currently located.

Split *	gnc_split_register_get_blank_split (SplitRegister *reg)
	Gets the blank split for a register.

gboolean	gnc_split_register_get_split_virt_loc (SplitRegister reg, Split split, VirtualCellLocation *vcell_loc)
	Searches the split register for a given split.

gboolean	gnc_split_register_get_split_amount_virt_loc (SplitRegister reg, Split split, VirtualLocation *virt_loc)
	Searches the split register for the given split and determines the location of either its credit (if non-zero) or debit cell.

Split *	gnc_split_register_duplicate_current (SplitRegister *reg)
	Duplicates either the current transaction or the current split depending on the register mode and cursor position.

gboolean	gnc_split_register_has_copied_item (void)
	Return TRUE if copied_item holds a transaction or split.

void	gnc_split_register_copy_current (SplitRegister *reg)
	Makes a copy of the current entity, either a split or a transaction, so that it can be pasted later.

void	gnc_split_register_cut_current (SplitRegister *reg)
	Equivalent to copying the current entity and the deleting it with the appropriate delete method.

void	gnc_split_register_paste_current (SplitRegister *reg)
	Pastes a previous copied entity onto the current entity, but only if the copied and current entity have the same type.

void	gnc_split_register_delete_current_split (SplitRegister *reg)
	Deletes the split associated with the current cursor, if both are non-NULL.

void	gnc_split_register_delete_current_trans (SplitRegister *reg)
	Deletes the transaction associated with the current cursor, if both are non-NULL.

void	gnc_split_register_void_current_trans (SplitRegister reg, const char reason)
	Voids the transaction associated with the current cursor, if non-NULL.

void	gnc_split_register_unvoid_current_trans (SplitRegister *reg)
	Unvoids the transaction associated with the current cursor, if non-NULL.

void	gnc_split_register_empty_current_trans_except_split (SplitRegister reg, Split split)
	Deletes the non-transaction splits associated with the current cursor, if both are non-NULL.

void	gnc_split_register_empty_current_trans (SplitRegister *reg)

void	gnc_split_register_cancel_cursor_split_changes (SplitRegister *reg)
	Cancels any changes made to the current cursor, reloads the cursor from the engine, reloads the table from the cursor, and updates the GUI.

void	gnc_split_register_cancel_cursor_trans_changes (SplitRegister *reg)
	Cancels any changes made to the current pending transaction, reloads the table from the engine, and updates the GUI.

void	gnc_split_register_load (SplitRegister reg, GList slist, GList pre_filter_slist, Account default_account)
	Populates the rows of a register.

gboolean	gnc_split_register_save (SplitRegister *reg, gboolean do_commit)
	Copy the contents of the current cursor to a split.

void	gnc_split_register_redraw (SplitRegister *reg)
	Causes a redraw of the register window associated with reg.

gboolean	gnc_split_register_changed (SplitRegister *reg)
	Returns TRUE if the register has changed cells.

void	gnc_split_register_show_present_divider (SplitRegister *reg, gboolean show_present)
	If TRUE, visually indicate the demarcation between splits with post dates prior to the present, and after.

void	gnc_split_register_expand_current_trans (SplitRegister *reg, gboolean expand)
	Expand the current transaction if it is collapsed.

void	gnc_split_register_collapse_current_trans (SplitRegister *reg)
	Mark the current transaction as collapsed, and do callbacks.

gboolean	gnc_split_register_current_trans_expanded (SplitRegister *reg)
	Return TRUE if current trans is expanded and style is REG_STYLE_LEDGER.

const char *	gnc_split_register_get_debit_string (SplitRegister *reg)
	Return the debit string used in the register.

const char *	gnc_split_register_get_credit_string (SplitRegister *reg)
	Return the credit string used in the register.

gboolean	gnc_split_register_is_blank_split (SplitRegister reg, Split split)
	Return TRUE if split is the blank_split.

void	gnc_split_register_change_blank_split_ref (SplitRegister reg, Split split)
	Change the blank_split reference from pointing to split to another split of the transaction.

gboolean	gnc_split_register_handle_exchange (SplitRegister *reg, gboolean force_dialog)
	Pop up the exchange-rate dialog, maybe, for the current split.

gboolean	gnc_split_register_begin_edit_or_warn (SRInfo info, Transaction trans)

gboolean	gnc_split_register_full_refresh_ok (SplitRegister *reg)
	Private function – outsiders must not use this.

void	gnc_copy_trans_onto_trans (Transaction from, Transaction to, gboolean use_cut_semantics, Account *template_account, gboolean do_commit)
	Private function – outsiders must not use this.

Detailed Description

API for checkbook register display area.

Author: Copyright (C) 1998-2000 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g

Definition in file split-register.h.

Function Documentation

◆ gnc_copy_trans_onto_trans()

void gnc_copy_trans_onto_trans	(	Transaction *	from,
		Transaction *	to,
		gboolean	use_cut_semantics,
		Account *	template_account,
		gboolean	do_commit
	)

Private function – outsiders must not use this.

Definition at line 137 of file split-register.c.

{
    FloatingTxn *ft;
    gboolean is_template = FALSE;
 
    if ((from == NULL) || (to == NULL))
        return;
 
    if (template_account)
        is_template = TRUE;
 
    ft = gnc_txn_to_float_txn (from, use_cut_semantics, is_template);
    if (!ft)
        return;
 
    if (is_template)
        gnc_float_txn_to_template_txn (ft, to, template_account, do_commit);
    else
        gnc_float_txn_to_txn (ft, to, do_commit);
 
    gnc_float_txn_free (ft);
}

◆ gnc_split_register_full_refresh_ok()

gboolean gnc_split_register_full_refresh_ok ( SplitRegister * reg )

Private function – outsiders must not use this.

Definition at line 2589 of file split-register.c.

{
    SRInfo* info = gnc_split_register_get_info (reg);
 
    if (!info)
        return FALSE;
 
    return info->full_refresh;
}

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ gnc_copy_trans_onto_trans()

◆ gnc_split_register_full_refresh_ok()