split-register.h

Go to the documentation of this file.

/********************************************************************\
 * split-register.h -- split register API                           *
 *                                                                  *
 * 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 SPLIT_REGISTER_H
#define SPLIT_REGISTER_H

#include <glib.h>

#include "Transaction.h"
#include "table-allgui.h"

typedef enum
{
    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
} SplitRegisterType;

typedef enum
{
    REG_TYPE_GROUP_UNKNOWN,
    REG_TYPE_GROUP_CURRENCY,
    REG_TYPE_GROUP_APAR,
    REG_TYPE_GROUP_STOCK,
    REG_TYPE_GROUP_JOURNAL,
    REG_TYPE_GROUP_PORTFOLIO,
} SplitRegisterTypeGroup;

typedef enum
{
    REG_STYLE_LEDGER,
    REG_STYLE_AUTO_LEDGER,
    REG_STYLE_JOURNAL
} SplitRegisterStyle;

#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"

#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"

typedef enum
{
    CURSOR_CLASS_NONE = -1,
    CURSOR_CLASS_SPLIT,
    CURSOR_CLASS_TRANS,
    NUM_CURSOR_CLASSES
} CursorClass;


typedef struct split_register SplitRegister;
typedef struct sr_info SRInfo;

struct split_register
{
    Table* table;    
    SplitRegisterType type;
    SplitRegisterStyle style;

    gboolean use_double_line;  
    gboolean use_tran_num_for_num_field;  
    gboolean show_leaf_accounts; 
    gboolean double_alt_color;   
    gboolean is_template;
    gboolean do_auto_complete; 
    gboolean mismatched_commodities; 
    SplitList*
    unrecn_splits; 
    SRInfo* sr_info;    
};

typedef GtkWidget* (*SRGetParentCallback) (gpointer user_data);


/* Prototypes ******************************************************/

SplitRegister* gnc_split_register_new (SplitRegisterType type,
                                       SplitRegisterStyle style,
                                       gboolean use_double_line,
                                       gboolean is_template,
                                       gboolean mismatched_commodities);

void gnc_split_register_destroy (SplitRegister* reg);

void gnc_split_register_config (SplitRegister* reg,
                                SplitRegisterType type,
                                SplitRegisterStyle style,
                                gboolean use_double_line);

void gnc_split_register_set_reverse_sort (SplitRegister* reg,
                                          gboolean reverse_sort);

void gnc_split_register_set_auto_complete (SplitRegister* reg,
                                           gboolean do_auto_complete);

void gnc_split_register_set_read_only (SplitRegister* reg, gboolean read_only);

SplitRegisterTypeGroup gnc_split_register_get_register_group (SplitRegister *reg);

void gnc_split_register_set_template_account (SplitRegister* reg,
                                              Account* template_account);

void gnc_split_register_set_data (SplitRegister* reg, gpointer user_data,
                                  SRGetParentCallback get_parent);

CursorClass gnc_split_register_get_current_cursor_class (SplitRegister* reg);

CursorClass gnc_split_register_get_cursor_class
(SplitRegister* reg,
 VirtualCellLocation vcell_loc);

Transaction* gnc_split_register_get_current_trans (SplitRegister* reg);

Split*
gnc_split_register_get_current_trans_split (SplitRegister* reg,
                                            VirtualCellLocation* vcell_loc);

Split* gnc_split_register_get_current_split (SplitRegister* reg);

Split* gnc_split_register_get_blank_split (SplitRegister* reg);

gboolean
gnc_split_register_get_split_virt_loc (SplitRegister* reg, Split* split,
                                       VirtualCellLocation* vcell_loc);

gboolean
gnc_split_register_get_split_amount_virt_loc (SplitRegister* reg, Split* split,
                                              VirtualLocation* virt_loc);

Split* gnc_split_register_duplicate_current (SplitRegister* reg);

void gnc_split_register_copy_current (SplitRegister* reg);

void gnc_split_register_cut_current (SplitRegister* reg);

void gnc_split_register_paste_current (SplitRegister* reg);

void gnc_split_register_delete_current_split (SplitRegister* reg);

void gnc_split_register_delete_current_trans (SplitRegister* reg);

void gnc_split_register_void_current_trans (SplitRegister* reg,
                                            const char* reason);

void gnc_split_register_unvoid_current_trans (SplitRegister* reg);

void gnc_split_register_empty_current_trans_except_split (SplitRegister* reg,
                                                          Split* split);
void gnc_split_register_empty_current_trans (SplitRegister* reg);

void gnc_split_register_cancel_cursor_split_changes (SplitRegister* reg);

void gnc_split_register_cancel_cursor_trans_changes (SplitRegister* reg);

void gnc_split_register_load (SplitRegister* reg, GList* slist,
                              GList* pre_filter_slist, Account* default_account);

gboolean gnc_split_register_save (SplitRegister* reg, gboolean do_commit);

void gnc_split_register_redraw (SplitRegister* reg);

gboolean gnc_split_register_changed (SplitRegister* reg);

void gnc_split_register_show_present_divider (SplitRegister* reg,
                                              gboolean show_present);

void gnc_split_register_expand_current_trans (SplitRegister* reg,
                                              gboolean expand);

void gnc_split_register_collapse_current_trans (SplitRegister* reg);

gboolean gnc_split_register_current_trans_expanded (SplitRegister* reg);

const char* gnc_split_register_get_debit_string (SplitRegister* reg);

const char* gnc_split_register_get_credit_string (SplitRegister* reg);

gboolean gnc_split_register_is_blank_split (SplitRegister* reg, Split* split);

void gnc_split_register_change_blank_split_ref (SplitRegister* reg,
                                                Split* split);

gboolean
gnc_split_register_handle_exchange (SplitRegister* reg, gboolean force_dialog);

/* returns TRUE if begin_edit was aborted */
gboolean
gnc_split_register_begin_edit_or_warn (SRInfo* info, Transaction* trans);

/* -------------------------------------------------------------- */

gboolean gnc_split_register_full_refresh_ok (SplitRegister* reg);

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

#endif