Class Link

Hierarchy

Link

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Link(type: LinkType, book_link: Devhelp.Link, name: string, relative_url: string): Devhelp.Link

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3231
Parameters
- type: LinkType
- book_link: Devhelp.Link
- name: string
- relative_url: string
Returns Devhelp.Link

Properties

Static name

name: string

Methods

belongs_to_page

belongs_to_page(page_id: string): boolean

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3186
This function permits to know if link belongs to a certain page.

page_id is usually the HTML filename without the .html extension. More generally, page_id must be a relative URL (relative to the book base path), without the anchor nor the file extension.

For example if link has the relative URL "DhLink.html#dh-link-ref", then this function will return %TRUE if the page_id is "DhLink".

Parameters
- page_id: string
  
  a page ID, i.e. the filename without its extension.
Returns boolean

compare

compare(b: Devhelp.Link): number

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3192
Compares the links a and b. This function is used to determine in which order the links should be displayed.

Parameters
- b: Devhelp.Link
  
  a #DhLink.
Returns number

get_book_id

get_book_id(): string

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3193
Returns string

get_book_title

get_book_title(): string

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3194
Returns string

get_flags

get_flags(): LinkFlags

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3195
Returns LinkFlags

get_link_type

get_link_type(): LinkType

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3196
Returns LinkType

get_name

get_name(): string

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3197
Returns string

get_uri

get_uri(): string

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3202
Gets the link URI, by concateneting the book base path with the link relative URL.

Returns string

match_relative_url

match_relative_url(relative_url: string): boolean

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3203
Parameters
- relative_url: string
Returns boolean

ref

ref(): Devhelp.Link

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3209
Increases the reference count of link.

Not thread-safe.

Returns Devhelp.Link

set_flags

set_flags(flags: LinkFlags): void

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3214
Sets the flags of the link.

Parameters
- flags: LinkFlags
  
  the new flags of the link.
Returns void

unref

unref(): void

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3220
Decreases the reference count of link.

Not thread-safe.

Returns void

Static new

new(type: LinkType, book_link: Devhelp.Link, name: string, relative_url: string): Devhelp.Link

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3232
Parameters
- type: LinkType
- book_link: Devhelp.Link
- name: string
- relative_url: string
Returns Devhelp.Link

Static new_book

new_book(base_path: string, book_id: string, book_title: string, relative_url: string): Devhelp.Link

- Defined in @types/Gjs/Devhelp-3.0.d.ts:3233
Parameters
- base_path: string
- book_id: string
- book_title: string
- relative_url: string
Returns Devhelp.Link