list-item-label

list-item-label

Synopsis

                    FoListItemLabel;
                    FoListItemLabelClass;
FoFo*               fo_list_item_label_new              (void);

FoProperty*         fo_list_item_label_get_id           (FoFo *fo_fo);
void                fo_list_item_label_set_id           (FoFo *fo_fo,
                                                         FoProperty *new_id);
FoProperty*         fo_list_item_label_get_keep_together
                                                        (FoFo *fo_fo);
void                fo_list_item_label_set_keep_together
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together);
FoProperty*         fo_list_item_label_get_keep_together_within_column
                                                        (FoFo *fo_fo);
void                fo_list_item_label_set_keep_together_within_column
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_column);
FoProperty*         fo_list_item_label_get_keep_together_within_line
                                                        (FoFo *fo_fo);
void                fo_list_item_label_set_keep_together_within_line
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_line);
FoProperty*         fo_list_item_label_get_keep_together_within_page
                                                        (FoFo *fo_fo);
void                fo_list_item_label_set_keep_together_within_page
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_page);
FoProperty*         fo_list_item_label_get_role         (FoFo *fo_fo);
void                fo_list_item_label_set_role         (FoFo *fo_fo,
                                                         FoProperty *new_role);
FoProperty*         fo_list_item_label_get_source_document
                                                        (FoFo *fo_fo);
void                fo_list_item_label_set_source_document
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_source_document);

Object Hierarchy

  GObject
   +----FoObject
         +----FoNode
               +----FoFo
                     +----FoMarkerParent
                           +----FoListItemLabel

Properties

  "id"                       FoProperty*           : Read
  "keep-together"            FoProperty*           : Read
  "keep-together-within-column" FoProperty*           : Read
  "keep-together-within-line" FoProperty*           : Read
  "keep-together-within-page" FoProperty*           : Read
  "role"                     FoProperty*           : Read
  "source-document"          FoProperty*           : Read

Description

Details

FoListItemLabel

typedef struct _FoListItemLabel FoListItemLabel;


FoListItemLabelClass

typedef struct _FoListItemLabelClass FoListItemLabelClass;


fo_list_item_label_new ()

FoFo*               fo_list_item_label_new              (void);

Creates a new FoListItemLabel initialized to default value.

Returns :

the new FoListItemLabel.

fo_list_item_label_get_id ()

FoProperty*         fo_list_item_label_get_id           (FoFo *fo_fo);

Gets the "id" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "id" property value

fo_list_item_label_set_id ()

void                fo_list_item_label_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_list_item_label_get_keep_together ()

FoProperty*         fo_list_item_label_get_keep_together
                                                        (FoFo *fo_fo);

Gets the "keep-together" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "keep-together" property value

fo_list_item_label_set_keep_together ()

void                fo_list_item_label_set_keep_together
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together);

Sets the "keep-together" property of fo_fo to new_keep_together

fo_fo :

The FoFo object

new_keep_together :

The new "keep-together" property value

fo_list_item_label_get_keep_together_within_column ()

FoProperty*         fo_list_item_label_get_keep_together_within_column
                                                        (FoFo *fo_fo);

Gets the "keep-together-within-column" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "keep-together-within-column" property value

fo_list_item_label_set_keep_together_within_column ()

void                fo_list_item_label_set_keep_together_within_column
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_column);

Sets the "keep-together-within-column" property of fo_fo to new_keep_together_within_column

fo_fo :

The FoFo object

new_keep_together_within_column :

The new "keep-together-within-column" property value

fo_list_item_label_get_keep_together_within_line ()

FoProperty*         fo_list_item_label_get_keep_together_within_line
                                                        (FoFo *fo_fo);

Gets the "keep-together-within-line" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "keep-together-within-line" property value

fo_list_item_label_set_keep_together_within_line ()

void                fo_list_item_label_set_keep_together_within_line
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_line);

Sets the "keep-together-within-line" property of fo_fo to new_keep_together_within_line

fo_fo :

The FoFo object

new_keep_together_within_line :

The new "keep-together-within-line" property value

fo_list_item_label_get_keep_together_within_page ()

FoProperty*         fo_list_item_label_get_keep_together_within_page
                                                        (FoFo *fo_fo);

Gets the "keep-together-within-page" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "keep-together-within-page" property value

fo_list_item_label_set_keep_together_within_page ()

void                fo_list_item_label_set_keep_together_within_page
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_keep_together_within_page);

Sets the "keep-together-within-page" property of fo_fo to new_keep_together_within_page

fo_fo :

The FoFo object

new_keep_together_within_page :

The new "keep-together-within-page" property value

fo_list_item_label_get_role ()

FoProperty*         fo_list_item_label_get_role         (FoFo *fo_fo);

Gets the "role" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "role" property value

fo_list_item_label_set_role ()

void                fo_list_item_label_set_role         (FoFo *fo_fo,
                                                         FoProperty *new_role);

Sets the "role" property of fo_fo to new_role

fo_fo :

The FoFo object

new_role :

The new "role" property value

fo_list_item_label_get_source_document ()

FoProperty*         fo_list_item_label_get_source_document
                                                        (FoFo *fo_fo);

Gets the "source-document" property of fo_fo

fo_fo :

The FoFo object

Returns :

The "source-document" property value

fo_list_item_label_set_source_document ()

void                fo_list_item_label_set_source_document
                                                        (FoFo *fo_fo,
                                                         FoProperty *new_source_document);

Sets the "source-document" property of fo_fo to new_source_document

fo_fo :

The FoFo object

new_source_document :

The new "source-document" property value

Property Details

The "id" property

  "id"                       FoProperty*           : Read

Id property.


The "keep-together" property

  "keep-together"            FoProperty*           : Read

Keep Together property.


The "keep-together-within-column" property

  "keep-together-within-column" FoProperty*           : Read

Keep Together Within Column property.


The "keep-together-within-line" property

  "keep-together-within-line" FoProperty*           : Read

Keep Together Within Line property.


The "keep-together-within-page" property

  "keep-together-within-page" FoProperty*           : Read

Keep Together Within Page property.


The "role" property

  "role"                     FoProperty*           : Read

Role property.


The "source-document" property

  "source-document"          FoProperty*           : Read

Source Document property.