Gnm.HLink¶

Subclasses:: Gnm.HLinkCurWB, Gnm.HLinkExternal, Gnm.HLinkURL

Methods¶

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

class	`new` (typ, sheet)
	`activate` (wbcg)
	`dup_to` (sheet)
	`equal` (b, relax_sheet)
	`get_range_target` ()
	`get_sheet` ()
	`get_target` ()
	`get_target_expr` ()
	`get_tip` ()
	`set_target` (url)
	`set_tip` (tip)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_Activate` (wbcg)
	`do_get_target` ()
	`do_set_target` (target)

Properties¶

Name	Type	Flags	Short Description
`sheet`	`Gnm.Sheet`	w/co	The sheet in which the link lives

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
obj	`GObject.Object`	r
sheet	`Gnm.Sheet`	r
target	`str`	r
tip	`str`	r

Class Details¶

class Gnm.HLink(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Gnm.HLinkClass

classmethod new(typ, sheet)¶

Parameters:

typ (GObject.GType) –
sheet (Gnm.Sheet) –

Return type:

Gnm.HLink

activate(wbcg)¶

Parameters:: wbcg (Gnm.WBCGtk) – the wbcg that activated the link
Returns:: True if the link successfully activated.
Return type:: bool

dup_to(sheet)¶

Parameters:: sheet (Gnm.Sheet) – target sheet
Returns:: A duplicate link.
Return type:: Gnm.HLink

equal(b, relax_sheet)¶

Parameters:

b (Gnm.HLink) – a Gnm.HLink
relax_sheet (bool) – if True, ignore differences solely caused by being linked into different sheets.

Returns:

True, if links are equal

Return type:

bool

get_range_target()¶

Returns:

True, if the link refers to a range.

sr:: location to store link target range

Return type:

(bool, sr: Gnm.SheetRange)

This function determines the location that a link points to. It will resolve names.

get_sheet()¶

Returns:: the sheet
Return type:: Gnm.Sheet

get_target()¶

Returns:: self's target.
Return type:: str

get_target_expr()¶

Returns:: A Gnm.ExprTop describing the target.
Return type:: Gnm.ExprTop or None

This function determines the location that a link points to.

get_tip()¶

Returns:: self's tooltip.
Return type:: str

set_target(url)¶

Parameters:: url (str) –

set_tip(tip)¶

Parameters:: tip (str) –

do_Activate(wbcg) virtual¶

Parameters:: wbcg (Gnm.WBCGtk) –
Return type:: bool

do_get_target() virtual¶

Returns:: lnk's target.
Return type:: str

do_set_target(target) virtual¶

Parameters:: target (str) –

Property Details¶

Gnm.HLink.props.sheet¶

Name:: sheet
Type:: Gnm.Sheet
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The sheet in which the link lives