scbpath.h

Go to the documentation of this file.

#ifndef SCBPATH_H_
#define SCBPATH_H_

/*
 * File Name  : scbpath.h
 * 
 * Description: Scribble library path definition
 */

/*
 * This file is part of liberscribble.
 *
 * liberscribble is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * liberscribble is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */
 

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <glib.h>

// ereader include files, between < >

// local include files, between " "
#include "scbconfig.h"

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

typedef struct _ScbPath
{
    char document_path[ERSCRIBBLE_MAX_PATH];     /**< path of the target document, such as a PDF document */
} ScbPath;

typedef ScbPath* ScbPathPtr;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

// Initialize a path instance
// @param ptr the pointer of path instance
void erscribble_path_init(ScbPathPtr ptr);

// Estimate whether the file by which path indicates exists
// @param pathName the path of the document
// @return return TRUE if file exist, otherwise return FALSE
gboolean erscribble_path_file_exist(const char *pathName);


G_END_DECLS

#endif