liberipc/include/eripcviewer.h File Reference

liberipc - specifics to IPC with 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	eCcVwr {   ccVwrJumpToPage = 0, ccVwrBookmarkPage, ccVwrInvokeFindDialog, ccVwrZoomIn,   ccVwrZoomOut, ccVwrStore, ccVwrToolbar, ccVwrToolbarSync,   ccVwrPagebarSync, ccVwrUndefined }
Functions
int	vwrParseCommand (char *szCommand, erIpcCmd_t *pCmd)
int	vwrJumpToPage (erClientChannel_t channel, int uaID, int page)
int	vwrBookmarkPage (erClientChannel_t channel, int uaID)
int	vwrInvokeFindDialog (erClientChannel_t channel, int uaID)
int	vwrZoomIn (erClientChannel_t channel, int uaID)
int	vwrZoomOut (erClientChannel_t channel, int uaID)
int	vwrStore (erClientChannel_t channel, int uaID, int category, char *itemID)

---

Detailed Description

liberipc - specifics to IPC with viewer

<File description>="">

Definition in file eripcviewer.h.

---

Enumeration Type Documentation

enum eCcVwr

Enumerator:

ccVwrJumpToPage
ccVwrBookmarkPage
ccVwrInvokeFindDialog
ccVwrZoomIn
ccVwrZoomOut
ccVwrStore
ccVwrToolbar
ccVwrToolbarSync
ccVwrPagebarSync
ccVwrUndefined

Definition at line 41 of file eripcviewer.h.

             {
    ccVwrJumpToPage = 0,
    ccVwrBookmarkPage,
    ccVwrInvokeFindDialog,
    ccVwrZoomIn,
    ccVwrZoomOut,
    ccVwrStore,         
    ccVwrToolbar,  // previously ccVwrSignal,
    ccVwrToolbarSync, 
    ccVwrPagebarSync,
    ccVwrUndefined
} eCcVwr;

---

Function Documentation

int vwrBookmarkPage	(	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 67 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int vwrInvokeFindDialog	(	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 79 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

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

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 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. Outdated ** int vwrSignal(erClientChannel_t channel, int uaID, int signal) { erIpcCmd_t cmd;

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

return erIpcSndCommand(channel, &cmd); } Outdated

Definition at line 54 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

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

Outdated: replaced by vwrToolbar ** else if (strcmp(szToken, "vwrSignal") == 0 || cmdcode == ccVwrSignal) { strcpy(pCmd->name, szToken); pCmd->cc = (int) ccVwrSignal; nReqArgs = 2; pCmd->nArg = 2; } Outdated

Definition at line 118 of file eripcviewer.c.

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

    pCmd->cc = (int) ccVwrUndefined;
    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, "vwrJumpToPage") == 0  ||  cmdcode == ccVwrJumpToPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrJumpToPage;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "vwrBookmarkPage") == 0  ||  cmdcode == ccVwrBookmarkPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrBookmarkPage;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "vwrInvokeFindDialog") == 0  ||  cmdcode == ccVwrInvokeFindDialog)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrInvokeFindDialog;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "vwrZoomIn") == 0  ||  cmdcode == ccVwrZoomIn)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrZoomIn;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "vwrZoomOut") == 0  ||  cmdcode == ccVwrZoomOut)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrZoomOut;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "vwrStore") == 0  ||  cmdcode == ccVwrStore)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrStore;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "vwrToolbar") == 0  ||  cmdcode == ccVwrToolbar)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrToolbar;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "vwrToolbarSync") == 0  ||  cmdcode == ccVwrToolbarSync)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrToolbarSync;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }
    else if (strcmp(szToken, "vwrPagebarSync") == 0 || cmdcode == ccVwrPagebarSync)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccVwrPagebarSync;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }
    else
    {
        strcpy(pCmd->name, "Undefined");
        pCmd->cc = (int) ccVwrUndefined;
        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 vwrStore	(	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 248 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "vwrStore");
    cmd.cc = (int) ccVwrStore;
    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 vwrZoomIn	(	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 91 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int vwrZoomOut	(	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 103 of file eripcviewer.c.

{
    erIpcCmd_t cmd;

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

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function: