An Owner Tree Plugin

Files
file	gnc-plugin-page-owner-tree.h
	Functions providing a page which lists owners of one type.

Data Structures
struct	GncPluginPageOwnerTreePrivate
struct	action_owners_struct
	Map actions to owners. More...
struct	GncPluginPageOwnerTree
struct	GncPluginPageOwnerTreeClass

Macros
#define	PLUGIN_PAGE_ACCT_TREE_CM_CLASS   "plugin-page-owner-tree"
#define	DELETE_DIALOG_FILTER   "filter"
#define	DELETE_DIALOG_OWNER   "owner"
#define	GNC_PLUGIN_PAGE_OWNER_TREE_GET_PRIVATE(o)   ((GncPluginPageOwnerTreePrivate*)gnc_plugin_page_owner_tree_get_instance_private((GncPluginPageOwnerTree*)o))
#define	OWNER_TYPE_LABEL   "OwnerType"
#define	GNC_TYPE_PLUGIN_PAGE_OWNER_TREE   (gnc_plugin_page_owner_tree_get_type ())
#define	GNC_PLUGIN_PAGE_OWNER_TREE(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_OWNER_TREE, GncPluginPageOwnerTree))
#define	GNC_PLUGIN_PAGE_OWNER_TREE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_OWNER_TREE, GncPluginPageOwnerTreeClass))
#define	GNC_IS_PLUGIN_PAGE_OWNER_TREE(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_OWNER_TREE))
#define	GNC_IS_PLUGIN_PAGE_OWNER_TREE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_OWNER_TREE))
#define	GNC_PLUGIN_PAGE_OWNER_TREE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_OWNER_TREE, GncPluginPageOwnerTreeClass))
#define	GNC_PLUGIN_PAGE_OWNER_TREE_NAME   "GncPluginPageOwnerTree"

Enumerations
enum	{ OWNER_SELECTED, LAST_SIGNAL }

Functions
GncPluginPage *	gnc_plugin_page_owner_tree_new (GncOwnerType owner_type)
	Create a new "owner tree" plugin page. More...
GncOwner *	gnc_plugin_page_owner_tree_get_current_owner (GncPluginPageOwnerTree *page)
	Given a pointer to an owner tree plugin page, return the selected owner (if any). More...
GType	gnc_plugin_page_owner_tree_get_type (void)
	Retrieve the type number for an "owner tree" plugin page. More...

Detailed Description

Function Documentation

gnc_plugin_page_owner_tree_get_current_owner()

GncOwner * gnc_plugin_page_owner_tree_get_current_owner

(

GncPluginPageOwnerTree *

page

)

Given a pointer to an owner tree plugin page, return the selected owner (if any).

Parameters

page	The "owner tree" page.

Returns

The currently selected owner. NULL if no owner is selected.

Definition at line 448 of file gnc-plugin-page-owner-tree.cpp.

{
    GncPluginPageOwnerTreePrivate *priv;
    GncOwner *owner;

    priv = GNC_PLUGIN_PAGE_OWNER_TREE_GET_PRIVATE(page);
    ENTER("page %p (tree view %p)", page, priv->tree_view);
    owner = gnc_tree_view_owner_get_selected_owner (GNC_TREE_VIEW_OWNER(priv->tree_view));
    if (owner == NULL)
    {
        LEAVE("no owner");
        return NULL;
    }

    LEAVE("owner %p", owner);
    return owner;
}

gnc_plugin_page_owner_tree_get_type()

GType gnc_plugin_page_owner_tree_get_type

(

void

)

Retrieve the type number for an "owner tree" plugin page.

Returns

The type number.

gnc_plugin_page_owner_tree_new()

GncPluginPage * gnc_plugin_page_owner_tree_new

(

GncOwnerType

owner_type

)

Create a new "owner tree" plugin page.

Parameters

owner_type

The owner type to create a page for. Can be any of the owner types defined in GnuCash, like vendor, customer,...

Returns

The newly created plugin page.

Definition at line 247 of file gnc-plugin-page-owner-tree.cpp.

{
    GncPluginPageOwnerTree *plugin_page;
    GncPluginPageOwnerTreePrivate *priv;
    const GList *item;

    g_return_val_if_fail( (owner_type != GNC_OWNER_UNDEFINED)
                          && (owner_type != GNC_OWNER_NONE), NULL);
    ENTER(" ");

    /* Is there an existing page? */
    item = gnc_gobject_tracking_get_list(GNC_PLUGIN_PAGE_OWNER_TREE_NAME);
    for ( ; item; item = g_list_next(item))
    {
        plugin_page = (GncPluginPageOwnerTree *)item->data;
        priv = GNC_PLUGIN_PAGE_OWNER_TREE_GET_PRIVATE(plugin_page);
        if (priv->owner_type == owner_type)
        {
            LEAVE("existing %s tree page %p", gncOwnerTypeToQofIdType(owner_type), plugin_page);
            return GNC_PLUGIN_PAGE(plugin_page);
        }
    }

    plugin_page = GNC_PLUGIN_PAGE_OWNER_TREE(g_object_new(GNC_TYPE_PLUGIN_PAGE_OWNER_TREE, nullptr));

    priv = GNC_PLUGIN_PAGE_OWNER_TREE_GET_PRIVATE(plugin_page);
    priv->owner_type = owner_type;

    LEAVE("new %s tree page %p", gncOwnerTypeToQofIdType(owner_type), plugin_page);
    return GNC_PLUGIN_PAGE(plugin_page);
}