scbconfig.h

Go to the documentation of this file.

#ifndef SCBCONFIG_H_
#define SCBCONFIG_H_

/*
 * File Name  : scbconfig.h
 *
 * Description: Scribble library constant and default configuration
 */

/*
 * 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 <stdio.h>

#ifdef WIN32
#include <windows.h>
#define snprintf _snprintf
#endif

// ereader include files, between < >

// local include files, between " "

#ifdef __cplusplus
extern "C"
{
#endif


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

#define ERSCRIBBLE_LIB_VERSION_MAJOR       1
#define ERSCRIBBLE_LIB_VERSION_MINOR       1
#define ERSCRIBBLE_LIB_ORG                 "iRex Technologies"

#define ERSCRIBBLE_DEF_SCREEN_UNITS        "px"
#define ERSCRIBBLE_DEF_SCREEN_DPI          160

// return values used by scribble functions
#define ERSCRIBBLE_RET_OK                  1
#define ERSCRIBBLE_RET_ERR                 0
#define ERSCRIBBLE_INVALID_COUNT           -1

// default zoom factor
#define ERSCRIBBLE_DEF_ZOOM_FACTOR         1.0f

// scribble shape id
#define ERSCRIBBLE_DEF_SHAPE_LINE          0

// default value for stroke size
#define ERSCRIBBLE_DEF_STROKE_POINTSIZE    40
#define ERSCRIBBLE_DEF_STROKE_LAYER        0
#define ERSCRIBBLE_DEF_STROKE_LINESTYLE    ERSCRIBBLE_LINE_SOLID
#define ERSCRIBBLE_DEF_STROKE_PENSIZE      3

// default value for configuration
#define ERSCRIBBLE_DEF_DRIVER_DRAW_COUNT     10
#define ERSCRIBBLE_DEF_DRIVER_DRAW_TIME      100 * 100   // micro second
#define ERSCRIBBLE_DEF_DRIVER_DRAW_BUF_LEN   25          // must be 25!

// default value for page & page id
#define ERSCRIBBLE_MAX_PAGEID_LEN          256
#define ERSCRIBBLE_DEF_PAGE_LEFT           0
#define ERSCRIBBLE_DEF_PAGE_TOP            0
#define ERSCRIBBLE_DEF_PAGE_RIGHT          1024
#define ERSCRIBBLE_DEF_PAGE_BOTTOM         1280

// default value for path
#define ERSCRIBBLE_MAX_PATH                1024

// default vlaue for color
#define ERSCRIBBLE_MAX_COLOR_LEN           8

// default value for erase
#define ERSCRIBBLE_DEF_ERASE_SIZE          5

#define ERSCRIBBLE_DEF_CMD_ACT_SIZE        10

// invalid shape id
#define ERSCRIBBLE_INVALID_SHAPE           -1

// invalid size id
#define ERSCRIBBLE_INVALID_SIZE            -1

// application data items
#define ERSCRIBBLE_VERSION_MAJOR           "scribble_version_major"
#define ERSCRIBBLE_VERSION_MINOR           "scribble_version_minor"
#define ERSCRIBBLE_VERSION_COMPANY         "scribble_version_company"
#define ERSCRIBBLE_SCREEN_DPI              "scribble_screen_dpi"
#define ERSCRIBBLE_SCREEN_UNITS            "scribble_screen_units"

#define ERSCRIBBLE_ANNOTATION_TYPE         "scribble"


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


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

typedef struct _ScbDriverDrawParam
{
    int     count;    // max points before draw
    int     time;     // max time before draw
} ScbDriverDrawParam;

typedef ScbDriverDrawParam * ScbDriverDrawParamPtr;


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


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

// Initialize the drawing paramters for driver
void erscribble_cfg_init_driver_draw_param();

// Set drawing parameters for driver
// @param ptr the pointer of updated drawing parameters
void erscribble_cfg_set_driver_draw_param(ScbDriverDrawParamPtr ptr);

// Get current drawing parameters of driver
// @param ptr the current drawing parameters
void erscribble_cfg_get_driver_draw_param(ScbDriverDrawParamPtr ptr);


#ifdef __cplusplus
}
#endif

#endif