liberipc/include/eripceba.h File Reference

liberipc - specifics to IPC with EBA viewer More...

#include "eripcclient.h"

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

Go to the source code of this file.

Enumerations
enum	eCcEba {   ccEbaJumpToPage = 0, ccEbaBookmarkPage, ccEbaInvokeFindDialog, ccEbaZoomIn,   ccEbaZoomOut, ccEbaStore, ccEbaToolbar, ccEbaUndefined }
Functions
int	ebaParseCommand (char *szCommand, erIpcCmd_t *pCmd)
int	ebaJumpToPage (erClientChannel_t channel, int uaID, int page)
int	ebaBookmarkPage (erClientChannel_t channel, int uaID)
int	ebaInvokeFindDialog (erClientChannel_t channel, int uaID)
int	ebaZoomIn (erClientChannel_t channel, int uaID)
int	ebaZoomOut (erClientChannel_t channel, int uaID)
int	ebaStore (erClientChannel_t channel, int uaID, int category, char *itemID)

---

Detailed Description

liberipc - specifics to IPC with EBA viewer

Definition in file eripceba.h.

---

Enumeration Type Documentation

enum eCcEba

Enumerator:

ccEbaJumpToPage
ccEbaBookmarkPage
ccEbaInvokeFindDialog
ccEbaZoomIn
ccEbaZoomOut
ccEbaStore
ccEbaToolbar
ccEbaUndefined

Definition at line 41 of file eripceba.h.

             {
    ccEbaJumpToPage = 0,
    ccEbaBookmarkPage,
    ccEbaInvokeFindDialog,
    ccEbaZoomIn,
    ccEbaZoomOut,
    ccEbaStore,         
    ccEbaToolbar,
    ccEbaUndefined
} eCcEba;

---

Function Documentation

int ebaBookmarkPage	(	erClientChannel_t	channel,
		int	uaID
	)

Bookmark the currently displayed page in the viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 53 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaBookmarkPage");
    cmd.cc = (int) ccEbaBookmarkPage;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int ebaInvokeFindDialog	(	erClientChannel_t	channel,
		int	uaID
	)

Invoke the find dialog on viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 65 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaInvokeFindDialog");
    cmd.cc = (int) ccEbaInvokeFindDialog;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int ebaJumpToPage	(	erClientChannel_t	channel,
		int	uaID,
		int	page
	)

Jump to page 'page' of the current document displayed in the viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	page	page number

Returns:

A value of 0 signals success

Copyright (C) 2005-2008 iRex Technologies B.V. All rights reserved.

Definition at line 40 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaJumpToPage");
    cmd.cc = (int) ccEbaJumpToPage;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", page);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int ebaParseCommand	(	char *	szCommand,
		erIpcCmd_t *	pCmd
	)

Definition at line 104 of file eripceba.c.

{
    int     i;
    char   *pChar;
    int     cmdcode;
    char    szToken[TB_MAXCHARONLINE];
    int     nReqArgs = 0;

    pCmd->cc = (int) ccEbaUndefined;
    for (i = 0; i < TB_N_ARG; i++)
    {
        strcpy(pCmd->arg[i], "");
    }

    // Parse Command
    pChar = szCommand;
    i = 0;
    while (*pChar != '\0')
    {
        szToken[i] = '\0';
        if (*pChar == ',')
        {
            pChar++;
            break;
        }
        szToken[i] = *pChar++;
        i++;
        szToken[i] = '\0';
    }

    // We have found the command Token. Figure out what the command is.
    // TODO: stop doing this hardcoded, rely on a smart datastructure instead.

    if (isdigit(szToken[0]))
    {
        cmdcode = atoi(szToken);
    }
    else
    {
        cmdcode = -1;
    }
    if (strcmp(szToken, "ebaJumpToPage") == 0  ||  cmdcode == ccEbaJumpToPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaJumpToPage;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "ebaBookmarkPage") == 0  ||  cmdcode == ccEbaBookmarkPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaBookmarkPage;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ebaInvokeFindDialog") == 0  ||  cmdcode == ccEbaInvokeFindDialog)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaInvokeFindDialog;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ebaZoomIn") == 0  ||  cmdcode == ccEbaZoomIn)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaZoomIn;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ebaZoomOut") == 0  ||  cmdcode == ccEbaZoomOut)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaZoomOut;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ebaStore") == 0  ||  cmdcode == ccEbaStore)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaStore;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "ebaToolbar") == 0  ||  cmdcode == ccEbaToolbar)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccEbaToolbar;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else
    {
        strcpy(pCmd->name, "Undefined");
        pCmd->cc = (int) ccEbaUndefined;
        fprintf(stderr, "%s: Command %s \n", __FUNCTION__, szToken);
        fprintf(stderr, "Error parsing (%s). Command undefined\n", szCommand);
        pCmd->nArg = -1;
        return -1;
    }

    if (nReqArgs > 0)
    {
        erIpcGetArgs(pChar, pCmd, nReqArgs);
    }
    return 0;
}

Here is the call graph for this function:

int ebaStore	(	erClientChannel_t	channel,
		int	uaID,
		int	category,
		char *	itemID
	)

Store the currently displayed page of viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	category	identifier
	itemID	- null terminated string - unique item ID of the currently displayed content

Returns:

A value of 0 signals success

Definition at line 211 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaStore");
    cmd.cc = (int) ccEbaStore;
    cmd.nArg = 3;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", category);
        
        if ((itemID) && (strlen(itemID) < TB_ARGLENGTH))
        {
                strncpy(cmd.arg[2], itemID, TB_ARGLENGTH);
        }
        else
        {
            sprintf(cmd.arg[2],"%s", "");
            fprintf(stderr, "Command %s \n", cmd.name);
                fprintf(stderr, "invalid itemID (%s)\n", itemID);
        }

    return erIpcSndCommand(channel, &cmd);      
}

Here is the call graph for this function:

int ebaZoomIn	(	erClientChannel_t	channel,
		int	uaID
	)

Zoom in on the currently displayed page of viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 77 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaZoomIn");
    cmd.cc = (int) ccEbaZoomIn;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int ebaZoomOut	(	erClientChannel_t	channel,
		int	uaID
	)

Zoom out on the currently displayed page of viewer 'uaID'

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 89 of file eripceba.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ebaZoomOut");
    cmd.cc = (int) ccEbaZoomOut;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function: