File History Menu Items

Files
file	gnc-plugin-file-history.c
	Functions providing the file history menu.
file	gnc-plugin-file-history.h
	Functions providing the file history menu.

Data Structures
struct	_GncPluginFileHistory
	The instance data structure for a file history plugin. More...

Macros
#define	FILENAME_STRING   "filename"
#define	MAX_HISTORY_FILES   10 /* May be any number up to 10 */
#define	GNC_PREFS_GROUP_HISTORY   "history"
#define	GNC_PREF_HISTORY_MAXFILES   "maxfiles"
#define	HISTORY_STRING_FILE_N   "file%d"
#define	PLUGIN_ACTIONS_NAME   "gnc-plugin-file-history-actions"
	The label given to the main window for this plugin.
#define	PLUGIN_UI_FILENAME   "gnc-plugin-file-history.ui"
	The name of the UI description file for this plugin.
#define	GNOME1_HISTORY   "History"
#define	GNOME1_MAXFILES   "MaxFiles"
#define	GNC_TYPE_PLUGIN_FILE_HISTORY   (gnc_plugin_file_history_get_type ())
#define	GNC_PLUGIN_FILE_HISTORY_NAME   "gnc-plugin-file-history"

Functions
void	gnc_history_add_file (const char *filename)
	Add a file name to the front of the file "history list".
void	gnc_history_remove_file (const char *oldfile)
	Remove all occurrences of a file name from the history list.
gboolean	gnc_history_test_for_file (const char *oldfile)
	Test for a file name existing in the history list.
char *	gnc_history_get_last (void)
	Retrieve the name of the file most recently accessed.
GncPlugin *	gnc_plugin_file_history_new (void)
	Create a new file history plugin.

Detailed Description

Macro Definition Documentation

FILENAME_STRING

#define FILENAME_STRING   "filename"

Definition at line 49 of file gnc-plugin-file-history.c.

GNC_PLUGIN_FILE_HISTORY_NAME

#define GNC_PLUGIN_FILE_HISTORY_NAME   "gnc-plugin-file-history"

Definition at line 46 of file gnc-plugin-file-history.h.

GNC_PREF_HISTORY_MAXFILES

#define GNC_PREF_HISTORY_MAXFILES   "maxfiles"

Definition at line 52 of file gnc-plugin-file-history.c.

GNC_PREFS_GROUP_HISTORY

#define GNC_PREFS_GROUP_HISTORY   "history"

Definition at line 51 of file gnc-plugin-file-history.c.

GNC_TYPE_PLUGIN_FILE_HISTORY

#define GNC_TYPE_PLUGIN_FILE_HISTORY   (gnc_plugin_file_history_get_type ())

Definition at line 43 of file gnc-plugin-file-history.h.

GNOME1_HISTORY

#define GNOME1_HISTORY   "History"

Definition at line 72 of file gnc-plugin-file-history.c.

GNOME1_MAXFILES

#define GNOME1_MAXFILES   "MaxFiles"

Definition at line 73 of file gnc-plugin-file-history.c.

HISTORY_STRING_FILE_N

#define HISTORY_STRING_FILE_N   "file%d"

Definition at line 53 of file gnc-plugin-file-history.c.

MAX_HISTORY_FILES

#define MAX_HISTORY_FILES   10 /* May be any number up to 10 */

Definition at line 50 of file gnc-plugin-file-history.c.

PLUGIN_ACTIONS_NAME

#define PLUGIN_ACTIONS_NAME   "gnc-plugin-file-history-actions"

The label given to the main window for this plugin.

Definition at line 68 of file gnc-plugin-file-history.c.

PLUGIN_UI_FILENAME

#define PLUGIN_UI_FILENAME   "gnc-plugin-file-history.ui"

The name of the UI description file for this plugin.

Definition at line 70 of file gnc-plugin-file-history.c.

Function Documentation

gnc_history_add_file()

void gnc_history_add_file

(

const char *

filename

)

Add a file name to the front of the file "history list".

If the name already exist on the list, then it is moved from its current location to the front of the list.

Parameters

filename

The name of the file to add to the list.

Definition at line 155 of file gnc-plugin-file-history.c.

{
    gchar *filename, *from, *to;
    gint i, last;
 
    if (newfile == NULL)
        return;
    if (!g_utf8_validate(newfile, -1, NULL))
        return;
 
    /*
     * Look for the filename in preferences.
     */
    last = MAX_HISTORY_FILES - 1;
    for (i = 0; i < MAX_HISTORY_FILES; i++)
    {
        from = gnc_history_index_to_pref_name(i);
        filename = gnc_prefs_get_string(GNC_PREFS_GROUP_HISTORY, from);
        g_free(from);
 
        if (!filename)
        {
            last = i;
            break;
        }
        if (g_utf8_collate(newfile, filename) == 0)
        {
            g_free(filename);
            last = i;
            break;
        }
        g_free(filename);
    }
 
    /*
     * Shuffle filenames upward through preferences.
     */
    to = gnc_history_index_to_pref_name(last);
    for (i = last - 1; i >= 0; i--)
    {
        from = gnc_history_index_to_pref_name(i);
        filename = gnc_prefs_get_string(GNC_PREFS_GROUP_HISTORY, from);
        if (filename && *filename)
        {
            gnc_prefs_set_string(GNC_PREFS_GROUP_HISTORY, to, filename);
        }
        else
        {
            gnc_prefs_reset(GNC_PREFS_GROUP_HISTORY, to);
        }
        g_free(filename);
        g_free(to);
        to = from;
    }
 
    /*
     * Store the new zero entry.
     */
    gnc_prefs_set_string(GNC_PREFS_GROUP_HISTORY, to, newfile);
    g_free(to);
}

gnc_history_get_last()

char * gnc_history_get_last

(

void

)

Retrieve the name of the file most recently accessed.

This is the name at the front of the list.

Returns

This function returns an allocated string containing the name of the most recently accessed file. The caller is responsible for freeing this string.

Definition at line 305 of file gnc-plugin-file-history.c.

{
    char *filename, *pref;
 
    pref = gnc_history_index_to_pref_name(0);
    filename = gnc_prefs_get_string(GNC_PREFS_GROUP_HISTORY, pref);
    g_free(pref);
 
    return filename;
}

gnc_history_remove_file()

void gnc_history_remove_file

(

const char *

oldfile

)

Remove all occurrences of a file name from the history list.

Move the other file names up in the list to fill the gaps.

Parameters

oldfile

The name of the file to remove from the list.

Move the other key values up in the list to fill the gaps.

Parameters

oldfile

The name of the file to remove from the list.

Definition at line 224 of file gnc-plugin-file-history.c.

{
    gchar *filename, *from, *to;
    gint i, j;
 
    if (!oldfile)
        return;
    if (!g_utf8_validate(oldfile, -1, NULL))
        return;
 
    for (i = 0, j = 0; i < MAX_HISTORY_FILES; i++)
    {
        from = gnc_history_index_to_pref_name(i);
        filename = gnc_prefs_get_string(GNC_PREFS_GROUP_HISTORY, from);
 
        if (filename)
        {
            if (g_utf8_collate(oldfile, filename) == 0)
            {
                gnc_prefs_reset(GNC_PREFS_GROUP_HISTORY, from);
            }
            else
            {
                if (i != j)
                {
                    to = gnc_history_index_to_pref_name(j);
                    gnc_prefs_set_string(GNC_PREFS_GROUP_HISTORY, to, filename);
                    gnc_prefs_reset(GNC_PREFS_GROUP_HISTORY, from);
                    g_free(to);
                }
                j++;
            }
            g_free (filename);
        }
        g_free(from);
    }
}

gnc_history_test_for_file()

gboolean gnc_history_test_for_file

(

const char *

oldfile

)

Test for a file name existing in the history list.

Parameters

oldfile	The name of the file to test for in the list.
oldfile	The name of the file to test in the list.

Definition at line 267 of file gnc-plugin-file-history.c.

{
    gchar *filename, *from;
    gint i;
    gboolean found = FALSE;
 
    if (!oldfile)
        return FALSE;
    if (!g_utf8_validate(oldfile, -1, NULL))
        return FALSE;
 
    for (i = 0; i < MAX_HISTORY_FILES; i++)
    {
        from = gnc_history_index_to_pref_name(i);
        filename = gnc_prefs_get_string(GNC_PREFS_GROUP_HISTORY, from);
        g_free(from);
 
        if (!filename)
            continue;
 
        if (g_utf8_collate(oldfile, filename) == 0)
        {
            found = TRUE;
            g_free (filename);
            break;
        }
        g_free (filename);
    }
 
    return found;
}

gnc_plugin_file_history_new()

GncPlugin * gnc_plugin_file_history_new

(

void

)

Create a new file history plugin.

This plugin attaches the file history menu to any window that is opened.

Returns

A pointer to the new object.

Definition at line 589 of file gnc-plugin-file-history.c.

{
    GncPlugin *plugin_page = NULL;
 
    ENTER("");
    plugin_page = GNC_PLUGIN (g_object_new (GNC_TYPE_PLUGIN_FILE_HISTORY, NULL));
    LEAVE("plugin %p", plugin_page);
    return plugin_page;
}