Main Page   Compound List   File List   Compound Members   File Members  

gocr_char.h File Reference

This is the character header. More...

#include "hash.h"

Go to the source code of this file.

Compounds

struct  gocrchar
struct  gocrbox

Character

typedef struct gocrchar gocrChar
 Typedef encapsulation.

typedef struct gocrbox gocrBox
 Typedef encapsulation.

typedef enum gocrcharattributetype gocrCharAttributeType
 Typedef encapsulation.

enum  gocrcharattributetype {
  SETTABLE,
  UNTIL_OVERRIDEN
}

charFinder functions

int gocr_charBegin ( void )
 inits a new character structure. More...

int gocr_charEnd ( void )
 closes a new character structure. More...

int gocr_charSetAllNearPixels ( int action, int x, int y )
 set/unset all pixels near this one as part of the character. More...

int gocr_charSetAttribute ( int action, char *name, ... )
 set/unset a character attribute. More...

int gocr_charSetPixel ( int action, int x, int y )
 set/unset a pixel. More...

int gocr_charSetRect ( int action, int x0, int y0, int x1, int y1 )
 set/unset all pixels in a rectangle. More...


charRecog functions

int gocr_charAttributeRegister ( char *name, gocrCharAttributeType t, char *format )
int gocr_charAttributeInsert ( char *name, ... )


Detailed Description

This is the character header.


Function Documentation

int gocr_charBegin ( void )
 

inits a new character structure.

Long description.

See also:
gocr_charEnd(), gocr_charSetAttribute(), gocr_charSetPixel(), gocr_charSetRect().
Returns:
0 if OK, or -1 if error.

int gocr_charEnd ( void )
 

closes a new character structure.

Long description; adds to the character list.

See also:
gocr_charBegin().
Returns:
0 if OK, or -1 if error.

int gocr_charSetAllNearPixels ( int action,
int x,
int y )
 

set/unset all pixels near this one as part of the character.

Long description.

Parameters:
action   If 0, unsets; if 1, sets.
x   The x coordinate of the pixel.
y   The y coordinate of the pixel.
See also:
gocr_charBegin(), gocr_charEnd(), gocr_charSetAttribute(), gocr_charSetPixel(), gocr_charSetRect().
Returns:
0 if OK, or -1 if error.

int gocr_charSetAttribute ( int action,
char * name,
... )
 

set/unset a character attribute.

Long description. attribute must be registered. Function prototype not stable yet.

Parameters:
action   If 0, unsets; if 1, sets.
name   Attribute name.
...   Data.
See also:
gocr_charBegin(), gocr_charEnd(), gocr_charSetAttribute(), gocr_charSetPixel(), gocr_charSetRect().
Returns:
0 if OK, or -1 if error.

int gocr_charSetPixel ( int action,
int x,
int y )
 

set/unset a pixel.

Long description.

Parameters:
action   If 0, unsets; if 1, sets.
x   The x coordinate of the pixel.
y   The y coordinate of the pixel.
See also:
gocr_charBegin(), gocr_charEnd(), gocr_charSetAttribute(), gocr_charSetPixel(), gocr_charSetRect().
Returns:
0 if OK, or -1 if error.

int gocr_charSetRect ( int action,
int x0,
int y0,
int x1,
int y1 )
 

set/unset all pixels in a rectangle.

Long description.

Parameters:
action   If 0, unsets; if 1, sets.
x0,y0   A vertex (x0, y0) of the rectangle.
x1,y1   The opposite vertex (x1, y1).
See also:
gocr_charBegin(), gocr_charEnd(), gocr_charSetAttribute(), gocr_charSetPixel(), gocr_charSetRect().
Returns:
0 if OK, or -1 if error.


Generated at Thu Mar 1 10:05:33 2001 for GOCR API by doxygen1.2.2 written by Dimitri van Heesch, © 1997-2000