cr-cascade.h File Reference

the declaration of the CRCascade class. More...

#include "cr-stylesheet.h"

Go to the source code of this file.

Data Structures

struct  _CRCascade

Typedefs

typedef typedefG_BEGIN_DECLS
struct _CRCascadePriv 
CRCascadePriv
typedef _CRCascade CRCascade
 An abstraction of the "Cascade" defined in the css2 spec, chapter 6.4.

Functions

CRCascadecr_cascade_new (CRStyleSheet *a_author_sheet, CRStyleSheet *a_user_sheet, CRStyleSheet *a_ua_sheet)
 cr_cascade_new: : the author origin style sheet.
CRStyleSheetcr_cascade_get_sheet (CRCascade *a_this, enum CRStyleOrigin a_origin)
 cr_cascade_get_sheet: : the current instance of CRCascade.
enum CRStatus cr_cascade_set_sheet (CRCascade *a_this, CRStyleSheet *a_sheet, enum CRStyleOrigin a_origin)
 cr_cascade_set_sheet: : the current instance of CRCascade.
void cr_cascade_ref (CRCascade *a_this)
 cr_cascade_ref: : the current instance of CRCascade
void cr_cascade_unref (CRCascade *a_this)
 cr_cascade_unref: : the current instance of CRCascade.
void cr_cascade_destroy (CRCascade *a_this)
 cr_cascade_destroy: : the current instance of CRCascade


Detailed Description

the declaration of the CRCascade class.

Definition in file cr-cascade.h.


Typedef Documentation

typedef struct _CRCascade CRCascade
 

An abstraction of the "Cascade" defined in the css2 spec, chapter 6.4.

Definition at line 47 of file cr-cascade.h.

typedef typedefG_BEGIN_DECLS struct _CRCascadePriv CRCascadePriv
 

Definition at line 41 of file cr-cascade.h.


Function Documentation

void cr_cascade_destroy CRCascade a_this  ) 
 

cr_cascade_destroy: : the current instance of CRCascade

Destructor of CRCascade.

Definition at line 194 of file cr-cascade.c.

References cr_stylesheet_unref(), NB_ORIGINS, and PRIVATE.

Referenced by cr_cascade_unref().

CRStyleSheet* cr_cascade_get_sheet CRCascade a_this,
enum CRStyleOrigin  a_origin
 

cr_cascade_get_sheet: : the current instance of CRCascade.

: the origin of the style sheet as defined in the css2 spec in chapter 6.4. Gets a given origin sheet.

Gets a sheet, part of the cascade. Note that the returned stylesheet is refcounted so if the caller wants to manage it's lifecycle, it must use cr_stylesheet_ref()/cr_stylesheet_unref() instead of the cr_stylesheet_destroy() method. Returns the style sheet, or NULL if it does not exist.

Definition at line 113 of file cr-cascade.c.

References NB_ORIGINS, ORIGIN_UA, and PRIVATE.

Referenced by cr_sel_eng_get_matched_properties_from_cascade().

CRCascade* cr_cascade_new CRStyleSheet a_author_sheet,
CRStyleSheet a_user_sheet,
CRStyleSheet a_ua_sheet
 

cr_cascade_new: : the author origin style sheet.

May be NULL. : the user origin style sheet. May be NULL. : the user agent origin style sheet. May be NULL.

Constructor of the CRCascade class. Note that all three parameters of this method are ref counted and their refcount is increased. Their refcount will be decreased at the destruction of the instance of CRCascade. So the caller should not call their destructor. The caller should call their ref/unref method instead if it wants

Returns the newly built instance of CRCascade or NULL if an error arose during constrution.

Definition at line 64 of file cr-cascade.c.

References cr_cascade_set_sheet(), cr_utils_trace_info, ORIGIN_AUTHOR, ORIGIN_UA, ORIGIN_USER, and PRIVATE.

void cr_cascade_ref CRCascade a_this  ) 
 

cr_cascade_ref: : the current instance of CRCascade

Increases the reference counter of the current instance of CRCascade.

Definition at line 158 of file cr-cascade.c.

References PRIVATE.

enum CRStatus cr_cascade_set_sheet CRCascade a_this,
CRStyleSheet a_sheet,
enum CRStyleOrigin  a_origin
 

cr_cascade_set_sheet: : the current instance of CRCascade.

: the stylesheet to set. : the origin of the stylesheet.

Sets a stylesheet in the cascade

Returns CR_OK upon successfull completion, an error code otherwise.

Definition at line 134 of file cr-cascade.c.

References CR_BAD_PARAM_ERROR, CR_OK, cr_stylesheet_ref(), cr_stylesheet_unref(), NB_ORIGINS, _CRStyleSheet::origin, ORIGIN_UA, and PRIVATE.

Referenced by cr_cascade_new().

void cr_cascade_unref CRCascade a_this  ) 
 

cr_cascade_unref: : the current instance of CRCascade.

Decrements the reference counter associated to this instance of CRCascade. If the reference counter reaches zero, the instance is destroyed using cr_cascade_destroy()

Definition at line 176 of file cr-cascade.c.

References cr_cascade_destroy(), and PRIVATE.


Generated on Thu Mar 9 19:19:09 2006 for Libcroco by  doxygen 1.4.6