This class is used by HtmlHelpController to display help. It is an internal class and should not be used directly – except for the case when you’re writing your own HTML help controller.
HtmlHelpFrame.new(HtmlHelpData data = nil)HtmlHelpFrame.new(Window parent, Integer WindowID,
String title = '',
Integer style = HF_DEFAULT_STYLE,
HtmlHelpData data = nil)Constructor.
style is combination of these flags:
HF_TOOLBAR |
Help frame has toolbar. | |||||
HF_FLAT_TOOLBAR |
Help frame has toolbar with flat buttons (aka coolbar). | |||||
HF_CONTENTS |
Help frame has contents panel. | |||||
HF_INDEX |
Help frame has index panel. | |||||
HF_SEARCH |
Help frame has search panel. | |||||
HF_BOOKMARKS |
Help frame has bookmarks controls. | |||||
HF_OPEN_FILES |
Allow user to open arbitrary HTML document. | |||||
HF_PRINT |
Toolbar contains “print” button. | |||||
HF_MERGE_BOOKS |
Contents pane does not showbook nodes. All books are merged together and appear as single book to theuser. | |||||
HF_ICONS_BOOK |
All nodes in contents panehave a book icon. This is how Microsoft’s HTML help viewer behaves. | |||||
HF_ICONS_FOLDER |
Book nodes in contents pane havea book icon, book’s sections have a folder icon. This is the default. | |||||
HF_ICONS_BOOK_CHAPTER |
Both book nodes andnodes of top-level sections of a book (i.e. chapters) have a book icon,all other sections (sections, subsections, ...) have a folder icon. | |||||
HF_DEFAULT_STYLE |
@HF_TOOLBAR | HF_CONTENTS | HF_INDEX | HF_SEARCH | HF_BOOKMARKS | HF_PRINT@ |
Boolean create(Window parent, Integer id, String title = '',
Integer style = HF_DEFAULT_STYLE)Creates the frame. See the constructor for parameters description.
create_contents()Creates contents panel. (May take some time.)
Protected.
create_index()Creates index panel. (May take some time.)
Protected.
create_search()Creates search panel.
Boolean display(String x)Boolean display(Integer id)Displays page x. If not found it will give the user the choice of searching books. Looking for the page runs in these steps:
The second form takes numeric ID as the parameter. (uses extension to MS format, )
Boolean display_contents()Displays contents panel.
Boolean display_index()Displays index panel.
HtmlHelpData get_data()Return HtmlHelpData object.
Boolean keyword_search(String keyword,
HelpSearchMode mode = HELP_SEARCH_ALL)Search for given keyword. Optionally it searches through the index (mode = HELP_SEARCH_INDEX), default the content (mode = HELP_SEARCH_ALL).
read_customization(ConfigBase cfg, String path = '')Reads user’s settings for this frame (see HtmlHelpController#read_customization)
refresh_lists()Refresh all panels. This is necessary if a new book was added.
Protected.
set_title_format(String format)Sets the frame’s title format. format must contain exactly one ”\%s” (it will be replaced by the page title).
use_config(ConfigBase config, String rootpath = '')Add books to search choice panel.
write_customization(ConfigBase cfg, String path = '')Saves user’s settings for this frame (see HtmlHelpController#write_customization).
add_toolbar_buttons(ToolBar toolBar, Integer style)You may override this virtual method to add more buttons into help frame’s toolbar. toolBar is a pointer to the toolbar and style is the style flag as passed to Create method.
ToolBar::Realize is called immediately after returning from this function.
See samples/html/helpview for an example.
[This page automatically generated from the Textile source at Wed Sep 09 02:21:12 +0100 2009]