Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

pages.h File Reference

#include "sequence.h"
#include "object.h"
#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef rnamlPAGES rnamlPages
 Rnaml structure containing the pages informations.


Functions

rnamlPagesrnamlnewPages ()
 Creates a new rnamlPages structure.

rnamlPagesrnamlclonePages (const rnamlPages *pages)
 Clones a rnamlPages struture.

void rnamldeletePages (rnamlPages *pages)
 Frees the rnamlPages structure.

int rnamlisPages (const rnamlObject *obj)
 Tells wheter the object is a rnamlPages.

int rnamlequalsPages (const rnamlPages *left, const rnamlPages *right)
 Tells if left and right are equals.

int rnamlgetPagesStartPage (const rnamlPages *pages)
 Gets the pages startPage.

void rnamlsetPagesStartPage (rnamlPages *pages, int startPage)
 Sets the pages startPage.

int rnamlgetPagesEndPage (const rnamlPages *pages)
 Gets the pages endPage.

void rnamlsetPagesEndPage (rnamlPages *pages, int endPage)
 Sets the pages endPage.

xmlcpgObjectrnamltoXMLPages (const rnamlPages *pages)
 Translates the rnamlPages structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlPAGES rnamlPages
 

Rnaml structure containing the pages informations.


Function Documentation

rnamlPages* rnamlclonePages const rnamlPages   pages
 

Clones a rnamlPages struture.

Parameters:
pages  the structure to clone.
Returns:
the new allocated structure or NULL if something goes wrong.

void rnamldeletePages rnamlPages   pages
 

Frees the rnamlPages structure.

Parameters:
pages  the rnamlPages structure to free.

int rnamlequalsPages const rnamlPages   left,
const rnamlPages   right
 

Tells if left and right are equals.

Parameters:
left  the left object to compare.
right  the right object to compare.
Returns:
1 if the objects are equals or 0 otherwise.

int rnamlgetPagesEndPage const rnamlPages   pages
 

Gets the pages endPage.

Parameters:
pages  the rnamlPages structure.
Returns:
the pages endPage or -1 if pages is NULL or not an rnamlPages.

int rnamlgetPagesStartPage const rnamlPages   pages
 

Gets the pages startPage.

Parameters:
pages  the rnamlPages structure.
Returns:
the pages startPage or -1 if pages is NULL or not an rnamlPages.

int rnamlisPages const rnamlObject   obj
 

Tells wheter the object is a rnamlPages.

Parameters:
obj  the rnamlObject to test.
Returns:
1 if the object is a rnamlPages, 0 otherwise.

rnamlPages* rnamlnewPages  
 

Creates a new rnamlPages structure.

Returns:
the new allocated structure or NULL if something goes wrong.

void rnamlsetPagesEndPage rnamlPages   pages,
int    endPage
 

Sets the pages endPage.

Parameters:
pages  the rnamlPages structure.
endPage  the pages endPage.

void rnamlsetPagesStartPage rnamlPages   pages,
int    startPage
 

Sets the pages startPage.

Parameters:
pages  the rnamlPages structure.
startPage  the pages startPage.

xmlcpgObject* rnamltoXMLPages const rnamlPages   pages
 

Translates the rnamlPages structure into a xmlcpgElement conforming to the RNAML standard.

Parameters:
molecule  the rnamlPages structure to translate.
Returns:
the xmlcpgObject or NULL if something goes wrong.


Generated on Tue Nov 11 14:59:51 2003 for xmlcpg by doxygen1.2.18