Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

cr-lay-eng.h File Reference

the declaration of the CRLayEng class. More...

#include <libxml/tree.h>
#include "cr-utils.h"
#include "cr-cascade.h"
#include "cr-box.h"

Go to the source code of this file.

Data Structures

struct  CRLayEng
 The abstraction of the Layout engine of libcroco. More...


Functions

void cr_lay_eng_init (glong a_argc, gchar **a_argv)
 The first function to call prior to any other method of the layout engine.

CRLayEngcr_lay_eng_new (GtkLayout *a_layout)
 Instanciates a new Layout Engine.

enum CRStatus cr_lay_eng_create_box_model (CRLayEng *a_this, xmlDoc *a_xml_doc, CRCascade *a_cascade, CRBoxModel **a_box_model)
 Creates the box model from an xml document.

enum CRStatus cr_lay_eng_layout_box_tree (CRLayEng *a_this, CRBox *a_box_tree)
 Recursively computes the sizes and positions of each box in the box tree.

void cr_lay_eng_destroy (CRLayEng *a_this)
 Destuctor of CRLayEng.


Variables

typedefG_BEGIN_DECLS struct
_CRLayEngPriv 
CRLayEngPriv


Detailed Description

the declaration of the CRLayEng class.

Definition in file cr-lay-eng.h.


Function Documentation

enum CRStatus cr_lay_eng_create_box_model CRLayEng a_this,
xmlDoc *  a_doc,
CRCascade a_cascade,
CRBoxModel **  a_box_model
 

Creates the box model from an xml document.

Parameters:
a_this the current instance of CRLayEng.
a_doc the current xml document.
a_cascade the css2 stylesheet cascade.
a_box_model out parameter. The returned
Returns:
CR_OK upon successfull completion, an error code otherwise.

Definition at line 1539 of file cr-lay-eng.c.

References CR_BAD_PARAM_ERROR, cr_box_model_new(), CR_ERROR, CR_NO_ROOT_NODE_ERROR, CR_OK, and PRIVATE.

Referenced by cr_box_view_new_from_xml_css_bufs().

void cr_lay_eng_destroy CRLayEng a_this  ) 
 

Destuctor of CRLayEng.

Parameters:
a_this the current instance of CRLayEng.

Definition at line 1601 of file cr-lay-eng.c.

void cr_lay_eng_init glong  a_argc,
gchar **  a_argv
 

The first function to call prior to any other method of the layout engine.

Parameters:
a_argc the argc parameter passed to the standard C main entry point.
a_argv the argv parameter passed to the standard C main entry point.

Definition at line 1473 of file cr-lay-eng.c.

enum CRStatus cr_lay_eng_layout_box_tree CRLayEng a_this,
CRBox a_box_tree
 

Recursively computes the sizes and positions of each box in the box tree.

Parameters:
a_this 
a_box_tree 
Returns:

Definition at line 1582 of file cr-lay-eng.c.

References CR_BAD_PARAM_ERROR, CR_OK, and CRStatus.

Referenced by cr_box_view_layout().

CRLayEng* cr_lay_eng_new GtkLayout *  a_layout  ) 
 

Instanciates a new Layout Engine.

return the new instance of CRLayEng or NULL if an error occured.

Definition at line 1490 of file cr-lay-eng.c.

References cr_utils_trace_info, and PRIVATE.


Variable Documentation

typedefG_BEGIN_DECLS struct _CRLayEngPriv CRLayEngPriv
 

Definition at line 40 of file cr-lay-eng.h.


Generated on Wed Oct 1 01:36:51 2003 for Libcroco by doxygen 1.3.3