Main Page | Class List | Directories | File List | Class Members | File Members

gocr_block.h File Reference

This is the block header. More...

Go to the source code of this file.

Classes

struct  gocr_block
 This is the block parent structure. More...
struct  gocr_line
struct  gocr_textblock
struct  gocr_pictureblock
struct  gocr_mathblock

Block

typedef int gocr_blockId
typedef gocr_block gocr_Block
 Typedef encapsulation.
typedef gocr_line gocr_Line
typedef gocr_textblock gocr_TextBlock
typedef gocr_pictureblock gocr_PictureBlock
typedef gocr_mathblock gocr_MathBlock
gocr_blockType gocr_blockTypeRegister (char *name)
 registers a new blockType.
gocr_blockType gocr_blockTypeGetByName (char *name)
 returns the blockType given its name string.
const char * gocr_blockTypeGetNameByType (gocr_blockType t)
 returns the name of the block type given its id.
int gocr_blockAdd (gocr_Block *b)
 adds a block to the block list.
*typedef int gocr_blockType
List blocklist


Detailed Description

This is the block header.

Author:
Bruno Barberi Gnecco <brunobg@sourceforge.net>

Function Documentation

gocr_blockType gocr_blockTypeRegister char *  name  ) 
 

registers a new blockType.

Long description.

Parameters:
name The new block type name.
Returns:
The blockType id (which is an integer >= 1), or -1 if error.

gocr_blockType gocr_blockTypeGetByName char *  name  ) 
 

returns the blockType given its name string.

Long description.

Parameters:
name The block type name.
Returns:
The blockType id (which is an integer >= 1), or -1 if not found.

const char* gocr_blockTypeGetNameByType gocr_blockType  t  ) 
 

returns the name of the block type given its id.

Long description.

Parameters:
t The block type id.
Returns:
The name of the block type or NULL if not found.

int gocr_blockAdd gocr_Block b  ) 
 

adds a block to the block list.

This function adds a block that you created to the list of blocks. You are responsible for filling the x0, x1, y0, y1 and t fields of the block structure, and those. You can pass the address of a derived block type to it.

You can't free the block.

Parameters:
b A pointer to the block to be added.
Returns:
A number less than zero if error, or the block id.


Generated on Sun Jul 31 13:19:14 2005 for GOCR API by  doxygen 1.4.3-20050530