.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxHtmlHelpFrame 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxHtmlHelpFrame \- 
.SH DESCRIPTION

  


   This class is used by
   wxHtmlHelpController
   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.
  
 
.SH "PARENTS"

  wxFrame
 
.SH "INCLUDE FILES"
wx/html/helpfrm.h
.SH MEMBERS

  
.SS  wxHtmlHelpFrame (wxHtmlHelpData* data = NULL)

.SS  wxHtmlHelpFrame (wxWindow* parentint wxWindowIDconst wxString& title = wxEmptyStringint style = wxHF_DEFAULT_STYLEwxHtmlHelpData* data = NULL)

     


      Constructor.
     
     


      
       style
      
      is combination of these flags:
     
     
      
       
        wxHF_TOOLBAR
       
       
        Help frame has toolbar.
       
      

       
      
       
        wxHF_FLAT_TOOLBAR
       
       
        Help frame has toolbar with flat buttons (aka coolbar).
       
      

       
      
       
        wxHF_CONTENTS
       
       
        Help frame has contents panel.
       
      

       
      
       
        wxHF_INDEX
       
       
        Help frame has index panel.
       
      

       
      
       
        wxHF_SEARCH
       
       
        Help frame has search panel.
       
      

       
      
       
        wxHF_BOOKMARKS
       
       
        Help frame has bookmarks controls.
       
      

       
      
       
        wxHF_OPEN_FILES
       
       
        Allow user to open arbitrary HTML document.
       
      

       
      
       
        wxHF_PRINT
       
       
        Toolbar contains "print" button.
       
      

       
      
       
        wxHF_MERGE_BOOKS
       
       
        Contents pane does not show book nodes. All books are merged together and appear as single book to the user.
       
      

       
      
       
        wxHF_ICONS_BOOK
       
       
        All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.
       
      

       
      
       
        wxHF_ICONS_FOLDER
       
       
        Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.
       
      

       
      
       
        wxHF_ICONS_BOOK_CHAPTER
       
       
        Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.
       
      

       
      
       
        wxHF_DEFAULT_STYLE
       
       
        wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH | wxHF_BOOKMARKS | wxHF_PRINT
       
      

     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idconst wxString& title = wxEmptyStringint style = wxHF_DEFAULT_STYLE)

     


      Creates the frame. See
      the constructor
      for parameters description.
     
    
   
  
.SS void CreateContents ()

     


      Creates contents panel. (May take some time.)
     
     


      Protected.
     
    
   
  
.SS void CreateIndex ()

     


      Creates index panel. (May take some time.)
     
     


      Protected.
     
    
   
  
.SS void CreateSearch ()

     


      Creates search panel.
     
    
   
  
.SS bool Display (const wxString& x)

.SS bool Display (const int 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:
     
     


      
       try to locate file named x (if x is for example "doc/howto.htm")
        
       try to open starting page of book x
        
       try to find x in contents (if x is for example "How To ...")
        
       try to find x in index (if x is for example "How To ...")
      
     
     


      The second form takes numeric ID as the parameter. (uses extension to MS
      format, <param name="ID" value=id>)
     
    
   
  
.SS bool DisplayContents ()

     


      Displays contents panel.
     
    
   
  
.SS bool DisplayIndex ()

     


      Displays index panel.
     
    
   
  
.SS wxHtmlHelpData* GetData ()

     


      Return wxHtmlHelpData object.
     
    
   
  
.SS bool KeywordSearch (const wxString& keywordwxHelpSearchMode mode = wxHELP_SEARCH_ALL)

     


      Search for given keyword. Optionally it searches through the index (mode =
      wxHELP_SEARCH_INDEX), default the content (mode = wxHELP_SEARCH_ALL).
     
    
   
  
.SS void ReadCustomization (wxConfigBase* cfgconst wxString& path = wxEmptyString)

     


      Reads user's settings for this frame (see
      wxHtmlHelpController::ReadCustomization
      )
     
    
   
  
.SS void RefreshLists ()

     


      Refresh all panels. This is necessary if a new book was added.
     
     


      Protected.
     
    
   
  
.SS void SetTitleFormat (const wxString& format)

     


      Sets the frame's title format.
      
       format
      
      must contain exactly one "%s" (it will be replaced by the page
      title).
     
    
   
  
.SS void UseConfig (wxConfigBase* configconst wxString& rootpath = wxEmptyString)

     


      Add books to search choice panel.
     
    
   
  
.SS void WriteCustomization (wxConfigBase* cfgconst wxString& path = wxEmptyString)

     


      Saves user's settings for this frame (see
      wxHtmlHelpController::WriteCustomization
      ).
     
    
   
  
.SS virtual void AddToolbarButtons (wxToolBar *toolBarint 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.
     
     


      wxToolBar::Realize is called immediately after returning from this
      function.
     
     


      See
      
       samples/html/helpview
      
      for an example.
     
    
 
.SH "SEE ALSO"

  wxFrame
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.