[Gnucash-changes] new, account-name quickfill utility

[Linas Vepstas]

Log Message:
-----------
new, account-name quickfill utility

Added Files:
-----------
    gnucash/src/gnome-utils:
        account-quickfill.h

Revision Data
-------------
--- /dev/null
+++ src/gnome-utils/account-quickfill.h
@@ -0,0 +1,75 @@
+/********************************************************************\
+ * account-quickfill.h -- Create an account-name quick-fill         *
+ *                                                                  *
+ * 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 at gnu.org                   *
+ *                                                                  *
+\********************************************************************/
+/** @addtogroup Account_Quickfill Quickfill Account Names
+    For systems with a large number of accounts (>500), the creation 
+    of the account name quickfill can take a significant amount of 
+    time (tens of seconds in bad cases).  This routine will build 
+    a cache of account names that can be shared by all registers, 
+    thus dramatically improving the performance of opening a new 
+    register.
+    @{ 
+
+    @file account-quickfill.h
+    @brief Create an account-name quick-fill
+    @author Copyright (C) 2004 Linas Vepstas <linas at linas.org>
+*/
+
+#ifndef QUICKFILL_ACCOUNT_H
+#define QUICKFILL_ACCOUNT_H
+
+#include <glib.h>
+
+#include "Account.h"
+#include "Group.h"
+#include "QuickFill.h"
+
+typedef gboolean (*AccountBoolCB) (Account *, gpointer);
+
+/** Create/fetch a quickfill of account names.  
+ *
+ *  The quickfill is created out of all of the subaccounts 
+ *  the the account group, filtered by the 'skip_cb' callback.
+ *  If 'skip_cb' is not NULL, and if it returns TRUE when passed
+ *  a particular account, then that account won't be included in
+ *  the quickfill.  The 'cb_data' is passed to the callback.
+ *
+ *  The quickfill is created only once; it is then stored with
+ *  the QofBook that is the parent of the AccountGroup.  It is
+ *  automatically destroyed when the QofBook is destroyed.
+ *
+ *  Multiple, distinct quickfills, for different uses, are allowed. 
+ *  Each is identified with the 'key'.  Be sure to use distinct, 
+ *  unique keys that don't conflict with other users of QofBook.
+ *
+ *  This code listens to account creation events, and automatically
+ *  adds new accounts to the quickfill list (assuming skip_cb allows
+ *  it).  This code does not currently listen to account-destroy
+ *  events.
+ */
+QuickFill * gnc_get_shared_account_name_quickfill (AccountGroup *group,
+                                                   const char * key,
+                                                   AccountBoolCB skip_cb, 
+                                                   gpointer cb_data);
+
+#endif
+
+/** @} */