Sfairadora

  • Reference Guide

Rich_pformat_def

The definition type for the type Rich_pformat. It is a sequence of the structures Rich_pformat_element_def. Every element of the sequence optionally specifies a name of a paragraph style and a structure with the paragraph format attributes. Besides that, standard character format for the paragraph is specified. The way to determine the value of a paragraph format attribute is analogical to Rich_cformat_def.

Type Definition

Seq(Rich_pformat_element_def)

Rich_pformat_element_def

The structure that is the element type of the sequence Rich_pformat_def.
Type
Name
Description
String
style
The name of a paragraph style. The attributes of the style are used when an attribute is not specified by the component par_attr.
Par_attr_struct
Par_attr
The attributes of the paragraph format.
char_attr
The attributes of paragraph’s standard character format.

Par_attr_struct

Par_attr_struct is the structure containing the attributes of a paragraph format. All the components are optional. If a component’s value is not present, the value of the corresponding attribute is left unspecified.
Type
Name
Description
Real optional
space_top
Space before paragraph (in cm)
Real optional
space_bottom
Space after paragraph (in cm)
Real optional
indent_first_line
Indent of the first line of the paragraph relative to the left indent of the paragraph. (in cm)
Real optional
indent_left
Left indent of the paragraph relative to the left page margin. (in cm)
Real optional
indent_right
Right indent of the paragraph relative to the right page margin. (in cm)
Int optional
align
Paragraph alignment. One of the alignment constants. (Only the constants ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, and ALIGN_BLOCK are allowed.)
Seq(Tab_info)
(see below)
tabs_info
Sequence of tab stops.
The sequence is ordered by the increasing position of the tab stop. Sequence unicity is set to the tab stop.
Int optional
spacing_mode
Line spacing mode. Determines the interpretation of the value spacing_size.
One of the spacing mode constants.
Real optional
spacing_size
The size of line spacing. See the attribute spacing_mode.
Int optional
start_new_page
If set, a page break is inserted before the paragraph.
One of the format switch constants.
Int optional
no_separated_lines
If set, a page break is never inserted after the first line or before the last line of the paragraph (i.e. prevents widows and orphans).
One of the format switch constants.
Int optional
keep_together
If set, prevents breaking page in the middle of the paragraph.
One of the format switch constants.
Int optional
keep_with_next
If set, prevents breaking page after the paragraph (i.e. keeps the paragraph on the same page with the next paragraph).
One of the format switch constants.
Int optional
keep_with_previous
If set, prevents breaking page before the paragraph (i.e. keeps the paragraph on the same page with the previous paragraph).
One of the format switch constants.
Paragraph_border_info
(see below)
border
Paragraph frame and border.
Int optional
shadow
Paragraph with a shadow.
(Currently not implemented)
background
Paragraph background
List_info
(see below)
list
Definition of paragraph numbering and bullets.

Tab_info

Type
Name
Description
Int
align
Tab stop alignment. One of the alignment constants.
Real
pos
Tab stop position relative to the left page margin (in cm).
Int
leader
Leading character.
(Currently not implemented).
Bool
being_moved
An internal item.

Par_border_info

Type
Name
Description
left
Left border.
top
Top border.
right
Right border.
bottom
Bottom border.
between
Border between two adjacent paragraphs provided they have the same paragraph format.
outer
Border on the outer side of the page (opposite to the binding).

List_info

Type
Name
Description
Atom optional
number_flow_id
The number flow identifier. The paragraphs with the same number flow identifier are numbered with the same sequence of numbers.
Int optional
current_level
Current indent level of the paragraph.
Int
level_count
Number of valid levels defined in the array levels.
List_level[9]
(see below)
levels
Indentation levels defined for the paragraph.
Array(optional Int, 9)
number_override
Enables to redefine the actual numbering for individual levels.

List_level

Type
Name
Description
Int optional
start_at
Original numbering value.
Int optional
numbet_type
Form of numbering. (The values are the same as with the keyword levelnfc defined in RTF).
Int optional
align
Alignment of the numbers of the paragraph numbering. One of the alignment constants. (Only the values ALIGN_LEFT, ALIGN_CENTER, and ALIGN_RIGHT are allowed.)
Int optional
indent_type
The means to indent the text next to the paragraph number. One of the following values:
0
none
1
space
2
tabulator
Rich_string optional
number_text
Text template used to number or bullet the paragraph.
Bool optional
no_restart
If set TRUE, the numbering will not be reset after the indentation was moved back to a higher level.
Real optional
tab_pos
Extraordinary tab stop set next to paragraph number for indent_type = tabulator.
Real optional
indent_first_line
The indent of the first line for paragraphs at the level.
(Used only when the user changes the paragraph level to preset new indent.)
Real optional
indent_left
Left indent for paragraphs at the level.