Module apps.reader.modules.readerlink

ReaderLink is an abstraction for document-specific link interfaces.

Functions

ReaderLink:isXpointerCoherent (a_xpointer) Check if a xpointer to node really points to itself
ReaderLink:getLinkFromGes (ges) Gets link from gesture.
ReaderLink:showLinkBox (link, allow_footnote_popup) Highlights a linkbox if available and goes to it.
ReaderLink:addCurrentLocationToStack () Remember current location so we can go back to it
ReaderLink:onGotoLink (link, neglect_current_location, allow_footnote_popup) Goes to link.
ReaderLink:onGoBackLink (show_notification_if_empty) Goes back to previous location.
ReaderLink:onGoToPageLink (ges, internal_links_only, max_distance) Goes to link nearest to the gesture (or first link in page)


Functions

ReaderLink:isXpointerCoherent (a_xpointer)
Check if a xpointer to node really points to itself

Parameters:

  • a_xpointer Get screen coordinates of xpointer
ReaderLink:getLinkFromGes (ges)
Gets link from gesture. Document:getLinkFromPosition() behaves differently depending on document type, so this function provides a wrapper.

Parameters:

  • ges
ReaderLink:showLinkBox (link, allow_footnote_popup)
Highlights a linkbox if available and goes to it.

Parameters:

  • link
  • allow_footnote_popup
ReaderLink:addCurrentLocationToStack ()
Remember current location so we can go back to it
ReaderLink:onGotoLink (link, neglect_current_location, allow_footnote_popup)
Goes to link. (This is called by other modules (highlight, search) to jump to a xpointer, they should not provide allowfootnotepopup=true)

Parameters:

  • link
  • neglect_current_location
  • allow_footnote_popup
ReaderLink:onGoBackLink (show_notification_if_empty)
Goes back to previous location.

Parameters:

  • show_notification_if_empty
ReaderLink:onGoToPageLink (ges, internal_links_only, max_distance)
Goes to link nearest to the gesture (or first link in page)

Parameters:

  • ges
  • internal_links_only
  • max_distance
generated by LDoc 1.4.6 Last updated 2020-09-27 21:19:13