Class: Gnm::HLink

Inherits:

Object

• Object
• Gnm::HLink

Defined in:

(unknown)

Direct Known Subclasses

HLinkCurWB, HLinkExternal, HLinkURL

Class Method Summary

• .init_ ⇒ nil

Instance Method Summary

• #activate(wbcg) ⇒ Boolean

  True if the link successfully activated.

• #dup_to(sheet) ⇒ Gnm::HLink

  A duplicate link.

• #equal(b, relax_sheet) ⇒ Boolean

  True, if links are equal.

• #get_range_target(sr) ⇒ Boolean

  This function determines the location that a link points to.

• #initialize(typ, sheet) ⇒ Gnm::HLink constructor
• #sheet ⇒ Gnm::Sheet

  The sheet.

• #sheet=(sheet) ⇒ Gnm::Sheet

  Sheet.

• #target ⇒ String

  lnk's target.

• #target=(url) ⇒ nil
• #target_expr ⇒ Gnm::ExprTop

  This function determines the location that a link points to.

• #tip ⇒ String

  lnk's tooltip.

• #tip=(tip) ⇒ nil

Constructor Details

#initialize(typ, sheet) ⇒ Gnm::HLink

Parameters:

• typ (GLib::Type)
• sheet (Gnm::Sheet)

Class Method Details

.init_ ⇒ nil

Returns:

• (nil)

Instance Method Details

#activate(wbcg) ⇒ Boolean

Returns true if the link successfully activated.

Parameters:

• wbcg (Gnm::WBCGtk) —

  the wbcg that activated the link

Returns:

• (Boolean) —

  true if the link successfully activated.

#dup_to(sheet) ⇒ Gnm::HLink

Returns A duplicate link.

Parameters:

• sheet (Gnm::Sheet) —

  target sheet

Returns:

• (Gnm::HLink) —

  A duplicate link.

#equal(b, relax_sheet) ⇒ Boolean

Returns true, if links are equal.

Parameters:

• b (Gnm::HLink) —

  a Gnm::HLink

• relax_sheet (Boolean) —

  if true, ignore differences solely caused by being linked into different sheets.

Returns:

• (Boolean) —

  true, if links are equal

#get_range_target(sr) ⇒ Boolean

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

Parameters:

• sr (Gnm::SheetRange) —

  location to store link target range

Returns:

• (Boolean) —

  true, if the link refers to a range.

#sheet ⇒ Gnm::Sheet

Returns the sheet.

Returns:

• (Gnm::Sheet) —

  the sheet

#sheet=(sheet) ⇒ Gnm::Sheet

Returns sheet.

Parameters:

• sheet (Gnm::Sheet)

Returns:

• (Gnm::Sheet) —

  sheet

#target ⇒ String

Returns lnk's target.

Returns:

• (String) —

  lnk's target.

#target=(url) ⇒ nil

Parameters:

• url (String)

Returns:

• (nil)

#target_expr ⇒ Gnm::ExprTop

This function determines the location that a link points to.

Returns:

• (Gnm::ExprTop) —

  A Gnm::ExprTop describing the target.

#tip ⇒ String

Returns lnk's tooltip.

Returns:

• (String) —

  lnk's tooltip.

#tip=(tip) ⇒ nil

Parameters:

• tip (String)

Returns:

• (nil)