split-register-p.h

Go to the documentation of this file.

/********************************************************************\
 * split-register-p.h -- private split register declarations        *
 *                                                                  *
 * 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_P_H
#define SPLIT_REGISTER_P_H

#ifdef __cplusplus
extern "C" {
#endif

#include "split-register.h"

#define SPLIT_TRANS_STR _("-- Split Transaction --")
#define STOCK_SPLIT_STR _("-- Stock Split --")

#define ACTION_BUY_STR  _("Buy")
#define ACTION_SELL_STR _("Sell")

typedef enum {
    RATE_RESET_NOT_REQD = 0,
    RATE_RESET_REQD     = 1,
    RATE_RESET_DONE     = 2
} RateReset_t;

struct sr_info
{
    GncGUID blank_split_guid;

    GncGUID pending_trans_guid;

    Transaction *cursor_hint_trans;

    Split *cursor_hint_split;

    Split *cursor_hint_trans_split;

    CursorClass cursor_hint_cursor_class;

    gboolean hint_set_by_traverse;

    gboolean traverse_to_new;

    gboolean exact_traversal;

    gboolean trans_expanded;

    gboolean reg_loaded;

    gboolean full_refresh;

    GncGUID default_account;

    time64 last_date_entered;

    gboolean blank_split_edited;

    gboolean show_present_divider;

    gboolean first_pass;

    gboolean quickfill_setup;

    gboolean change_confirmed;

    RateReset_t rate_reset;

    gboolean auto_complete;

    Account *rate_account;

    gpointer user_data;

    SRGetParentCallback get_parent;

    GncGUID template_account;

    const char *debit_str;
    const char *credit_str;
    char *tdebit_str;
    char *tcredit_str;

    gboolean separator_changed;
};


SRInfo * gnc_split_register_get_info (SplitRegister *reg);

GtkWidget *gnc_split_register_get_parent (SplitRegister *reg);

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

Account * gnc_split_register_get_default_account (SplitRegister *reg);

Transaction * gnc_split_register_get_trans (SplitRegister *reg,
        VirtualCellLocation vcell_loc);

Split *
gnc_split_register_get_trans_split (SplitRegister *reg,
                                    VirtualCellLocation vcell_loc,
                                    VirtualCellLocation *trans_split_loc);

gboolean gnc_split_register_find_split (SplitRegister *reg,
                                        Transaction *trans, Split *trans_split,
                                        Split *split, CursorClass cursor_class,
                                        VirtualCellLocation *vcell_loc);

void gnc_split_register_show_trans (SplitRegister *reg,
                                    VirtualCellLocation start_loc);

void gnc_split_register_set_trans_visible (SplitRegister *reg,
        VirtualCellLocation vcell_loc,
        gboolean visible,
        gboolean only_blank_split);

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

CellBlock * gnc_split_register_get_passive_cursor (SplitRegister *reg);
CellBlock * gnc_split_register_get_active_cursor (SplitRegister *reg);

void gnc_split_register_set_last_num (SplitRegister *reg, const char *num);

Account * gnc_split_register_get_account_by_name(
    SplitRegister *reg, BasicCell * cell, const char *name);
Account * gnc_split_register_get_account (SplitRegister *reg,
        const char *cell_name);

gboolean gnc_split_register_recn_cell_confirm (char old_flag, gpointer data);

gboolean gnc_split_register_check_cell (SplitRegister *reg,
                                        const char *cell_name);

CursorClass gnc_split_register_cursor_name_to_class (const char *cursor_name);

gnc_numeric gnc_split_register_debcred_cell_value (SplitRegister *reg);

gboolean gnc_split_reg_has_rate_cell (SplitRegisterType type);
gboolean gnc_split_register_split_needs_amount(
    SplitRegister *reg, Split *split);
gboolean gnc_split_register_needs_conv_rate(
    SplitRegister *reg, Transaction *txn, Account *acc);

#ifdef __cplusplus
}
#endif

#endif