gnc-plugin-page-register.h

Go to the documentation of this file.

/**********************************************************************
 * gnc-plugin-page-register.h -- register page functions              *
 *                                                                    *
 * Copyright (C) 2003 Jan Arne Petersen <jpetersen@uni-bonn.de>       *
 * Copyright (C) 2003,2005,2006 David Hampton <hampton@employees.org> *
 *                                                                    *
 * 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 __GNC_PLUGIN_PAGE_REGISTER_H
#define __GNC_PLUGIN_PAGE_REGISTER_H

#include <gtk/gtk.h>

#include "Account.h"
#include "gnc-ledger-display.h"
#include "gnc-plugin-page.h"
#include "gnc-split-reg.h"
#include "Query.h"
#include "gnc-plugin-page-register-filter.hpp"
#include "gnc-plugin-page-register-sort.hpp"


#ifdef __cplusplus
extern "C"
{
#endif

G_BEGIN_DECLS

/* type macros */
#define GNC_TYPE_PLUGIN_PAGE_REGISTER            (gnc_plugin_page_register_get_type ())
#define GNC_PLUGIN_PAGE_REGISTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegister))
#define GNC_PLUGIN_PAGE_REGISTER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
#define GNC_IS_PLUGIN_PAGE_REGISTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER))
#define GNC_IS_PLUGIN_PAGE_REGISTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER))
#define GNC_PLUGIN_PAGE_REGISTER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
#define GNC_PLUGIN_PAGE_REGISTER_NAME "GncPluginPageRegister"

/* typedefs & structures */
typedef struct
{
    GncPluginPage gnc_plugin_page;
} GncPluginPageRegister;

typedef struct
{
    GncPluginPageClass gnc_plugin_page;
} GncPluginPageRegisterClass;

/* function prototypes */

GType gnc_plugin_page_register_get_type (void);


GncPluginPage * gnc_plugin_page_register_new (Account *account, gboolean subaccounts);


GncPluginPage * gnc_plugin_page_register_new_ledger (GNCLedgerDisplay *ledger);


GncPluginPage * gnc_plugin_page_register_new_gl (void);


void gnc_plugin_page_register_set_options (GncPluginPage *plugin_page,
                                           gint lines_default,
                                           gboolean read_only);


GNCSplitReg * gnc_plugin_page_register_get_gsr (GncPluginPage *plugin_page);

struct FilterData * gnc_plugin_page_register_get_filter_data (GncPluginPage *plugin_page);

struct SortData * gnc_plugin_page_register_get_sort_data (GncPluginPage *plugin_page);

Query * gnc_plugin_page_register_get_query (GncPluginPage *plugin_page);

void gnc_plugin_page_register_update_for_search_query (GncPluginPageRegister* page);

void gnc_plugin_page_register_query_update (GncPluginPageRegister* page, Query *query);

void gnc_plugin_register_set_enable_refresh (GncPluginPageRegister* page, gboolean enable_refresh);

Account * gnc_plugin_page_register_get_account (GncPluginPageRegister *page);


Transaction * gnc_plugin_page_register_get_current_txn (GncPluginPageRegister *page);


void gnc_plugin_page_register_clear_current_filter (GncPluginPage* plugin_page);


G_END_DECLS
#ifdef __cplusplus
}
#endif

#endif /* __GNC_PLUGIN_PAGE_REGISTER_H */