Gnm.PageBreaks

Fields

Name

Type

Access

Description

details

[object]

r/w

is_vert

bool

r/w

Methods

class

new (is_vert)

append_break (pos, type)

clean ()

dup ()

dup_non_auto_breaks ()

free ()

get_break (pos)

get_next_break (pos)

get_next_manual_break (pos)

set_break (pos, type)

Details

class Gnm.PageBreaks
classmethod new(is_vert)
Parameters:

is_vert (bool) –

Return type:

Gnm.PageBreaks

Allocate a collection of page breaks.

append_break(pos, type)
Parameters:
Return type:

bool

clean()

Remove all auto page breaks

dup()
Returns:

A duplicate Gnm.PageBreak.

Return type:

Gnm.PageBreaks or None

dup_non_auto_breaks()
Returns:

A duplicate Gnm.PageBreak, but containing only non-auto page breaks.

Return type:

Gnm.PageBreaks or None

free()
get_break(pos)
Parameters:

pos (int) –

Return type:

Gnm.PageBreakType

get_next_break(pos)
Parameters:

pos (int) –

Return type:

int

get_next_manual_break(pos)
Parameters:

pos (int) –

Return type:

int

set_break(pos, type)
Parameters:
Return type:

bool