This commit is contained in:
John Whitington
2022-08-10 19:07:58 +01:00
parent c80c363f34
commit ce1601705b
21 changed files with 1638 additions and 789 deletions

View File

@ -1,54 +1,86 @@
// CHAPTER 6. Bookmarks
/** Starts the bookmark retrieval process for a given PDF. */
function startGetBookmarkInfo(pdf)
/** Starts the bookmark retrieval process for a given PDF.
@arg {pdf} pdf PDF document */
function startGetBookmarkInfo(pdf) {}
/** Gets the number of bookmarks for the PDF given to startGetBookmarkInfo. */
function numberBookmarks()
/** Gets the number of bookmarks for the PDF given to startGetBookmarkInfo.
@return {number} number of bookmarks */
function numberBookmarks() {}
/** Gets the bookmark level for the given bookmark (0...(n - 1)). */
function getBookmarkLevel(n)
/** Gets the bookmark level for the given bookmark (0...(n - 1)).
@arg {number} n serial number
@return {number} bookmark level */
function getBookmarkLevel(n) {}
/** Gets the bookmark target page for the given PDF (which must be the same
as the PDF passed to startSetBookmarkInfo) and bookmark (0...(n - 1)). */
function getBookmarkPage(pdf, n)
as the PDF passed to startSetBookmarkInfo) and bookmark (0...(n - 1)).
@arg {pdf} pdf PDF document
@arg {number} n serial number
@return {number} bookmark page */
function getBookmarkPage(pdf, n) {}
/** Returns the text of bookmark (0...(n - 1)). */
function getBookmarkText(n)
/** Returns the text of bookmark (0...(n - 1)).
@arg {number} n serial number
@return {string} bookmark text */
function getBookmarkText(n) {}
/** True if the bookmark is open. */
function getBookmarkOpenStatus(n)
/** True if the bookmark is open.
@arg {number} n serial number
@return {boolean} open status */
function getBookmarkOpenStatus(n) {}
/** Ends the bookmark retrieval process, cleaning up. */
function endGetBookmarkInfo()
function endGetBookmarkInfo() {}
/** Starts the bookmark setting process for n bookmarks. */
function startSetBookmarkInfo(n)
/** Starts the bookmark setting process for n bookmarks.
@arg {number} n number of bookmarks required */
function startSetBookmarkInfo(n) {}
/** Set bookmark level for the given bookmark (0...(n - 1)). */
function setBookmarkLevel(a, b)
/** Set bookmark level for the given bookmark (0...(n - 1)).
@arg {number} n serial number
@arg {number} level bookmark level */
function setBookmarkLevel(n, level) {}
/** Sets the bookmark target page for the given PDF (which must be the same as
the PDF to be passed to endSetBookmarkInfo) and bookmark (0...(n - 1)). */
function setBookmarkPage(pdf, a, b)
the PDF to be passed to endSetBookmarkInfo) and bookmark (0...(n - 1)).
@arg {pdf} pdf PDF document
@arg {number} n serial number
@arg {number} targetpage target page */
function setBookmarkPage(pdf, n, targetpage) {}
/** Sets the open status of bookmark (0...(n - 1)). */
function setBookmarkOpenStatus(a, b)
/** Sets the open status of bookmark (0...(n - 1)).
@arg {number} n serial number
@arg {boolean} status open status */
function setBookmarkOpenStatus(n, status) {}
/** Sets the text of bookmark (0...(n - 1)). */
function setBookmarkText(n, t)
/** Sets the text of bookmark (0...(n - 1)).
@arg {number} n serial number
@arg {string} text bookmark text */
function setBookmarkText(n, text) {}
/** Ends the bookmark setting process, writing the bookmarks to the given
PDF. */
function endSetBookmarkInfo(pdf)
PDF.
@arg {pdf} pdf PDF document */
function endSetBookmarkInfo(pdf) {}
/** Returns the bookmark data in JSON format. */
function getBookmarksJSON(pdf)
/** Returns the bookmark data in JSON format.
@arg {pdf} pdf PDF document
@result {Uint8Array} result as a byte array */
function getBookmarksJSON(pdf) {}
/** Sets the bookmarks from JSON bookmark data. */
function setBookmarksJSON(pdf, data)
/** Sets the bookmarks from JSON bookmark data.
@arg {pdf} pdf PDF document
@arg {Uint8Array} byte array of JSON bookmark data */
function setBookmarksJSON(pdf, data) {}
/** Typesets a table of contents from existing bookmarks and prepends it to
the document. If bookmark is set, the table of contents gets its own
bookmark. */
function tableOfContents(pdf, font, fontsize, title, bookmark)
bookmark.
@arg {pdf} pdf PDF document
@arg {font} font font
@arg {number} fontsize font size
@arg {string} title title
@arg {boolean} bookmark table of contents gets its own bookmark */
function tableOfContents(pdf, font, fontsize, title, bookmark) {}