PapersDocument.LinkAction¶

Subclasses:: None

Methods¶

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

class	`new_dest` (dest)
class	`new_external_uri` (uri)
class	`new_launch` (filename, params)
class	`new_layers_state` (show_list, hide_list, toggle_list)
class	`new_named` (name)
class	`new_remote` (dest, filename)
class	`new_reset_form` (fields, exclude_fields)
	`equal` (b)
	`get_action_type` ()
	`get_dest` ()
	`get_exclude_reset_fields` ()
	`get_filename` ()
	`get_hide_list` ()
	`get_name` ()
	`get_params` ()
	`get_reset_fields` ()
	`get_show_list` ()
	`get_toggle_list` ()
	`get_uri` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`dest`	`PapersDocument.LinkDest`	r/w/co	The link action destination
`exclude-reset-fields`	`bool`	r/w/co	Whether to exclude/include reset-fields when resetting form
`filename`	`str`	r/w/co	The link action filename
`hide-list`	`int`	r/w/co	The list of layers that should be hidden
`name`	`str`	r/w/co	The link action name
`params`	`str`	r/w/co	The link action params
`reset-fields`	`int`	r/w/co	The list of fields that should be/should not be reset
`show-list`	`int`	r/w/co	The list of layers that should be shown
`toggle-list`	`int`	r/w/co	The list of layers that should be toggled
`type`	`PapersDocument.LinkActionType`	r/w/co	The link action type
`uri`	`str`	r/w/co	The link action URI

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class PapersDocument.LinkAction(**kwargs)¶

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

classmethod new_dest(dest)¶

Parameters:: dest (PapersDocument.LinkDest) –
Return type:: PapersDocument.LinkAction

classmethod new_external_uri(uri)¶

Parameters:: uri (str) –
Return type:: PapersDocument.LinkAction

classmethod new_launch(filename, params)¶

Parameters:

filename (str) –
params (str) –

Return type:

PapersDocument.LinkAction

classmethod new_layers_state(show_list, hide_list, toggle_list)¶

Parameters:

show_list ([PapersDocument.Layer]) – a list of PapersDocument.Layer objects
hide_list ([PapersDocument.Layer]) – a list of PapersDocument.Layer objects
toggle_list ([PapersDocument.Layer]) – a list of PapersDocument.Layer objects

Returns:

a new PapersDocument.LinkAction

Return type:

PapersDocument.LinkAction

classmethod new_named(name)¶

Parameters:: name (str) –
Return type:: PapersDocument.LinkAction

classmethod new_remote(dest, filename)¶

Parameters:

dest (PapersDocument.LinkDest) –
filename (str) –

Return type:

PapersDocument.LinkAction

classmethod new_reset_form(fields, exclude_fields)¶

Parameters:

fields ([str]) – a list of fields to reset
exclude_fields (bool) – whether to exclude reset fields when resetting form

Returns:

a new PapersDocument.LinkAction

Return type:

PapersDocument.LinkAction

equal(b)¶

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

Checks whether self and b are equal.

New in version 3.8.

get_action_type()¶

Return type:: PapersDocument.LinkActionType

get_dest()¶

Returns:: an PapersDocument.LinkDest
Return type:: PapersDocument.LinkDest

get_exclude_reset_fields()¶

Returns:: whether to exclude reset fields when resetting form
Return type:: bool

get_filename()¶

Return type:: str

get_hide_list()¶

Returns:: a list of PapersDocument.Layer objects
Return type:: [PapersDocument.Layer]

get_name()¶

Return type:: str

get_params()¶

Return type:: str

get_reset_fields()¶

Returns:: a list of fields to reset
Return type:: [str]

get_show_list()¶

Returns:: a list of PapersDocument.Layer objects
Return type:: [PapersDocument.Layer]

get_toggle_list()¶

Returns:: a list of PapersDocument.Layer objects
Return type:: [PapersDocument.Layer]

get_uri()¶

Return type:: str

Property Details¶

PapersDocument.LinkAction.props.dest¶

Name:: dest
Type:: PapersDocument.LinkDest
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The link action destination

PapersDocument.LinkAction.props.exclude_reset_fields¶

Name:: exclude-reset-fields
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether to exclude/include reset-fields when resetting form

PapersDocument.LinkAction.props.filename¶

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

The link action filename

PapersDocument.LinkAction.props.hide_list¶

Name:: hide-list
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The list of layers that should be hidden

PapersDocument.LinkAction.props.name¶

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

The link action name

PapersDocument.LinkAction.props.params¶

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

The link action params

PapersDocument.LinkAction.props.reset_fields¶

Name:: reset-fields
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The list of fields that should be/should not be reset

PapersDocument.LinkAction.props.show_list¶

Name:: show-list
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The list of layers that should be shown

PapersDocument.LinkAction.props.toggle_list¶

Name:: toggle-list
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The list of layers that should be toggled

PapersDocument.LinkAction.props.type¶

Name:: type
Type:: PapersDocument.LinkActionType
Default Value:: PapersDocument.LinkActionType.GOTO_DEST
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The link action type

PapersDocument.LinkAction.props.uri¶

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

The link action URI