epuBear SDK (MAUI)
 
Loading...
Searching...
No Matches
epuBear.SDK.Callbacks Class Reference

Public Member Functions

delegate void ContentUpdatedCallback (EPUBBitmapPosition position)
 This callback is called by the SDK when a page is drawn.
 
delegate void ContentUpdatedWithBoundsCallback (EPUBBitmapPosition position, RectangleF bounds)
 This callback is called by the SDK when a page is drawn.
 
delegate void ChapterLoadingStartedCallback ()
 This callback is called by the SDK when a new chapter started loading.
 
delegate void LinkClickedCallback (string link)
 This callback is called by the SDK when a link ("link" HTML tag) in the book is clicked.
 
delegate void RemarkClickedCallback (string link)
 This callback is called by the SDK when a remark ("a" HTML tag) in the book is clicked.
 
delegate void LoadedChapterWithIndexCallback (int index)
 This callback is called by the SDK when a chapter is loaded.
 
delegate void SearchFinishedCallback (string text, Dictionary< int, List< RectangleF > > results)
 This callback is called by the SDK when a search through the book is finished.
 
delegate void SearchFinishedInChapterCallback (int chapterIndex, string text, Dictionary< int, List< RectangleF > > results)
 This callback is called by the SDK when a search through a chapter is finished.
 
delegate void PagesCountedCallback (int totalCount)
 This callback is called by the SDK when it counts the total page count of the book.
 
delegate void ImageListenerCallback (object image, bool isBackground)
 This callback is called by the SDK when an image is clicked.
 
delegate void BookmarkFoundOnPageCallback ()
 This callback is called by the SDK when a bookmark leading to the current page is found on the opened page.
 
delegate void CfiesHighlightingCallback (HighlightBox[] highlightBoxes)
 This callback is called by the SDK when a CFI region is found on the current page.
 

Public Attributes

ContentUpdatedCallback ContentUpdated
 This callback is called by the SDK when a page is drawn.
 
ContentUpdatedWithBoundsCallback ContentUpdatedWithBounds
 This callback is called by the SDK when a page is drawn.
 
ChapterLoadingStartedCallback ChapterLoadingStarted
 This callback is called by the SDK when a new chapter started loading.
 
LinkClickedCallback LinkClicked
 This callback is called by the SDK when a link in the book is clicked.
 
RemarkClickedCallback RemarkClicked
 This callback is called by the SDK when a remark in the book is clicked.
 
LoadedChapterWithIndexCallback LoadedChapterWithIndex
 This callback is called by the SDK when a chapter is loaded.
 
SearchFinishedCallback SearchFinished
 This callback is called by the SDK when a search through the book is finished.
 
SearchFinishedInChapterCallback SearchFinishedInChapter
 This callback is called by the SDK when a search through a chapter is finished.
 
PagesCountedCallback PagesCounted
 This callback is called by the SDK when it counts the total page count of the book.
 
ImageListenerCallback ImageClick
 This callback is called by the SDK when an image is clicked.
 
BookmarkFoundOnPageCallback BookmarkFoundOnPage
 This callback is called by the SDK when a bookmark leading to the current page is found on the opened page.
 
CfiesHighlightingCallback CfiesHighlighting
 This callback is called by the SDK when a CFI region is found on the current page.
 

Member Function Documentation

◆ BookmarkFoundOnPageCallback()

delegate void epuBear.SDK.Callbacks.BookmarkFoundOnPageCallback ( )

This callback is called by the SDK when a bookmark leading to the current page is found on the opened page.

See CreateBookmark for mode information.

◆ CfiesHighlightingCallback()

delegate void epuBear.SDK.Callbacks.CfiesHighlightingCallback ( HighlightBox[]  highlightBoxes)

This callback is called by the SDK when a CFI region is found on the current page.

This is useful for save text highlights. See CreateCfiSelectedText for more information.

Parameters
highlightBoxesAnn array of HighlightBox. Each entry represents a highlighted text region.

◆ ContentUpdatedCallback()

delegate void epuBear.SDK.Callbacks.ContentUpdatedCallback ( EPUBBitmapPosition  position)

This callback is called by the SDK when a page is drawn.

You can use Bitmap contents of that page in the app. Note that there are three pages that SDK works with. This callback is usually only called for a new page.For example, when OpenNextPage copies the center page to the left, the right page to the center, then only updates the right page and calls this callback for the right page. OpenPreviousPage acts the same for the left page. If you use OpenPage, OpenChapter or a similar call, all three pages will be drawn and this callback will be called multiple times. Note that on the first page of the book only center and right pages updated, and at the end of the book only left and center pages are updated.

Parameters
positionPosition of the page that was drawn: left, center ot right.

◆ ContentUpdatedWithBoundsCallback()

delegate void epuBear.SDK.Callbacks.ContentUpdatedWithBoundsCallback ( EPUBBitmapPosition  position,
RectangleF  bounds 
)

This callback is called by the SDK when a page is drawn.

You can use Bitmap contents of that page in the app. Note that there are three pages that SDK works with. This callback is usually only called for a new page.For example, when OpenNextPage copies the center page to the left, the right page to the center, then only updates the right page and calls this callback for the right page. OpenPreviousPage acts the same for the left page. If you use OpenPage, OpenChapter or a similar call, all three pages will be drawn and this callback will be called multiple times. Note that on the first page of the book only center and right pages updated, and at the end of the book only left and center pages are updated. Same as ContentUpdatedCallback, but this callback also has a region rectangle. Real height may differ page to page. At the end of the chapter resulting image may me shorter than the rest. Intended use of this callback is the following: scrolling view, populated with images of the pages, attached together.

Parameters
positionPosition of the page that was drawn: left, center ot right.
boundsPage size.

◆ ImageListenerCallback()

delegate void epuBear.SDK.Callbacks.ImageListenerCallback ( object  image,
bool  isBackground 
)

This callback is called by the SDK when an image is clicked.

See TouchDown, TouchMove and TouchUp.

Parameters
imagePath to the image within the book.
isBackgroundA flag of wether the image is considered to be a background image.

◆ LinkClickedCallback()

delegate void epuBear.SDK.Callbacks.LinkClickedCallback ( string  link)

This callback is called by the SDK when a link ("link" HTML tag) in the book is clicked.

Use EnableOpeningURLs to control this behavior.

Parameters
linkLink address.

◆ LoadedChapterWithIndexCallback()

delegate void epuBear.SDK.Callbacks.LoadedChapterWithIndexCallback ( int  index)

This callback is called by the SDK when a chapter is loaded.

This happens for all chapters when a book is first opened or the font size is changed. After that it happens with the progress of the book.

Parameters
indexChapter index, starting from 0.

◆ PagesCountedCallback()

delegate void epuBear.SDK.Callbacks.PagesCountedCallback ( int  totalCount)

This callback is called by the SDK when it counts the total page count of the book.

This happens after you open a book or change the font size, line spacing of default styles. It may take a long time to calculate.

Parameters
totalCountTotal page count of the book for the current settings.

◆ RemarkClickedCallback()

delegate void epuBear.SDK.Callbacks.RemarkClickedCallback ( string  link)

This callback is called by the SDK when a remark ("a" HTML tag) in the book is clicked.

Parameters
linkLink address.

◆ SearchFinishedCallback()

delegate void epuBear.SDK.Callbacks.SearchFinishedCallback ( string  text,
Dictionary< int, List< RectangleF > >  results 
)

This callback is called by the SDK when a search through the book is finished.

Parameters
textThe text that was being searched for.
resultsList of findings, containing page numbers and region rectangles of the entries.

◆ SearchFinishedInChapterCallback()

delegate void epuBear.SDK.Callbacks.SearchFinishedInChapterCallback ( int  chapterIndex,
string  text,
Dictionary< int, List< RectangleF > >  results 
)

This callback is called by the SDK when a search through a chapter is finished.

Parameters
chapterIndexChapter index, starting from 0.
textThe text that was being searched for.
resultsList of findings, containing page numbers and region rectangles of the entries.

Member Data Documentation

◆ BookmarkFoundOnPage

BookmarkFoundOnPageCallback epuBear.SDK.Callbacks.BookmarkFoundOnPage

This callback is called by the SDK when a bookmark leading to the current page is found on the opened page.

See CreateBookmark for mode information. See BookmarkFoundOnPageCallback.

◆ CfiesHighlighting

CfiesHighlightingCallback epuBear.SDK.Callbacks.CfiesHighlighting

This callback is called by the SDK when a CFI region is found on the current page.

This is useful for save text highlights. See CreateCfiSelectedText for more information. See CfiesHighlightingCallback.

◆ ContentUpdated

ContentUpdatedCallback epuBear.SDK.Callbacks.ContentUpdated

This callback is called by the SDK when a page is drawn.

You can use Bitmap contents of that page in the app. Note that there are three pages that SDK works with. This callback is usually only called for a new page.For example, when OpenNextPage copies the center page to the left, the right page to the center, then only updates the right page and calls this callback for the right page. OpenPreviousPage acts the same for the left page. If you use OpenPage, OpenChapter or a similar call, all three pages will be drawn and this callback will be called multiple times. Note that on the first page of the book only center and right pages updated, and at the end of the book only left and center pages are updated. See ContentUpdatedCallback.

◆ ContentUpdatedWithBounds

ContentUpdatedWithBoundsCallback epuBear.SDK.Callbacks.ContentUpdatedWithBounds

This callback is called by the SDK when a page is drawn.

You can use Bitmap contents of that page in the app. Note that there are three pages that SDK works with. This callback is usually only called for a new page.For example, when OpenNextPage copies the center page to the left, the right page to the center, then only updates the right page and calls this callback for the right page. OpenPreviousPage acts the same for the left page. If you use OpenPage, OpenChapter or a similar call, all three pages will be drawn and this callback will be called multiple times. Note that on the first page of the book only center and right pages updated, and at the end of the book only left and center pages are updated. Same as ContentUpdatedCallback, but this callback also has a region rectangle. Real height may differ page to page. At the end of the chapter resulting image may me shorter than the rest. Intended use of this callback is the following: scrolling view, populated with images of the pages, attached together. See ContentUpdatedWithBoundsCallback.

◆ ImageClick

ImageListenerCallback epuBear.SDK.Callbacks.ImageClick

This callback is called by the SDK when an image is clicked.

See TouchDown, TouchMove and TouchUp. See ImageListenerCallback.

◆ LinkClicked

LinkClickedCallback epuBear.SDK.Callbacks.LinkClicked

This callback is called by the SDK when a link in the book is clicked.

Use EnableOpeningURLs to control this behavior. See LinkClickedCallback.

◆ LoadedChapterWithIndex

LoadedChapterWithIndexCallback epuBear.SDK.Callbacks.LoadedChapterWithIndex

This callback is called by the SDK when a chapter is loaded.

This happens for all chapters when a book is first opened or the font size is changed. After that it happens with the progress of the book. See LoadedChapterWithIndexCallback.

◆ PagesCounted

PagesCountedCallback epuBear.SDK.Callbacks.PagesCounted

This callback is called by the SDK when it counts the total page count of the book.

This happens after you open a book or change the font size, line spacing of default styles. It may take a long time to calculate. See PagesCountedCallback.

◆ RemarkClicked

RemarkClickedCallback epuBear.SDK.Callbacks.RemarkClicked

This callback is called by the SDK when a remark in the book is clicked.

See RemarkClickedCallback.

◆ SearchFinished

SearchFinishedCallback epuBear.SDK.Callbacks.SearchFinished

This callback is called by the SDK when a search through the book is finished.

See SearchFinishedCallback.

◆ SearchFinishedInChapter

SearchFinishedInChapterCallback epuBear.SDK.Callbacks.SearchFinishedInChapter

This callback is called by the SDK when a search through a chapter is finished.

See SearchFinishedInChapterCallback.


The documentation for this class was generated from the following file: