page-sequence

page-sequence

Synopsis

                    FoPageSequence;
                    FoPageSequenceClass;
FoFo*               fo_page_sequence_new                (void);

FoProperty*         fo_page_sequence_get_format         (FoFo *fo_fo);
void                fo_page_sequence_set_format         (FoFo *fo_fo,
                                                         FoProperty *new_format);
FoProperty*         fo_page_sequence_get_grouping_separator
                                                        (FoFo *fo_fo);
void                fo_page_sequence_set_grouping_separator
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_grouping_separator);
FoProperty*         fo_page_sequence_get_grouping_size  (FoFo *fo_fo);
void                fo_page_sequence_set_grouping_size  (FoFo *fo_fo,
                                                         FoProperty *new_grouping_size);
FoProperty*         fo_page_sequence_get_id             (FoFo *fo_fo);
void                fo_page_sequence_set_id             (FoFo *fo_fo,
                                                         FoProperty *new_id);
FoProperty*         fo_page_sequence_get_letter_value   (FoFo *fo_fo);
void                fo_page_sequence_set_letter_value   (FoFo *fo_fo,
                                                         FoProperty *new_letter_value);
FoProperty*         fo_page_sequence_get_master_reference
                                                        (FoFo *fo_fo);
void                fo_page_sequence_set_master_reference
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_master_reference);

Object Hierarchy

  GObject
   +----FoObject
         +----FoNode
               +----FoFo
                     +----FoPageSequence

Properties

  "format"                   FoProperty*           : Read
  "grouping-separator"       FoProperty*           : Read
  "grouping-size"            FoProperty*           : Read
  "id"                       FoProperty*           : Read
  "letter-value"             FoProperty*           : Read
  "master-reference"         FoProperty*           : Read

Description

Details

FoPageSequence

typedef struct _FoPageSequence FoPageSequence;

Instance of the 'page-sequence' formatting object.


FoPageSequenceClass

typedef struct _FoPageSequenceClass FoPageSequenceClass;

Class structure for the 'page-sequence' formatting object.


fo_page_sequence_new ()

FoFo*               fo_page_sequence_new                (void);

Creates a new FoPageSequence initialized to default value.

Returns :

the new FoPageSequence.

fo_page_sequence_get_format ()

FoProperty*         fo_page_sequence_get_format         (FoFo *fo_fo);

Gets the "format" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "format" property value.

fo_page_sequence_set_format ()

void                fo_page_sequence_set_format         (FoFo *fo_fo,
                                                         FoProperty *new_format);

Sets the "format" property of fo_fo to new_format.

fo_fo :

The FoFo object.

new_format :

The new "format" property value.

fo_page_sequence_get_grouping_separator ()

FoProperty*         fo_page_sequence_get_grouping_separator
                                                        (FoFo *fo_fo);

Gets the "grouping-separator" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "grouping-separator" property value.

fo_page_sequence_set_grouping_separator ()

void                fo_page_sequence_set_grouping_separator
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_grouping_separator);

Sets the "grouping-separator" property of fo_fo to new_grouping_separator.

fo_fo :

The FoFo object.

new_grouping_separator :

The new "grouping-separator" property value.

fo_page_sequence_get_grouping_size ()

FoProperty*         fo_page_sequence_get_grouping_size  (FoFo *fo_fo);

Gets the "grouping-size" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "grouping-size" property value.

fo_page_sequence_set_grouping_size ()

void                fo_page_sequence_set_grouping_size  (FoFo *fo_fo,
                                                         FoProperty *new_grouping_size);

Sets the "grouping-size" property of fo_fo to new_grouping_size.

fo_fo :

The FoFo object.

new_grouping_size :

The new "grouping-size" property value.

fo_page_sequence_get_id ()

FoProperty*         fo_page_sequence_get_id             (FoFo *fo_fo);

Gets the "id" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "id" property value.

fo_page_sequence_set_id ()

void                fo_page_sequence_set_id             (FoFo *fo_fo,
                                                         FoProperty *new_id);

Sets the "id" property of fo_fo to new_id.

fo_fo :

The FoFo object.

new_id :

The new "id" property value.

fo_page_sequence_get_letter_value ()

FoProperty*         fo_page_sequence_get_letter_value   (FoFo *fo_fo);

Gets the "letter-value" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "letter-value" property value.

fo_page_sequence_set_letter_value ()

void                fo_page_sequence_set_letter_value   (FoFo *fo_fo,
                                                         FoProperty *new_letter_value);

Sets the "letter-value" property of fo_fo to new_letter_value.

fo_fo :

The FoFo object.

new_letter_value :

The new "letter-value" property value.

fo_page_sequence_get_master_reference ()

FoProperty*         fo_page_sequence_get_master_reference
                                                        (FoFo *fo_fo);

Gets the "master-reference" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "master-reference" property value.

fo_page_sequence_set_master_reference ()

void                fo_page_sequence_set_master_reference
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_master_reference);

Sets the "master-reference" property of fo_fo to new_master_reference.

fo_fo :

The FoFo object.

new_master_reference :

The new "master-reference" property value.

Property Details

The "format" property

  "format"                   FoProperty*           : Read

Format property.


The "grouping-separator" property

  "grouping-separator"       FoProperty*           : Read

Grouping Separator property.


The "grouping-size" property

  "grouping-size"            FoProperty*           : Read

Grouping Size property.


The "id" property

  "id"                       FoProperty*           : Read

Id property.


The "letter-value" property

  "letter-value"             FoProperty*           : Read

Letter Value property.


The "master-reference" property

  "master-reference"         FoProperty*           : Read

Master Reference property.