page-sequence: xmlroff Reference Manual

page-sequence

page-sequence — 'page-sequence' formatting object

Functions

FoFo *	fo_page_sequence_new ()
FoFo *	fo_page_sequence_get_page_master ()
FoProperty *	fo_page_sequence_get_country ()
void	fo_page_sequence_set_country ()
FoProperty *	fo_page_sequence_get_force_page_count ()
void	fo_page_sequence_set_force_page_count ()
FoProperty *	fo_page_sequence_get_format ()
void	fo_page_sequence_set_format ()
FoProperty *	fo_page_sequence_get_grouping_separator ()
void	fo_page_sequence_set_grouping_separator ()
FoProperty *	fo_page_sequence_get_grouping_size ()
void	fo_page_sequence_set_grouping_size ()
FoProperty *	fo_page_sequence_get_id ()
void	fo_page_sequence_set_id ()
FoProperty *	fo_page_sequence_get_initial_page_number ()
void	fo_page_sequence_set_initial_page_number ()
FoProperty *	fo_page_sequence_get_language ()
void	fo_page_sequence_set_language ()
FoProperty *	fo_page_sequence_get_letter_value ()
void	fo_page_sequence_set_letter_value ()
FoProperty *	fo_page_sequence_get_master_reference ()
void	fo_page_sequence_set_master_reference ()

Properties

FoProperty *	country	Read
FoProperty *	force-page-count	Read
FoProperty *	format	Read
FoProperty *	grouping-separator	Read
FoProperty *	grouping-size	Read
FoProperty *	id	Read
FoProperty *	initial-page-number	Read
FoProperty *	language	Read
FoProperty *	letter-value	Read
FoProperty *	master-reference	Read

Types and Values

	FoPageSequence
	FoPageSequenceClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── FoObject
            ╰── FoNode
                ╰── FoFo
                    ╰── FoPageSequence

Description

Definition: http://www.w3.org/TR/xsl11/#fo_page-sequence

Functions

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_page_master ()

FoFo *
fo_page_sequence_get_page_master (FoFo *fo_fo);

Gets the page-master of fo_fo .

Parameters

fo_fo

The FoFo object.

Returns

The page-master of fo_fo .

fo_page_sequence_get_country ()

FoProperty *
fo_page_sequence_get_country (FoFo *fo_fo);

Gets the "country" property of fo_fo .

Parameters

fo_fo

The FoFo object.

Returns

The "country" property value.

fo_page_sequence_set_country ()

void
fo_page_sequence_set_country (FoFo *fo_fo,
                              FoProperty *new_country);

Sets the "country" property of fo_fo to new_country .

Parameters

fo_fo	The FoFo object.
new_country	The new "country" property value.

fo_page_sequence_get_force_page_count ()

FoProperty *
fo_page_sequence_get_force_page_count (FoFo *fo_fo);

Gets the "force-page-count" property of fo_fo .

Parameters

fo_fo

The FoFo object.

Returns

The "force-page-count" property value.

fo_page_sequence_set_force_page_count ()

void
fo_page_sequence_set_force_page_count (FoFo *fo_fo,
                                       FoProperty *new_force_page_count);

Sets the "force-page-count" property of fo_fo to new_force_page_count .

Parameters

fo_fo	The FoFo object.
new_force_page_count	The new "force-page-count" property value.

fo_page_sequence_get_format ()

FoProperty *
fo_page_sequence_get_format (FoFo *fo_fo);

Gets the "format" property of fo_fo .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

fo_fo	The FoFo object.
new_id	The new "id" property value.

fo_page_sequence_get_initial_page_number ()

FoProperty *
fo_page_sequence_get_initial_page_number
                               (FoFo *fo_fo);

Gets the "initial-page-number" property of fo_fo .

Parameters

fo_fo

The FoFo object.

Returns

The "initial-page-number" property value.

fo_page_sequence_set_initial_page_number ()

void
fo_page_sequence_set_initial_page_number
                               (FoFo *fo_fo,
                                FoProperty *new_initial_page_number);

Sets the "initial-page-number" property of fo_fo to new_initial_page_number .

Parameters

fo_fo	The FoFo object.
new_initial_page_number	The new "initial-page-number" property value.

fo_page_sequence_get_language ()

FoProperty *
fo_page_sequence_get_language (FoFo *fo_fo);

Gets the "language" property of fo_fo .

Parameters

fo_fo

The FoFo object.

Returns

The "language" property value.

fo_page_sequence_set_language ()

void
fo_page_sequence_set_language (FoFo *fo_fo,
                               FoProperty *new_language);

Sets the "language" property of fo_fo to new_language .

Parameters

fo_fo	The FoFo object.
new_language	The new "language" 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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

fo_fo	The FoFo object.
new_master_reference	The new "master-reference" property value.

Types and Values

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.

Property Details

The `“country”` property

  “country”                  FoProperty *

Country property.

Owner: FoPageSequence

Flags: Read

The `“force-page-count”` property

  “force-page-count”         FoProperty *

Force Page Count property.

Owner: FoPageSequence

Flags: Read

The `“format”` property

  “format”                   FoProperty *

Format property.

Owner: FoPageSequence

Flags: Read

The `“grouping-separator”` property

  “grouping-separator”       FoProperty *

Grouping Separator property.

Owner: FoPageSequence

Flags: Read

The `“grouping-size”` property

  “grouping-size”            FoProperty *

Grouping Size property.

Owner: FoPageSequence

Flags: Read

The `“id”` property

  “id”                       FoProperty *

Id property.

Owner: FoPageSequence

Flags: Read

The `“initial-page-number”` property

  “initial-page-number”      FoProperty *

Initial Page Number property.

Owner: FoPageSequence

Flags: Read

The `“language”` property

  “language”                 FoProperty *

Language property.

Owner: FoPageSequence

Flags: Read

The `“letter-value”` property

  “letter-value”             FoProperty *

Letter Value property.

Owner: FoPageSequence

Flags: Read

The `“master-reference”` property

  “master-reference”         FoProperty *

Master Reference property.

Owner: FoPageSequence

Flags: Read

page-sequence

Functions

Properties

Types and Values

Object Hierarchy

Description

Functions

fo_page_sequence_new ()

Returns

fo_page_sequence_get_page_master ()

Parameters

Returns

fo_page_sequence_get_country ()

Parameters

Returns

fo_page_sequence_set_country ()

Parameters

fo_page_sequence_get_force_page_count ()

Parameters

Returns

fo_page_sequence_set_force_page_count ()

Parameters

fo_page_sequence_get_format ()

Parameters

Returns

fo_page_sequence_set_format ()

Parameters

fo_page_sequence_get_grouping_separator ()

Parameters

Returns

fo_page_sequence_set_grouping_separator ()

Parameters

fo_page_sequence_get_grouping_size ()

Parameters

Returns

fo_page_sequence_set_grouping_size ()

Parameters

fo_page_sequence_get_id ()

Parameters

Returns

fo_page_sequence_set_id ()

Parameters

fo_page_sequence_get_initial_page_number ()

Parameters

Returns

fo_page_sequence_set_initial_page_number ()

Parameters

fo_page_sequence_get_language ()

Parameters

Returns

fo_page_sequence_set_language ()

Parameters

fo_page_sequence_get_letter_value ()

Parameters

Returns

fo_page_sequence_set_letter_value ()

Parameters

fo_page_sequence_get_master_reference ()

Parameters

Returns

fo_page_sequence_set_master_reference ()

Parameters

Types and Values

FoPageSequence

FoPageSequenceClass

Property Details

The “country” property

The “force-page-count” property

The “format” property

The “grouping-separator” property

The “grouping-size” property

The “id” property

The “initial-page-number” property

The “language” property

The “letter-value” property

The “master-reference” property

The `“country”` property

The `“force-page-count”` property

The `“format”` property

The `“grouping-separator”` property

The `“grouping-size”` property

The `“id”` property

The `“initial-page-number”` property

The `“language”` property

The `“letter-value”` property

The `“master-reference”` property