PapersDocument.LinkDest¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new_fit` (page)
class	`new_fith` (page, top, change_top)
class	`new_fitr` (page, left, bottom, right, top)
class	`new_fitv` (page, left, change_left)
class	`new_named` (named_dest)
class	`new_page` (page)
class	`new_page_label` (page_label)
class	`new_xyz` (page, left, top, zoom, change_left, change_top, change_zoom)
	`equal` (b)
	`get_bottom` ()
	`get_dest_type` ()
	`get_left` ()
	`get_named_dest` ()
	`get_page` ()
	`get_page_label` ()
	`get_right` ()
	`get_top` ()
	`get_zoom` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`bottom`	`float`	r/w/co	The bottom coordinate
`change`	`int`	r/w/co	Wether top, left, and zoom should be changed
`left`	`float`	r/w/co	The left coordinate
`named`	`str`	r/w/co	The named destination
`page`	`int`	r/w/co	The destination page
`page-label`	`str`	r/w/co	The label of the destination page
`right`	`float`	r/w/co	The right coordinate
`top`	`float`	r/w/co	The top coordinate
`type`	`PapersDocument.LinkDestType`	r/w/co	The destination type
`zoom`	`float`	r/w/co	Zoom

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class PapersDocument.LinkDest(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: PapersDocument.LinkDestClass

classmethod new_fit(page)¶

Parameters:: page (int) –
Return type:: PapersDocument.LinkDest

classmethod new_fith(page, top, change_top)¶

Parameters:

page (int) –
top (float) –
change_top (bool) –

Return type:

PapersDocument.LinkDest

classmethod new_fitr(page, left, bottom, right, top)¶

Parameters:

page (int) –
left (float) –
bottom (float) –
right (float) –
top (float) –

Return type:

PapersDocument.LinkDest

classmethod new_fitv(page, left, change_left)¶

Parameters:

page (int) –
left (float) –
change_left (bool) –

Return type:

PapersDocument.LinkDest

classmethod new_named(named_dest)¶

Parameters:: named_dest (str) –
Return type:: PapersDocument.LinkDest

classmethod new_page(page)¶

Parameters:: page (int) –
Return type:: PapersDocument.LinkDest

classmethod new_page_label(page_label)¶

Parameters:: page_label (str) –
Return type:: PapersDocument.LinkDest

classmethod new_xyz(page, left, top, zoom, change_left, change_top, change_zoom)¶

Parameters:

page (int) –
left (float) –
top (float) –
zoom (float) –
change_left (bool) –
change_top (bool) –
change_zoom (bool) –

Return type:

PapersDocument.LinkDest

equal(b)¶

Parameters:: b (PapersDocument.LinkDest) – a PapersDocument.LinkDest
Returns:: True iff self and b are equal
Return type:: bool

Checks whether self and b are equal.

New in version 3.8.

get_bottom()¶

Return type:: float

get_dest_type()¶

Return type:: PapersDocument.LinkDestType

get_left()¶

Returns:

change_left:: whether the PPS_DEST_CHANGE_LEFT flag is set

Return type:

(float, change_left: bool)

get_named_dest()¶

Return type:: str

get_page()¶

Return type:: int

get_page_label()¶

Return type:: str

get_right()¶

Return type:: float

get_top()¶

Returns:

change_top:: whether the PPS_DEST_CHANGE_TOP flag is set

Return type:

(float, change_top: bool)

get_zoom()¶

Returns:

change_zoom:: whether the PPS_DEST_CHANGE_ZOOM flag is set

Return type:

(float, change_zoom: bool)

Property Details¶

PapersDocument.LinkDest.props.bottom¶

Name:: bottom
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The bottom coordinate

PapersDocument.LinkDest.props.change¶

Name:: change
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Wether top, left, and zoom should be changed

PapersDocument.LinkDest.props.left¶

Name:: left
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The left coordinate

PapersDocument.LinkDest.props.named¶

Name:: named
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The named destination

PapersDocument.LinkDest.props.page¶

Name:: page
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The destination page

PapersDocument.LinkDest.props.page_label¶

Name:: page-label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The label of the destination page

PapersDocument.LinkDest.props.right¶

Name:: right
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The right coordinate

PapersDocument.LinkDest.props.top¶

Name:: top
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The top coordinate

PapersDocument.LinkDest.props.type¶

Name:: type
Type:: PapersDocument.LinkDestType
Default Value:: PapersDocument.LinkDestType.UNKNOWN
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The destination type

PapersDocument.LinkDest.props.zoom¶

Name:: zoom
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Zoom