.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.html.HtmlBookRecord:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlBookRecord**
==========================================================================================================================================
Helper class for :ref:`wx.html.HtmlHelpData`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HtmlBookRecord:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlBookRecord.__init__`
:meth:`~wx.html.HtmlBookRecord.GetBasePath`
:meth:`~wx.html.HtmlBookRecord.GetBookFile`
:meth:`~wx.html.HtmlBookRecord.GetContentsEnd`
:meth:`~wx.html.HtmlBookRecord.GetContentsStart`
:meth:`~wx.html.HtmlBookRecord.GetFullPath`
:meth:`~wx.html.HtmlBookRecord.GetStart`
:meth:`~wx.html.HtmlBookRecord.GetTitle`
:meth:`~wx.html.HtmlBookRecord.SetBasePath`
:meth:`~wx.html.HtmlBookRecord.SetContentsRange`
:meth:`~wx.html.HtmlBookRecord.SetStart`
:meth:`~wx.html.HtmlBookRecord.SetTitle`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlBookRecord.BasePath` See :meth:`~wx.html.HtmlBookRecord.GetBasePath` and :meth:`~wx.html.HtmlBookRecord.SetBasePath`
:attr:`~wx.html.HtmlBookRecord.BookFile` See :meth:`~wx.html.HtmlBookRecord.GetBookFile`
:attr:`~wx.html.HtmlBookRecord.ContentsEnd` See :meth:`~wx.html.HtmlBookRecord.GetContentsEnd`
:attr:`~wx.html.HtmlBookRecord.ContentsStart` See :meth:`~wx.html.HtmlBookRecord.GetContentsStart`
:attr:`~wx.html.HtmlBookRecord.Start` See :meth:`~wx.html.HtmlBookRecord.GetStart` and :meth:`~wx.html.HtmlBookRecord.SetStart`
:attr:`~wx.html.HtmlBookRecord.Title` See :meth:`~wx.html.HtmlBookRecord.GetTitle` and :meth:`~wx.html.HtmlBookRecord.SetTitle`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlBookRecord(object)
**Possible constructors**::
HtmlBookRecord(bookfile : str, basepath : str, title : str, start : str)
-> None
Helper class for HtmlHelpData.
.. method:: __init__(self, bookfile : str, basepath : str, title : str, start : str)
:param `bookfile`:
:type `bookfile`: string
:param `basepath`:
:type `basepath`: string
:param `title`:
:type `title`: string
:param `start`:
:type `start`: string
:rtype: `None`
.. method:: GetBasePath(self)
:rtype: `str`
.. method:: GetBookFile(self)
:rtype: `str`
.. method:: GetContentsEnd(self)
:rtype: `int`
.. method:: GetContentsStart(self)
:rtype: `int`
.. method:: GetFullPath(self, page : str)
:param `page`:
:type `page`: string
:rtype: `str`
.. method:: GetStart(self)
:rtype: `str`
.. method:: GetTitle(self)
:rtype: `str`
.. method:: SetBasePath(self, path : str)
:param `path`:
:type `path`: string
:rtype: `None`
.. method:: SetContentsRange(self, start : int, end : int)
:param `start`:
:type `start`: int
:param `end`:
:type `end`: int
:rtype: `None`
.. method:: SetStart(self, start : str)
:param `start`:
:type `start`: string
:rtype: `None`
.. method:: SetTitle(self, title : str)
:param `title`:
:type `title`: string
:rtype: `None`
.. attribute:: BasePath
See :meth:`~wx.html.HtmlBookRecord.GetBasePath` and :meth:`~wx.html.HtmlBookRecord.SetBasePath`
.. attribute:: BookFile
See :meth:`~wx.html.HtmlBookRecord.GetBookFile`
.. attribute:: ContentsEnd
See :meth:`~wx.html.HtmlBookRecord.GetContentsEnd`
.. attribute:: ContentsStart
See :meth:`~wx.html.HtmlBookRecord.GetContentsStart`
.. attribute:: Start
See :meth:`~wx.html.HtmlBookRecord.GetStart` and :meth:`~wx.html.HtmlBookRecord.SetStart`
.. attribute:: Title
See :meth:`~wx.html.HtmlBookRecord.GetTitle` and :meth:`~wx.html.HtmlBookRecord.SetTitle`