FoAreaReference

FoAreaReference

Synopsis

                    FoAreaReference;
                    FoAreaReferenceClass;
FoArea*             fo_area_reference_new               (void);
void                fo_area_reference_set_bpd           (FoArea *fo_area,
                                                         FoEnumAreaDirection new_bpd);
FoEnumAreaDirection fo_area_reference_get_bpd           (FoArea *fo_area);
void                fo_area_reference_set_ipd           (FoArea *fo_area,
                                                         FoEnumAreaDirection new_ipd);
FoEnumAreaDirection fo_area_reference_get_ipd           (FoArea *fo_area);
void                fo_area_reference_set_sd            (FoArea *fo_area,
                                                         FoEnumAreaDirection new_sd);
FoEnumAreaDirection fo_area_reference_get_sd            (FoArea *fo_area);

Object Hierarchy

  GObject
   +----FoObject
         +----FoNode
               +----FoArea
                     +----FoAreaArea
                           +----FoAreaReference
                                 +----FoAreaViewportReference
                                 +----FoAreaSpanningTableCell
                                 +----FoAreaTableCell
                                 +----FoAreaTable

Properties

  "bpd"                      guint                 : Read / Write
  "ipd"                      guint                 : Read / Write
  "sd"                       guint                 : Read / Write

Description

Details

FoAreaReference

typedef struct _FoAreaReference FoAreaReference;


FoAreaReferenceClass

typedef struct _FoAreaReferenceClass FoAreaReferenceClass;


fo_area_reference_new ()

FoArea*             fo_area_reference_new               (void);

Creates a new FoAreaReference initialized to default value.

Returns :

the new FoAreaReference

fo_area_reference_set_bpd ()

void                fo_area_reference_set_bpd           (FoArea *fo_area,
                                                         FoEnumAreaDirection new_bpd);

Sets the "bpd" property of fo_area to new_bpd

fo_area :

The FoAreaReference object

new_bpd :

The new "bpd" property value

fo_area_reference_get_bpd ()

FoEnumAreaDirection fo_area_reference_get_bpd           (FoArea *fo_area);

Gets the "bpd" property of fo_area

fo_area :

The FoAreaReference object

Returns :

The "bpd" property value

fo_area_reference_set_ipd ()

void                fo_area_reference_set_ipd           (FoArea *fo_area,
                                                         FoEnumAreaDirection new_ipd);

Sets the "ipd" property of fo_area to new_ipd

fo_area :

The FoAreaReference object

new_ipd :

The new "ipd" property value

fo_area_reference_get_ipd ()

FoEnumAreaDirection fo_area_reference_get_ipd           (FoArea *fo_area);

Gets the "ipd" property of fo_area

fo_area :

The FoAreaReference object

Returns :

The "ipd" property value

fo_area_reference_set_sd ()

void                fo_area_reference_set_sd            (FoArea *fo_area,
                                                         FoEnumAreaDirection new_sd);

Sets the "sd" property of fo_area to new_sd

fo_area :

The FoAreaReference object

new_sd :

The new "sd" property value

fo_area_reference_get_sd ()

FoEnumAreaDirection fo_area_reference_get_sd            (FoArea *fo_area);

Gets the "sd" property of fo_area

fo_area :

The FoAreaReference object

Returns :

The "sd" property value

Property Details

The "bpd" property

  "bpd"                      guint                 : Read / Write

Block progression direction of the reference area.

Default value: 0


The "ipd" property

  "ipd"                      guint                 : Read / Write

Inline progression direction of the reference area.

Default value: 0


The "sd" property

  "sd"                       guint                 : Read / Write

Shift direction of the reference area.

Default value: 0