liberipc/include/eripcarinc.h File Reference

#include "eripcclient.h"

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

Go to the source code of this file.

Enumerations
enum	eCcArinc {   ccArincJumpToPage = 0, ccArincBookmarkPage, ccArincInvokeFindDialog, ccArincZoomIn,   ccArincZoomOut, ccArincStore, ccArincSignal, ccArincUndefined }
Functions
int	arincParseCommand (char *szCommand, erIpcCmd_t *pCmd)
int	arincSignal (erClientChannel_t channel, int uaID, int signal)
int	arincJumpToPage (erClientChannel_t channel, int uaID, int page)
int	arincBookmarkPage (erClientChannel_t channel, int uaID)
int	arincInvokeFindDialog (erClientChannel_t channel, int uaID)
int	arincZoomIn (erClientChannel_t channel, int uaID)
int	arincZoomOut (erClientChannel_t channel, int uaID)
int	arincStore (erClientChannel_t channel, int uaID, int category, char *itemID)

---

Enumeration Type Documentation

enum eCcArinc

Enumerator:

ccArincJumpToPage
ccArincBookmarkPage
ccArincInvokeFindDialog
ccArincZoomIn
ccArincZoomOut
ccArincStore
ccArincSignal
ccArincUndefined

Definition at line 41 of file eripcarinc.h.

             {
    ccArincJumpToPage = 0,
    ccArincBookmarkPage,
    ccArincInvokeFindDialog,
    ccArincZoomIn,
    ccArincZoomOut,
    ccArincStore,        
    ccArincSignal,
    ccArincUndefined
} eCcArinc;

---

Function Documentation

int arincBookmarkPage	(	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 65 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int arincInvokeFindDialog	(	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 77 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int arincJumpToPage	(	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

Definition at line 52 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "arincJumpToPage");
    cmd.cc = (int) ccArincJumpToPage;
    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 arincParseCommand	(	char *	szCommand,
		erIpcCmd_t *	pCmd
	)

Definition at line 116 of file eripcarinc.c.

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

    pCmd->cc = (int) ccArincUndefined;
    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, "arincJumpToPage") == 0  ||  cmdcode == ccArincJumpToPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincJumpToPage;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "arincBookmarkPage") == 0  ||  cmdcode == ccArincBookmarkPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincBookmarkPage;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "arincInvokeFindDialog") == 0  ||  cmdcode == ccArincInvokeFindDialog)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincInvokeFindDialog;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "arincZoomIn") == 0  ||  cmdcode == ccArincZoomIn)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincZoomIn;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "arincZoomOut") == 0  ||  cmdcode == ccArincZoomOut)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincZoomOut;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "arincStore") == 0  ||  cmdcode == ccArincStore)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincStore;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "arincSignal") == 0  ||  cmdcode == ccArincSignal)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccArincSignal;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else
    {
        strcpy(pCmd->name, "Undefined");
        pCmd->cc = (int) ccArincUndefined;
        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 arincSignal	(	erClientChannel_t	channel,
		int	uaID,
		int	signal
	)

Sends a signal to a viewer

Parameters:

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

Returns:

A value of 0 signals success

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

Definition at line 40 of file eripcarinc.c.

                                                                 {
    erIpcCmd_t cmd;

    strcpy(cmd.name, "arincSignal");
    cmd.cc = (int) ccArincSignal;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", signal);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int arincStore	(	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 224 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "arincStore");
    cmd.cc = (int) ccArincStore;
    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 arincZoomIn	(	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 89 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int arincZoomOut	(	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 101 of file eripcarinc.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function: