Business Invoice Page

Files
file	gnc-plugin-page-invoice.h
	utility functions for the GnuCash UI

Data Structures
struct	GncPluginPageInvoice
struct	GncPluginPageInvoiceClass

Macros
#define	GNC_TYPE_PLUGIN_PAGE_INVOICE   (gnc_plugin_page_invoice_get_type ())
#define	GNC_PLUGIN_PAGE_INVOICE(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoice))
#define	GNC_PLUGIN_PAGE_INVOICE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoiceClass))
#define	GNC_IS_PLUGIN_PAGE_INVOICE(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE))
#define	GNC_IS_PLUGIN_PAGE_INVOICE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_INVOICE))
#define	GNC_PLUGIN_PAGE_INVOICE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoiceClass))
#define	GNC_PLUGIN_PAGE_INVOICE_NAME   "GncPluginPageInvoice"

Functions
GType	gnc_plugin_page_invoice_get_type (void)
	Retrieve the type number for an "invoice" plugin page.
GncPluginPage *	gnc_plugin_page_invoice_new (InvoiceWindow *iw)
	Create a new "invoice" plugin page, given a pointer to an InvoiceWindow data structure.
void	gnc_plugin_page_invoice_update_menus (GncPluginPage *page, gboolean is_posted, gboolean can_unpost)
	Update the menu items associated with this invoice page.
void	gnc_plugin_page_invoice_update_title (GncPluginPage *page)
	Update the title associated with this invoice page.
InvoiceWindow *	gnc_plugin_page_invoice_get_window (GncInvoice *invoice)
	Find the Invoice Window amongst the plugin pages for an Invoice, if not present return NULL.

Detailed Description

Macro Definition Documentation

GNC_IS_PLUGIN_PAGE_INVOICE

#define GNC_IS_PLUGIN_PAGE_INVOICE

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE))

Definition at line 48 of file gnc-plugin-page-invoice.h.

GNC_IS_PLUGIN_PAGE_INVOICE_CLASS

#define GNC_IS_PLUGIN_PAGE_INVOICE_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_INVOICE))

Definition at line 49 of file gnc-plugin-page-invoice.h.

GNC_PLUGIN_PAGE_INVOICE

#define GNC_PLUGIN_PAGE_INVOICE

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoice))

Definition at line 46 of file gnc-plugin-page-invoice.h.

GNC_PLUGIN_PAGE_INVOICE_CLASS

#define GNC_PLUGIN_PAGE_INVOICE_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoiceClass))

Definition at line 47 of file gnc-plugin-page-invoice.h.

GNC_PLUGIN_PAGE_INVOICE_GET_CLASS

#define GNC_PLUGIN_PAGE_INVOICE_GET_CLASS

(

obj

)

(G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_INVOICE, GncPluginPageInvoiceClass))

Definition at line 50 of file gnc-plugin-page-invoice.h.

GNC_PLUGIN_PAGE_INVOICE_NAME

#define GNC_PLUGIN_PAGE_INVOICE_NAME   "GncPluginPageInvoice"

Definition at line 52 of file gnc-plugin-page-invoice.h.

GNC_TYPE_PLUGIN_PAGE_INVOICE

#define GNC_TYPE_PLUGIN_PAGE_INVOICE   (gnc_plugin_page_invoice_get_type ())

Definition at line 45 of file gnc-plugin-page-invoice.h.

Function Documentation

gnc_plugin_page_invoice_get_type()

GType gnc_plugin_page_invoice_get_type

(

void

)

Retrieve the type number for an "invoice" plugin page.

Returns

The type number.

gnc_plugin_page_invoice_get_window()

InvoiceWindow * gnc_plugin_page_invoice_get_window

(

GncInvoice *

invoice

)

Find the Invoice Window amongst the plugin pages for an Invoice, if not present return NULL.

Parameters

page	A pointer to an invoice.

Returns

The invoice or NULL.

Definition at line 320 of file gnc-plugin-page-invoice.cpp.

{
    GncPluginPageInvoicePrivate *priv;
    GncPluginPageInvoice *invoice_page;
    const GList *item;
 
    /* Is there an existing page? */
    item = gnc_gobject_tracking_get_list (GNC_PLUGIN_PAGE_INVOICE_NAME);
    for ( ; item; item = g_list_next(item))
    {
        invoice_page = (GncPluginPageInvoice *)item->data;
        priv = GNC_PLUGIN_PAGE_INVOICE_GET_PRIVATE(invoice_page);
 
        if (gnc_invoice_window_get_invoice (priv->iw) == invoice)
            return priv->iw;
    }
    return NULL;
}

gnc_plugin_page_invoice_new()

GncPluginPage * gnc_plugin_page_invoice_new

(

InvoiceWindow *

iw

)

Create a new "invoice" plugin page, given a pointer to an InvoiceWindow data structure.

This structure is used to describe both the "invoice entry" page in a window, and also to describe the New Invoice dialog.

Parameters

iw	A pointer to the invoice to be embedded into a main window.

Returns

The newly created plugin page.

Definition at line 340 of file gnc-plugin-page-invoice.cpp.

{
    GncPluginPageInvoicePrivate *priv;
    GncPluginPageInvoice *invoice_page;
    GncPluginPage *plugin_page;
    const GList *item;
 
    /* Is there an existing page? */
    item = gnc_gobject_tracking_get_list(GNC_PLUGIN_PAGE_INVOICE_NAME);
    for ( ; item; item = g_list_next(item))
    {
        invoice_page = (GncPluginPageInvoice *)item->data;
        priv = GNC_PLUGIN_PAGE_INVOICE_GET_PRIVATE(invoice_page);
        if (priv->iw == iw)
            return GNC_PLUGIN_PAGE(invoice_page);
    }
 
    invoice_page = GNC_PLUGIN_PAGE_INVOICE (g_object_new (GNC_TYPE_PLUGIN_PAGE_INVOICE, nullptr));
    priv = GNC_PLUGIN_PAGE_INVOICE_GET_PRIVATE(invoice_page);
    priv->iw = iw;
 
    plugin_page = GNC_PLUGIN_PAGE(invoice_page);
    gnc_plugin_page_invoice_update_title(plugin_page);
 
    priv->component_manager_id = 0;
    return plugin_page;
}

gnc_plugin_page_invoice_update_menus()

void gnc_plugin_page_invoice_update_menus	(	GncPluginPage *	page,
		gboolean	is_posted,
		gboolean	can_unpost
	)

Update the menu items associated with this invoice page.

This function should be called whenever the posted state of an invoice is changed.

Parameters

page	A pointer invoice page.
is_posted	Set this to TRUE if the invoice has been posted.
can_unpost	Set this to TRUE if the invoice can be un-posted.

Definition at line 477 of file gnc-plugin-page-invoice.cpp.

{
    GncMainWindow *window;
    GSimpleActionGroup *simple_action_group;
    GAction *action;
    GncPluginPageInvoicePrivate *priv;
    GncInvoiceType invoice_type;
    GncInvoice *invoice;
    action_toolbar_labels *label_list;
    action_toolbar_labels *label_layout_list;
    gboolean has_uri = FALSE;
 
    gboolean is_readonly = qof_book_is_readonly(gnc_get_current_book());
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_INVOICE(page));
 
    priv = GNC_PLUGIN_PAGE_INVOICE_GET_PRIVATE(page);
 
    // lets remember these settings
    priv->is_posted = is_posted;
    priv->can_unpost = can_unpost;
 
    window = (GncMainWindow*)gnc_plugin_page_get_window (GNC_PLUGIN_PAGE(page));
    if (gnc_main_window_get_current_page (window) != page)
        return;
 
    invoice_type = gnc_invoice_get_type_from_window(priv->iw);
 
    switch (invoice_type) {
        case GNC_INVOICE_CUST_INVOICE:
            label_list = invoice_action_labels;
            break;
        case GNC_INVOICE_VEND_INVOICE:
            label_list = bill_action_labels;
            break;
        case GNC_INVOICE_EMPL_INVOICE:
            label_list = voucher_action_labels;
            break;
        case GNC_INVOICE_CUST_CREDIT_NOTE:  // fallthrough
        case GNC_INVOICE_VEND_CREDIT_NOTE:  // fallthrough
        case GNC_INVOICE_EMPL_CREDIT_NOTE:  // fallthrough
            label_list = creditnote_action_labels;
            break;
        default: // catches GNC_INVOICE_UNDEFINED, use invoice by default
            label_list = invoice_action_labels;
    }
 
    // layout actions
    switch (invoice_type) {
        case GNC_INVOICE_CUST_INVOICE:
        case GNC_INVOICE_CUST_CREDIT_NOTE:
            label_layout_list = invoice_action_layout_labels;
            break;
        case GNC_INVOICE_VEND_INVOICE:
        case GNC_INVOICE_VEND_CREDIT_NOTE:
            label_layout_list = bill_action_layout_labels;
            break;
        case GNC_INVOICE_EMPL_INVOICE:
        case GNC_INVOICE_EMPL_CREDIT_NOTE:
            label_layout_list = voucher_action_layout_labels;
            break;
        default: // catches GNC_INVOICE_UNDEFINED, use invoice by default
            label_layout_list = invoice_action_layout_labels;
    }
 
    if (is_readonly)
    {
        // Are we readonly? Then don't allow any actions.
        is_posted = TRUE;
        can_unpost = FALSE;
    }
 
    /* Enable the FilePrintAction */
    action = gnc_main_window_find_action (window, "FilePrintAction");
    g_simple_action_set_enabled (G_SIMPLE_ACTION(action), TRUE);
 
    simple_action_group = gnc_plugin_page_get_action_group (page);
    gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), posted_actions,
                                    is_posted);
    gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), unposted_actions,
                                    !is_posted);
    gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), can_unpost_actions,
                                    can_unpost);
    gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), invoice_book_readwrite_actions,
                                    !is_readonly);
 
    /* update the action labels and tooltips */
    gnc_plugin_page_invoice_action_update (page, label_list);
 
    // if there is no default layout do not enable reset action
    gnc_plugin_page_update_reset_layout_action (page);
 
    /* update the layout action labels and tooltips */
    gnc_plugin_page_invoice_action_update (page, label_layout_list);
 
    // update doclink buttons
    invoice = gnc_invoice_window_get_invoice (priv->iw);
    if (gncInvoiceGetDocLink (invoice))
        has_uri = TRUE;
 
    update_doclink_actions (page, has_uri);
}

gnc_plugin_page_invoice_update_title()

void gnc_plugin_page_invoice_update_title

(

GncPluginPage *

page

)

Update the title associated with this invoice page.

This function should be called whenever the name on an invoice is changed.

Parameters

page	A pointer invoice page.

Definition at line 1391 of file gnc-plugin-page-invoice.cpp.

{
    GncPluginPageInvoice *page;
    GncPluginPageInvoicePrivate *priv;
    gchar *title;
 
    g_return_if_fail(GNC_IS_PLUGIN_PAGE_INVOICE(plugin_page));
 
    page = GNC_PLUGIN_PAGE_INVOICE(plugin_page);
    priv = GNC_PLUGIN_PAGE_INVOICE_GET_PRIVATE(page);
    title = gnc_invoice_get_title(priv->iw);
    main_window_update_page_name(plugin_page, title);
    g_free(title);
}