PageFrame#

class PageFrame[source]#

Bases: ContainerFrame

Container frame for content that should be printed on several pages (e.g. header/footer) The frame can be printed on all pages, on odd or on even pages, or an all but the first page

__init__(parent: ContainerFrame, on_page_nr: int = 0, use_full_width: bool = True, frame_id: str = '')[source]#

Creates a new PageFrame object

Parameters:

parent – Parent frame to which this frame will be added
on_page_nr – Definition on which page this frame will be printed
use_full_width – Flag if the frame may use the full width
frame_id – frame id (optional)

property use_full_width: bool#

Flag if the frame shall use the full possible width for the frame

Getter:: Returns the flag
Setter:: Sets the flag

property on_page_nr: int#

On which page the frame will be printed

Getter:: Returns the flag
Setter:: Sets the flag

property frame_id: str#

The frame id

Getter:: Returns the frame id
Setter:: Sets the frame id

property h_align: HAlign#

Horizontal alignment of the frame

Getter:: Returns the horizontal alignment of the frame
Setter:: Sets the horizontal alignment of the frame

property keep_together: bool#

Flag if the frame shall be kept together on one page

Getter:: Returns the flag
Setter:: Sets the flag

property margin_bottom: float#

Bottom margin in the frame

Getter:: Returns the bottom margin
Setter:: Sets the bottom margin

property margin_left: float#

Left margin in the frame

Getter:: Returns the left margin
Setter:: Sets the left margin

property margin_right: float#

Right margin in the frame

Getter:: Returns the right margin
Setter:: Sets the right margin

property margin_top: float#

Top margin in the frame

Getter:: Returns the top margin
Setter:: Sets the top margin

property max_height: float#

Maximal height for the frame

Getter:: Returns the maximal height
Setter:: Sets the maximal height

property max_width: float#

Maximal width for the frame

Getter:: Returns the maximal width
Setter:: Sets the maximal width

property parent_frame#

The parent frame

Getter:: Returns the parent frame
Setter:: Sets the parent frame

set_margin(margin: float)#

Sets the margin on all four sides to the given value

Parameters:: margin – Margin in mm

property use_full_height: bool#

Flag if the frame shall use the full possible height for the frame

Getter:: Returns the flag
Setter:: Sets the flag

property v_align: VAlign#

Vertical alignment of the frame

Getter:: Returns the vertical alignment of the frame
Setter:: Sets the vertical alignment of the frame