/*******************************************************************\
 * account-tree.h -- GNOME account tree functions                   *
 * Copyright (C) 1998,1999 Linas Vepstas                            *
 * Copyright (C) 2000 Dave Peticolas <peticola@cs.ucdavis.edu>      *
 *                                                                  *
 * 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       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
\********************************************************************/

#ifndef GNC_ACCOUNT_TREE_H
#define GNC_ACCOUNT_TREE_H

#include <gtk/gtkctree.h>

#include "Group.h"
#include "gnc-ui-util.h"

#ifdef __cplusplus
extern "C" {
#endif				/* __cplusplus */

#define GTK_TYPE_GNC_ACCOUNT_TREE (gnc_account_tree_get_type ())
#define GNC_ACCOUNT_TREE(obj)     (GTK_CHECK_CAST ((obj), GTK_TYPE_GNC_ACCOUNT_TREE, GNCAccountTree))
#define GNC_ACCOUNT_TREE_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_GNC_ACCOUNT_TREE, GNCAccountTreeClass))
#define IS_GNC_ACCOUNT_TREE(obj)  (GTK_CHECK_TYPE ((obj), GTK_TYPE_GNC_ACCOUNT_TREE))
#define IS_GNC_ACCOUNT_TREE_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_GNC_ACCOUNT_TREE))

typedef struct GNCAccountTree_s      GNCAccountTree;
typedef struct GNCAccountTreeClass_s GNCAccountTreeClass;
typedef struct AccountViewInfo_s     AccountViewInfo;

typedef gboolean (*AccountFilter) (Account *account, gpointer user_data);

struct AccountViewInfo_s
{
  gboolean include_type[NUM_ACCOUNT_TYPES];

  gboolean show_field[NUM_ACCOUNT_FIELDS];
};

struct GNCAccountTree_s
{
  GtkCTree ctree;

  AccountFilter view_filter;
  gpointer view_filter_data;

  AccountFilter selectable_filter;
  gpointer selectable_filter_data;

  AccountViewInfo avi;

  gint num_columns;
  gint description_column;
  gint balance_column;
  gint total_column;
  AccountFieldCode column_fields[NUM_ACCOUNT_FIELDS];

  const gchar * column_headings[NUM_ACCOUNT_FIELDS + 1];

  GtkStyle *deficit_style;

  GUID root_account;

  GList * current_accounts;

  gboolean ignore_unselect;
};

struct GNCAccountTreeClass_s
{
  GtkCTreeClass parent_class;

  void (*select_account)   (GNCAccountTree *tree,
                            Account        *account);

  void (*unselect_account) (GNCAccountTree *tree,
                            Account        *account);

  void (*activate_account) (GNCAccountTree *tree,
                            Account        *account);
};

/***********************************************************
 *                public functions                         *
 ***********************************************************/

GtkType gnc_account_tree_get_type (void);

GtkWidget * gnc_account_tree_new (void);

GtkWidget * gnc_account_tree_new_with_root (Account *account);

void gnc_account_tree_refresh (GNCAccountTree *tree);

gboolean gnc_account_tree_select_account (GNCAccountTree *tree,
					  Account *account,
                                          gboolean show_account);

gboolean gnc_account_tree_select_subaccounts (GNCAccountTree *tree,
                                              Account *account,
                                              gboolean show_account);

gboolean gnc_account_tree_select_accounts (GNCAccountTree *tree,
                                           GList          *account_list,
                                           gboolean        show_last);

gboolean gnc_account_tree_unselect_account (GNCAccountTree *tree,
                                            Account        *account,
                                            gboolean       show_account);

gboolean gnc_account_tree_unselect_subaccounts (GNCAccountTree *tree,
                                                Account *account,
                                                gboolean show_account);

void gnc_account_tree_expand_account (GNCAccountTree *tree,
                                      Account *account);

void gnc_account_tree_toggle_account_expansion (GNCAccountTree *tree,
                                                Account *account);

void gnc_account_tree_expand_all (GNCAccountTree *tree);

void gnc_account_tree_show_income_expense (GNCAccountTree *tree);

void gnc_account_tree_hide_income_expense (GNCAccountTree *tree);

Account * gnc_account_tree_get_current_account (GNCAccountTree *tree);
GList *   gnc_account_tree_get_current_accounts (GNCAccountTree *tree);

Account * gnc_account_tree_get_focus_account (GNCAccountTree *tree);

gboolean  gnc_account_tree_account_selected (GNCAccountTree *tree,
                                             Account *account);

void gnc_account_tree_hide_all_but_name (GNCAccountTree *tree);

void gnc_init_account_view_info(AccountViewInfo *avi);

void gnc_account_tree_set_view_info (GNCAccountTree *tree,
				     AccountViewInfo *info);

void gnc_account_tree_get_view_info (GNCAccountTree *tree,
				     AccountViewInfo *info);

void gnc_account_tree_set_view_filter (GNCAccountTree *tree,
                                       AccountFilter filter,
                                       gpointer user_data);

void gnc_account_tree_set_selectable_filter (GNCAccountTree *tree,
                                             AccountFilter filter,
                                             gpointer user_data);

#ifdef __cplusplus
}
#endif				/* __cplusplus */

#endif				/* GNC_ACCOUNT_TREE_H */