contentLister/inc/gtkMetadataWnd.h File Reference

gtkMetadataWnd - eReader content metadata editor More...

#include <gtk/gtk.h>

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	cmMetadata_t
Defines
#define	METADATA_BK_IMG_WIDTH   666
#define	METADATA_BK_IMG_HEIGHT   345
#define	METADATA_WND_SPACE_ABOVE   50
#define	METADATA_WND_ITEM_SPACING   8
#define	METADATA_VBORDER   10
#define	METADATA_HBORDER   20
#define	METADATA_ENTRY_WIDTH   (METADATA_BK_IMG_WIDTH - 2*METADATA_HBORDER)
#define	METADATA_TAG_HEIGHT   40
#define	METADATA_NAME_HEIGHT   30
#define	METADATA_DESC_HEIGHT   30
#define	MD_MAX_TITLE_SIZE   256
#define	MD_MAX_SUBTITLE_SIZE   256
#define	MD_MAX_DESCRIPTION_SIZE   512
Functions
GtkWidget *	create_content_metadata_wnd (GtkWidget *parent)
void	content_metadata_set_text (void)
gboolean	content_metadata_read_manifest (const gchar *szManifest)
gboolean	content_metadata_rename_container (const gchar *szManifest, gchar *szContainer, gint len)
gboolean	content_metadata_write_manifest (const gchar *szContainer)

---

Detailed Description

gtkMetadataWnd - eReader content metadata editor

<File description>=""> The eReader content customization window provides gtk widget to enable user customize content title and description. Which are created and updated with the following API

Definition in file gtkMetadataWnd.h.

---

Define Documentation

#define MD_MAX_DESCRIPTION_SIZE   512

Definition at line 57 of file gtkMetadataWnd.h.

#define MD_MAX_SUBTITLE_SIZE   256

Definition at line 56 of file gtkMetadataWnd.h.

#define MD_MAX_TITLE_SIZE   256

Definition at line 55 of file gtkMetadataWnd.h.

#define METADATA_BK_IMG_HEIGHT   345

Definition at line 41 of file gtkMetadataWnd.h.

#define METADATA_BK_IMG_WIDTH   666

Definition at line 40 of file gtkMetadataWnd.h.

#define METADATA_DESC_HEIGHT   30

Definition at line 52 of file gtkMetadataWnd.h.

#define METADATA_ENTRY_WIDTH   (METADATA_BK_IMG_WIDTH - 2*METADATA_HBORDER)

Definition at line 48 of file gtkMetadataWnd.h.

#define METADATA_HBORDER   20

Definition at line 47 of file gtkMetadataWnd.h.

#define METADATA_NAME_HEIGHT   30

Definition at line 51 of file gtkMetadataWnd.h.

#define METADATA_TAG_HEIGHT   40

Definition at line 50 of file gtkMetadataWnd.h.

#define METADATA_VBORDER   10

Definition at line 46 of file gtkMetadataWnd.h.

#define METADATA_WND_ITEM_SPACING   8

Definition at line 44 of file gtkMetadataWnd.h.

#define METADATA_WND_SPACE_ABOVE   50

Definition at line 43 of file gtkMetadataWnd.h.

---

Function Documentation

gboolean content_metadata_read_manifest

(

const gchar *

szManifest

)

read manifest file into content data

Parameters:

pathname

of the manifest file

Definition at line 410 of file gtkMetadataWnd.c.

{
    CL_LOGPRINTF("entry");

    g_assert(szManifest != NULL);

    int   ret;
    gchar szTitle[MD_MAX_TITLE_SIZE];
    gchar szDescription[MD_MAX_DESCRIPTION_SIZE];
       
    // open manifest file
    erManifest manifest;
    if (RET_OK != ermXmlOpenFile(szManifest, &manifest))
    {
        CL_ERRORPRINTF("Could not open manifest file [%s]", szManifest);
        return FALSE;
    }
    
    // get title
    ret = ermXmlGetString(&manifest, "/package/metadata/dc-metadata/Title", szTitle, sizeof(szTitle));
    if (ret != RET_OK)
    {
        strcpy(szTitle, "");
    }
    gtk_entry_set_text(GTK_ENTRY(g_wnd.nameEntry), szTitle);
    
    // get description
    ret = ermXmlGetString(&manifest, "/package/metadata/dc-metadata/Description", szDescription, sizeof(szDescription));
    if (ret != RET_OK)
    {
        strcpy(szDescription, "");
    }
    /****
     * Problems with multi-line text editor, see createDescEntry();
     *
    GtkTextBuffer* buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(g_wnd.descEntry));
    gtk_text_buffer_set_text(buffer, szDescription, -1);
    ****/
    char* cp = strchr(szDescription, '\n');
    if (cp)
    {
        *cp = '\0';
        gtk_entry_set_text(GTK_ENTRY(g_wnd.descEntry2), cp + 1);
    }
    else
    {
        gtk_entry_set_text(GTK_ENTRY(g_wnd.descEntry2), "");
    }
    gtk_entry_set_text(GTK_ENTRY(g_wnd.descEntry), szDescription);
        
    // close manifest file
    ermXmlClose(&manifest);
    return TRUE;
}

Here is the call graph for this function:

gboolean content_metadata_rename_container	(	const gchar *	szManifest,
		gchar *	szContainer,
		gint	len
	)

rename container when needed, depending on current title

Parameters:

	in	szManifest pathname of manifest file
	out	szContainer pathname of container directory
	in	len size in bytes of szContainer buffer

Definition at line 466 of file gtkMetadataWnd.c.

{
    CL_LOGPRINTF("entry: manifest [%s]", szManifest);

    g_return_val_if_fail((szManifest != NULL), FALSE);
    
    gboolean retval = FALSE;

       
    // retrieve container path
    char* cp = strrchr(szManifest, '/');
    if (cp)
    {
        *cp = '\0';
        snprintf(szContainer, len, "%s", szManifest);
        *cp = '/';
    }
    else
    {
        CL_ERRORPRINTF("Illegal manifest path [%s]", szManifest);
    }

    // retrieve container name
    char* szContainerName = strrchr(szContainer, '/');
    if (szContainerName)
    {
        szContainerName++;
    }
    else
    {
        CL_ERRORPRINTF("Illegal container path [%s]", szContainer);
    }

    // retrieve title from screen object
    const char* szTitle = gtk_entry_get_text(GTK_ENTRY(g_wnd.nameEntry));

    // set container name to (modified) title
    if (   strlen(szTitle) > 0
        && strcmp(szTitle, szContainerName) != 0 )
    {
        // container name is different from title: rename container

        // determine new container name
        int  n = strlen(szContainer) - strlen(szContainerName);
        char* newContainer = alloca(n + strlen(szTitle) + 1);
        g_return_val_if_fail((newContainer != NULL), FALSE);
        strncpy(newContainer, szContainer, n);
        strcpy(&newContainer[n], szTitle);
        CL_LOGPRINTF("New container name [%s]", newContainer);        
        
        // rename container, but only when newName does not exist
        struct stat statbuf;
        if (   stat(newContainer, &statbuf) == -1
            && rename(szContainer, newContainer) ==  0 )
        {
            CL_LOGPRINTF("Renamed container ok");
            snprintf(szContainer, len, "%s", newContainer);
            retval = TRUE;
        }
        else
        {
            CL_ERRORPRINTF("Cannot rename container [%s]", strerror(errno));
            
            // rename failed: force title to container name
            gtk_entry_set_text(GTK_ENTRY(g_wnd.nameEntry), szContainerName);
        }
    }
    
    return retval;
}

void content_metadata_set_text

(

void

)

Set constant texts for metedata editor window

Definition at line 394 of file gtkMetadataWnd.c.

{
    CL_LOGPRINTF("entry");

    // name item
    gtk_label_set_text( GTK_LABEL(g_wnd.nameTag), _("Step 1: Please enter a name for the content") );
            
    // desc item
    gtk_label_set_text( GTK_LABEL(g_wnd.descTag), _("Step 2: Enter a description by which you can identify the content") );

    // finish item
    gtk_label_set_text( GTK_LABEL(g_wnd.finishTag), _("Step 3: Click on the 'Tagging' icon to save your changes") );
}

gboolean content_metadata_write_manifest

(

const gchar *

szContainer

)

update the content metadata according to input parameter

Parameters:

pathname

of container directory

Definition at line 538 of file gtkMetadataWnd.c.

{
    CL_LOGPRINTF("entry: manifest [%s]", szContainer);

    g_return_val_if_fail((szContainer != NULL), FALSE);

    gboolean retval = FALSE;
    
       
    // retrieve title from screen object
    const char* szTitle = gtk_entry_get_text(GTK_ENTRY(g_wnd.nameEntry));

    // retrieve description from screen object
    /****
     * Problems with multi-line text editor, see createDescEntry();
     *
    GtkTextBuffer * buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(g_wnd.descEntry));
    GtkTextIter start, end;
    gtk_text_buffer_get_bounds(buffer, &start, &end);
    char* szDescription = gtk_text_buffer_get_text(buffer, &start, &end, FALSE);      
    ****/
    const char* szDescription = gtk_entry_get_text(GTK_ENTRY(g_wnd.descEntry));
    const char* szDescription2 = gtk_entry_get_text(GTK_ENTRY(g_wnd.descEntry2));
    if (szDescription2 != NULL  &&  szDescription2[0] != '\0')
    {
        char* cp = alloca( strlen(szDescription) + strlen(szDescription2) + 2 );
        if (cp)
        {
            sprintf(cp, "%s\n%s", szDescription, szDescription2);
            szDescription = cp;
        }
    }
    
    // open manifest file and update it
    erManifest manifest;
    if (RET_OK == ermXmlOpenManifest(szContainer, &manifest))
    {
        // update title
        if (RET_OK == ermXmlExist(&manifest, "/package/metadata/dc-metadata/Title"))
        {
            ermXmlSetString( &manifest,
                             "/package/metadata/dc-metadata/Title",
                             szTitle );
        }
        else
        {
            ermXmlNewString( &manifest,
                             "/package/metadata/dc-metadata",
                             "Title",
                             szTitle );
        }
        
        // update description
        if (RET_OK == ermXmlExist(&manifest, "/package/metadata/dc-metadata/Description"))
        {
            ermXmlSetString( &manifest,
                             "/package/metadata/dc-metadata/Description",
                             szDescription );
        }
        else
        {
            ermXmlNewString( &manifest,
                             "/package/metadata/dc-metadata",
                             "Description",
                             szDescription );
        }
        
        // save manifest
        ermXmlSaveAndClose(&manifest);

        retval = TRUE;
    }
    else
    {
        CL_ERRORPRINTF("Could not open manifest file in [%s]", szContainer);
    }
    
    return retval;
}

Here is the call graph for this function:

GtkWidget* create_content_metadata_wnd

(

GtkWidget *

parent

)

Create content metadata editor window

Parameters:

data

-

Returns:

instance pointer of window. Return NULL if failed.

Definition at line 344 of file gtkMetadataWnd.c.

{
    CL_LOGPRINTF("entry");

    // main window
    g_wnd.window = parent;
    // g_signal_connect(G_OBJECT(g_wnd.window), "focus-in-event", G_CALLBACK(on_main_wnd_focus_in), wnd);
    // g_signal_connect(G_OBJECT(g_wnd.window), "key_press_event", G_CALLBACK(on_keypress), wnd);
    g_signal_connect(G_OBJECT(g_wnd.window), "expose-event", G_CALLBACK(on_expose), NULL);

    // background
    GtkWidget* background = gtk_event_box_new();
    gtk_widget_set_name(GTK_WIDGET(background), "content_wnd_background");   
    gtk_widget_set_size_request(GTK_WIDGET(background), METADATA_BK_IMG_WIDTH, METADATA_BK_IMG_HEIGHT);
    gtk_container_add(GTK_CONTAINER(parent), background);
    gtk_widget_show(background);
        
    // alignment
    GtkWidget* alignment = gtk_alignment_new(0.0, 0.0, 0.0, 0.0);
    gtk_alignment_set_padding(GTK_ALIGNMENT(alignment), METADATA_VBORDER, METADATA_VBORDER, METADATA_HBORDER, METADATA_HBORDER);
    gtk_container_add(GTK_CONTAINER(background), alignment);
    gtk_widget_show(alignment);

    // vbox
    GtkWidget* vbox = gtk_vbox_new(FALSE, METADATA_WND_ITEM_SPACING);
    gtk_container_add(GTK_CONTAINER(alignment), vbox);
    gtk_widget_show(vbox);
   
    // name item
    createNameItem(vbox);
            
    // desc item
    createDescItem(vbox);

    // finish item
    createFinishItem(vbox);

    // set screen texts
    content_metadata_set_text();

    // instance-private data
    g_wnd.on_change_occurred     = FALSE;
    g_wnd.on_movecursor_occurred = FALSE;
    g_wnd.display_update_pending = FALSE;

    return background;
}

Here is the call graph for this function: