simple-page-master

simple-page-master

Synopsis

                    FoSimplePageMaster;
                    FoSimplePageMasterClass;
FoFo*               fo_simple_page_master_new           (void);

FoProperty*         fo_simple_page_master_get_end_indent
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_end_indent
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_end_indent);
FoProperty*         fo_simple_page_master_get_margin_bottom
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_margin_bottom
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_bottom);
FoProperty*         fo_simple_page_master_get_margin_left
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_margin_left
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_left);
FoProperty*         fo_simple_page_master_get_margin_right
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_margin_right
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_right);
FoProperty*         fo_simple_page_master_get_margin_top
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_margin_top
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_top);
FoProperty*         fo_simple_page_master_get_master_name
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_master_name
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_master_name);
FoProperty*         fo_simple_page_master_get_page_height
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_page_height
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_page_height);
FoProperty*         fo_simple_page_master_get_page_width
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_page_width
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_page_width);
FoProperty*         fo_simple_page_master_get_space_after
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_space_after
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_space_after);
FoProperty*         fo_simple_page_master_get_space_before
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_space_before
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_space_before);
FoProperty*         fo_simple_page_master_get_start_indent
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_start_indent
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_start_indent);
FoProperty*         fo_simple_page_master_get_writing_mode
                                                        (FoFo *fo_fo);
void                fo_simple_page_master_set_writing_mode
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_writing_mode);

FoFo*               fo_simple_page_master_region_name_get
                                                        (FoFo *simple_page_master,
                                                         const gchar *name);
void                fo_simple_page_master_region_name_add
                                                        (FoFo *simple_page_master,
                                                         const gchar *name,
                                                         FoFo *fo);

Object Hierarchy

  GObject
   +----FoObject
         +----FoNode
               +----FoFo
                     +----FoSimplePageMaster

Properties

  "end-indent"               FoProperty*           : Read
  "margin-bottom"            FoProperty*           : Read
  "margin-left"              FoProperty*           : Read
  "margin-right"             FoProperty*           : Read
  "margin-top"               FoProperty*           : Read
  "master-name"              FoProperty*           : Read
  "page-height"              FoProperty*           : Read
  "page-width"               FoProperty*           : Read
  "space-after"              FoProperty*           : Read
  "space-before"             FoProperty*           : Read
  "start-indent"             FoProperty*           : Read
  "writing-mode"             FoProperty*           : Read

Description

Details

FoSimplePageMaster

typedef struct _FoSimplePageMaster FoSimplePageMaster;


FoSimplePageMasterClass

typedef struct _FoSimplePageMasterClass FoSimplePageMasterClass;


fo_simple_page_master_new ()

FoFo*               fo_simple_page_master_new           (void);

Creates a new FoSimplePageMaster initialized to default value.

Returns :

the new FoSimplePageMaster.

fo_simple_page_master_get_end_indent ()

FoProperty*         fo_simple_page_master_get_end_indent
                                                        (FoFo *fo_fo);

Gets the "end-indent" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "end-indent" property value.

fo_simple_page_master_set_end_indent ()

void                fo_simple_page_master_set_end_indent
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_end_indent);

Sets the "end-indent" property of fo_fo to new_end_indent

fo_fo :

The FoFo object

new_end_indent :

The new "end-indent" property value

fo_simple_page_master_get_margin_bottom ()

FoProperty*         fo_simple_page_master_get_margin_bottom
                                                        (FoFo *fo_fo);

Gets the "margin-bottom" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "margin-bottom" property value.

fo_simple_page_master_set_margin_bottom ()

void                fo_simple_page_master_set_margin_bottom
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_bottom);

Sets the "margin-bottom" property of fo_fo to new_margin_bottom

fo_fo :

The FoFo object

new_margin_bottom :

The new "margin-bottom" property value

fo_simple_page_master_get_margin_left ()

FoProperty*         fo_simple_page_master_get_margin_left
                                                        (FoFo *fo_fo);

Gets the "margin-left" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "margin-left" property value.

fo_simple_page_master_set_margin_left ()

void                fo_simple_page_master_set_margin_left
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_left);

Sets the "margin-left" property of fo_fo to new_margin_left

fo_fo :

The FoFo object

new_margin_left :

The new "margin-left" property value

fo_simple_page_master_get_margin_right ()

FoProperty*         fo_simple_page_master_get_margin_right
                                                        (FoFo *fo_fo);

Gets the "margin-right" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "margin-right" property value.

fo_simple_page_master_set_margin_right ()

void                fo_simple_page_master_set_margin_right
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_right);

Sets the "margin-right" property of fo_fo to new_margin_right

fo_fo :

The FoFo object

new_margin_right :

The new "margin-right" property value

fo_simple_page_master_get_margin_top ()

FoProperty*         fo_simple_page_master_get_margin_top
                                                        (FoFo *fo_fo);

Gets the "margin-top" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "margin-top" property value.

fo_simple_page_master_set_margin_top ()

void                fo_simple_page_master_set_margin_top
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_margin_top);

Sets the "margin-top" property of fo_fo to new_margin_top

fo_fo :

The FoFo object

new_margin_top :

The new "margin-top" property value

fo_simple_page_master_get_master_name ()

FoProperty*         fo_simple_page_master_get_master_name
                                                        (FoFo *fo_fo);

Gets the "master-name" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "master-name" property value.

fo_simple_page_master_set_master_name ()

void                fo_simple_page_master_set_master_name
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_master_name);

Sets the "master-name" property of fo_fo to new_master_name

fo_fo :

The FoFo object

new_master_name :

The new "master-name" property value

fo_simple_page_master_get_page_height ()

FoProperty*         fo_simple_page_master_get_page_height
                                                        (FoFo *fo_fo);

Gets the "page-height" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "page-height" property value.

fo_simple_page_master_set_page_height ()

void                fo_simple_page_master_set_page_height
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_page_height);

Sets the "page-height" property of fo_fo to new_page_height

fo_fo :

The FoFo object

new_page_height :

The new "page-height" property value

fo_simple_page_master_get_page_width ()

FoProperty*         fo_simple_page_master_get_page_width
                                                        (FoFo *fo_fo);

Gets the "page-width" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "page-width" property value.

fo_simple_page_master_set_page_width ()

void                fo_simple_page_master_set_page_width
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_page_width);

Sets the "page-width" property of fo_fo to new_page_width

fo_fo :

The FoFo object

new_page_width :

The new "page-width" property value

fo_simple_page_master_get_space_after ()

FoProperty*         fo_simple_page_master_get_space_after
                                                        (FoFo *fo_fo);

Gets the "space-after" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "space-after" property value.

fo_simple_page_master_set_space_after ()

void                fo_simple_page_master_set_space_after
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_space_after);

Sets the "space-after" property of fo_fo to new_space_after

fo_fo :

The FoFo object

new_space_after :

The new "space-after" property value

fo_simple_page_master_get_space_before ()

FoProperty*         fo_simple_page_master_get_space_before
                                                        (FoFo *fo_fo);

Gets the "space-before" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "space-before" property value.

fo_simple_page_master_set_space_before ()

void                fo_simple_page_master_set_space_before
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_space_before);

Sets the "space-before" property of fo_fo to new_space_before

fo_fo :

The FoFo object

new_space_before :

The new "space-before" property value

fo_simple_page_master_get_start_indent ()

FoProperty*         fo_simple_page_master_get_start_indent
                                                        (FoFo *fo_fo);

Gets the "start-indent" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "start-indent" property value.

fo_simple_page_master_set_start_indent ()

void                fo_simple_page_master_set_start_indent
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_start_indent);

Sets the "start-indent" property of fo_fo to new_start_indent

fo_fo :

The FoFo object

new_start_indent :

The new "start-indent" property value

fo_simple_page_master_get_writing_mode ()

FoProperty*         fo_simple_page_master_get_writing_mode
                                                        (FoFo *fo_fo);

Gets the "writing-mode" property of fo_fo.

fo_fo :

The FoFo object.

Returns :

The "writing-mode" property value.

fo_simple_page_master_set_writing_mode ()

void                fo_simple_page_master_set_writing_mode
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_writing_mode);

Sets the "writing-mode" property of fo_fo to new_writing_mode

fo_fo :

The FoFo object

new_writing_mode :

The new "writing-mode" property value

fo_simple_page_master_region_name_get ()

FoFo*               fo_simple_page_master_region_name_get
                                                        (FoFo *simple_page_master,
                                                         const gchar *name);

Get the page region object for a page region name.

simple_page_master :

FoSimplePageMaster that has hash of regions

name :

Name of page region

Returns :

Page region object

fo_simple_page_master_region_name_add ()

void                fo_simple_page_master_region_name_add
                                                        (FoFo *simple_page_master,
                                                         const gchar *name,
                                                         FoFo *fo);

Add a page region object to the page region name/object hash maintained by simple_page_master.

simple_page_master :

FoSimplePageMaster

name :

Name of the page region

fo :

The page region object

Property Details

The "end-indent" property

  "end-indent"               FoProperty*           : Read

End Indent property.


The "margin-bottom" property

  "margin-bottom"            FoProperty*           : Read

Margin Bottom property.


The "margin-left" property

  "margin-left"              FoProperty*           : Read

Margin Left property.


The "margin-right" property

  "margin-right"             FoProperty*           : Read

Margin Right property.


The "margin-top" property

  "margin-top"               FoProperty*           : Read

Margin Top property.


The "master-name" property

  "master-name"              FoProperty*           : Read

Master Name property.


The "page-height" property

  "page-height"              FoProperty*           : Read

Page Height property.


The "page-width" property

  "page-width"               FoProperty*           : Read

Page Width property.


The "space-after" property

  "space-after"              FoProperty*           : Read

Space After property.


The "space-before" property

  "space-before"             FoProperty*           : Read

Space Before property.


The "start-indent" property

  "start-indent"             FoProperty*           : Read

Start Indent property.


The "writing-mode" property

  "writing-mode"             FoProperty*           : Read

Writing Mode property.