src/html/helpfrm.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpfrm.cpp
   3 // Purpose:     wxHtmlHelpFrame
   4 // Notes:       Based on htmlhelp.cpp, implementing a monolithic
   5 //              HTML Help controller class,  by Vaclav Slavik
   6 // Author:      Harm van der Heijden and Vaclav Slavik
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Harm van der Heijden and Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation "helpfrm.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h"
  17
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #if wxUSE_WXHTML_HELP
  25
  26 #ifndef WXPRECOMP
  27     #include "wx/intl.h"
  28     #include "wx/log.h"
  29
  30     #include "wx/object.h"
  31     #include "wx/sizer.h"
  32
  33     #include "wx/bmpbuttn.h"
  34     #include "wx/statbox.h"
  35     #include "wx/radiobox.h"
  36 #endif // WXPRECOMP
  37
  38 #ifdef __WXMAC__
  39     #include "wx/menu.h"
  40     #include "wx/msgdlg.h"
  41 #endif
  42
  43 #include "wx/html/helpfrm.h"
  44 #include "wx/html/helpctrl.h"
  45 #include "wx/textctrl.h"
  46 #include "wx/notebook.h"
  47 #include "wx/imaglist.h"
  48 #include "wx/treectrl.h"
  49 #include "wx/tokenzr.h"
  50 #include "wx/wfstream.h"
  51 #include "wx/html/htmlwin.h"
  52 #include "wx/busyinfo.h"
  53 #include "wx/progdlg.h"
  54 #include "wx/toolbar.h"
  55 #include "wx/fontenum.h"
  56 #include "wx/stream.h"
  57 #include "wx/filedlg.h"
  58 #include "wx/artprov.h"
  59 #include "wx/spinctrl.h"
  60
  61 // what is considered "small index"?
  62 #define INDEX_IS_SMALL 100
  63
  64 /* Motif defines this as a macro */
  65 #ifdef Below
  66 #undef Below
  67 #endif
  68
  69 //--------------------------------------------------------------------------
  70 // wxHtmlHelpTreeItemData (private)
  71 //--------------------------------------------------------------------------
  72
  73 class wxHtmlHelpTreeItemData : public wxTreeItemData
  74 {
  75     public:
  76 #if defined(__VISAGECPP__)
  77 //  VA needs a default ctor for some reason....
  78         wxHtmlHelpTreeItemData() : wxTreeItemData()
  79             { m_Id = 0; }
  80 #endif
  81         wxHtmlHelpTreeItemData(int id) : wxTreeItemData()
  82             { m_Id = id;}
  83
  84         int m_Id;
  85 };
  86
  87
  88 //--------------------------------------------------------------------------
  89 // wxHtmlHelpHashData (private)
  90 //--------------------------------------------------------------------------
  91
  92 class wxHtmlHelpHashData : public wxObject
  93 {
  94     public:
  95         wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject()
  96             { m_Index = index; m_Id = id;}
  97         ~wxHtmlHelpHashData() {}
  98
  99         int m_Index;
 100         wxTreeItemId m_Id;
 101 };
 102
 103
 104 //--------------------------------------------------------------------------
 105 // wxHtmlHelpHtmlWindow (private)
 106 //--------------------------------------------------------------------------
 107
 108 class wxHtmlHelpHtmlWindow : public wxHtmlWindow
 109 {
 110     public:
 111         wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {}
 112
 113         virtual void OnLinkClicked(const wxHtmlLinkInfo& link)
 114         {
 115             wxHtmlWindow::OnLinkClicked(link);
 116             const wxMouseEvent *e = link.GetEvent();
 117             if (e == NULL || e->LeftUp())
 118                 m_Frame->NotifyPageChanged();
 119         }
 120
 121     private:
 122         wxHtmlHelpFrame *m_Frame;
 123
 124     DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow)
 125 };
 126
 127
 128
 129 //---------------------------------------------------------------------------
 130 // wxHtmlHelpFrame
 131 //---------------------------------------------------------------------------
 132
 133 // Command IDs :
 134 enum
 135 {
 136     //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1,
 137     wxID_HTML_PANEL = wxID_HIGHEST + 2,
 138     wxID_HTML_BACK,
 139     wxID_HTML_FORWARD,
 140     wxID_HTML_UPNODE,
 141     wxID_HTML_UP,
 142     wxID_HTML_DOWN,
 143     wxID_HTML_PRINT,
 144     wxID_HTML_OPENFILE,
 145     wxID_HTML_OPTIONS,
 146     wxID_HTML_BOOKMARKSLIST,
 147     wxID_HTML_BOOKMARKSADD,
 148     wxID_HTML_BOOKMARKSREMOVE,
 149     wxID_HTML_TREECTRL,
 150     wxID_HTML_INDEXPAGE,
 151     wxID_HTML_INDEXLIST,
 152     wxID_HTML_INDEXTEXT,
 153     wxID_HTML_INDEXBUTTON,
 154     wxID_HTML_INDEXBUTTONALL,
 155     wxID_HTML_NOTEBOOK,
 156     wxID_HTML_SEARCHPAGE,
 157     wxID_HTML_SEARCHTEXT,
 158     wxID_HTML_SEARCHLIST,
 159     wxID_HTML_SEARCHBUTTON,
 160     wxID_HTML_SEARCHCHOICE,
 161     wxID_HTML_COUNTINFO
 162 };
 163
 164
 165 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame)
 166
 167 wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title,
 168                                  int style, wxHtmlHelpData* data)
 169 {
 170     Init(data);
 171     Create(parent, id, title, style);
 172 }
 173
 174 void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
 175 {
 176     if (data)
 177     {
 178         m_Data = data;
 179         m_DataCreated = false;
 180     } else
 181     {
 182         m_Data = new wxHtmlHelpData();
 183         m_DataCreated = true;
 184     }
 185
 186     m_ContentsBox = NULL;
 187     m_IndexList = NULL;
 188     m_IndexButton = NULL;
 189     m_IndexButtonAll = NULL;
 190     m_IndexText = NULL;
 191     m_SearchList = NULL;
 192     m_SearchButton = NULL;
 193     m_SearchText = NULL;
 194     m_SearchChoice = NULL;
 195     m_IndexCountInfo = NULL;
 196     m_Splitter = NULL;
 197     m_NavigPan = NULL;
 198     m_NavigNotebook = NULL;
 199     m_HtmlWin = NULL;
 200     m_Bookmarks = NULL;
 201     m_SearchCaseSensitive = NULL;
 202     m_SearchWholeWords = NULL;
 203
 204     m_Config = NULL;
 205     m_ConfigRoot = wxEmptyString;
 206
 207     m_Cfg.x = m_Cfg.y = 0;
 208     m_Cfg.w = 700;
 209     m_Cfg.h = 480;
 210     m_Cfg.sashpos = 240;
 211     m_Cfg.navig_on = true;
 212
 213     m_NormalFonts = m_FixedFonts = NULL;
 214     m_NormalFace = m_FixedFace = wxEmptyString;
 215 #ifdef __WXMSW__
 216     m_FontSize = 10;
 217 #else
 218     m_FontSize = 14;
 219 #endif
 220
 221 #if wxUSE_PRINTING_ARCHITECTURE
 222     m_Printer = NULL;
 223 #endif
 224
 225     m_PagesHash = NULL;
 226     m_UpdateContents = true;
 227     m_helpController = (wxHelpControllerBase*) NULL;
 228 }
 229
 230 // Create: builds the GUI components.
 231 // with the style flag it's possible to toggle the toolbar, contents, index and search
 232 // controls.
 233 // m_HtmlWin will *always* be created, but it's important to realize that
 234 // m_ContentsBox, m_IndexList, m_SearchList, m_SearchButton, m_SearchText and
 235 // m_SearchButton may be NULL.
 236 // moreover, if no contents, index or searchpage is needed, m_Splitter and
 237 // m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame)
 238
 239 bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
 240                              const wxString& WXUNUSED(title), int style)
 241 {
 242     m_hfStyle = style;
 243
 244     wxImageList *ContentsImageList = new wxImageList(16, 16);
 245     ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, wxART_HELP_BROWSER));
 246     ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, wxART_HELP_BROWSER));
 247     ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, wxART_HELP_BROWSER));
 248
 249     // Do the config in two steps. We read the HtmlWindow customization after we
 250     // create the window.
 251     if (m_Config)
 252         ReadCustomization(m_Config, m_ConfigRoot);
 253
 254     wxFrame::Create(parent, id, _("Help"),
 255                     wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h),
 256                     wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp"));
 257
 258     GetPosition(&m_Cfg.x, &m_Cfg.y);
 259
 260     SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER));
 261
 262     // On the Mac, each modeless frame must have a menubar.
 263     // TODO: add more menu items, and perhaps add a style to show
 264     // the menubar: compulsory on the Mac, optional elsewhere.
 265 #ifdef __WXMAC__
 266     wxMenuBar* menuBar = new wxMenuBar;
 267
 268     wxMenu* fileMenu = new wxMenu;
 269     fileMenu->Append(wxID_HTML_OPENFILE, _("&Open..."));
 270     fileMenu->AppendSeparator();
 271     fileMenu->Append(wxID_CLOSE, _("&Close"));
 272
 273     wxMenu* helpMenu = new wxMenu;
 274     helpMenu->Append(wxID_ABOUT, _("&About..."));
 275
 276     menuBar->Append(fileMenu,_("&File"));
 277     menuBar->Append(helpMenu,_("&Help"));
 278     SetMenuBar(menuBar);
 279 #endif
 280
 281     int notebook_page = 0;
 282
 283     CreateStatusBar();
 284
 285 #if wxUSE_TOOLBAR
 286     // toolbar?
 287     if (style & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR))
 288     {
 289         wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL |
 290                                            wxTB_DOCKABLE |
 291                                            (style & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0));
 292         toolBar->SetMargins( 2, 2 );
 293         AddToolbarButtons(toolBar, style);
 294         toolBar->Realize();
 295     }
 296 #endif //wxUSE_TOOLBAR
 297
 298     wxSizer *navigSizer = NULL;
 299
 300     if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH))
 301     {
 302         // traditional help controller; splitter window with html page on the
 303         // right and a notebook containing various pages on the left
 304         m_Splitter = new wxSplitterWindow(this);
 305
 306         m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter);
 307         m_NavigPan = new wxPanel(m_Splitter, wxID_ANY);
 308         m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK,
 309                                          wxDefaultPosition, wxDefaultSize);
 310
 311         navigSizer = new wxBoxSizer(wxVERTICAL);
 312         navigSizer->Add(m_NavigNotebook, 1, wxEXPAND);
 313
 314         m_NavigPan->SetSizer(navigSizer);
 315     }
 316     else
 317     { // only html window, no notebook with index,contents etc
 318         m_HtmlWin = new wxHtmlWindow(this);
 319     }
 320
 321     m_HtmlWin->SetRelatedFrame(this, m_TitleFormat);
 322     m_HtmlWin->SetRelatedStatusBar(0);
 323     if ( m_Config )
 324         m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot);
 325
 326     // contents tree panel?
 327     if ( style & wxHF_CONTENTS )
 328     {
 329         wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
 330         wxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
 331
 332         topsizer->Add(0, 10);
 333
 334         dummy->SetSizer(topsizer);
 335
 336         if ( style & wxHF_BOOKMARKS )
 337         {
 338             m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST,
 339                                          wxEmptyString,
 340                                          wxDefaultPosition, wxDefaultSize,
 341                                          0, NULL, wxCB_READONLY | wxCB_SORT);
 342             m_Bookmarks->Append(_("(bookmarks)"));
 343             for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++)
 344                 m_Bookmarks->Append(m_BookmarksNames[i]);
 345             m_Bookmarks->SetSelection(0);
 346
 347             wxBitmapButton *bmpbt1, *bmpbt2;
 348             bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD,
 349                                  wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK,
 350                                                           wxART_HELP_BROWSER));
 351             bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE,
 352                                  wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK,
 353                                                           wxART_HELP_BROWSER));
 354 #if wxUSE_TOOLTIPS
 355             bmpbt1->SetToolTip(_("Add current page to bookmarks"));
 356             bmpbt2->SetToolTip(_("Remove current page from bookmarks"));
 357 #endif // wxUSE_TOOLTIPS
 358
 359             wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
 360
 361             sizer->Add(m_Bookmarks, 1, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 5);
 362             sizer->Add(bmpbt1, 0, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 2);
 363             sizer->Add(bmpbt2, 0, wxALIGN_CENTRE_VERTICAL, 0);
 364
 365             topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10);
 366         }
 367
 368         m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL,
 369                                        wxDefaultPosition, wxDefaultSize,
 370                                        wxSUNKEN_BORDER |
 371                                        wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
 372                                        wxTR_LINES_AT_ROOT);
 373
 374         m_ContentsBox->AssignImageList(ContentsImageList);
 375
 376         topsizer->Add(m_ContentsBox, 1,
 377                       wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT,
 378                       2);
 379
 380         m_NavigNotebook->AddPage(dummy, _("Contents"));
 381         m_ContentsPage = notebook_page++;
 382     }
 383
 384     // index listbox panel?
 385     if ( style & wxHF_INDEX )
 386     {
 387         wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
 388         wxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
 389
 390         dummy->SetSizer(topsizer);
 391
 392         m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString,
 393                                      wxDefaultPosition, wxDefaultSize,
 394                                      wxTE_PROCESS_ENTER);
 395         m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find"));
 396         m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL,
 397                                         _("Show all"));
 398         m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO,
 399                                             wxEmptyString, wxDefaultPosition,
 400                                             wxDefaultSize,
 401                                             wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
 402         m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST,
 403                                     wxDefaultPosition, wxDefaultSize,
 404                                     0, NULL, wxLB_SINGLE);
 405
 406 #if wxUSE_TOOLTIPS
 407         m_IndexButton->SetToolTip(_("Display all index items that contain given substring. Search is case insensitive."));
 408         m_IndexButtonAll->SetToolTip(_("Show all items in index"));
 409 #endif //wxUSE_TOOLTIPS
 410
 411         topsizer->Add(m_IndexText, 0, wxEXPAND | wxALL, 10);
 412         wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL);
 413         btsizer->Add(m_IndexButton, 0, wxRIGHT, 2);
 414         btsizer->Add(m_IndexButtonAll);
 415         topsizer->Add(btsizer, 0,
 416                       wxALIGN_RIGHT | wxLEFT | wxRIGHT | wxBOTTOM, 10);
 417         topsizer->Add(m_IndexCountInfo, 0, wxEXPAND | wxLEFT | wxRIGHT, 2);
 418         topsizer->Add(m_IndexList, 1, wxEXPAND | wxALL, 2);
 419
 420         m_NavigNotebook->AddPage(dummy, _("Index"));
 421         m_IndexPage = notebook_page++;
 422     }
 423
 424     // search list panel?
 425     if ( style & wxHF_SEARCH )
 426     {
 427         wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
 428         wxSizer *sizer = new wxBoxSizer(wxVERTICAL);
 429
 430         dummy->SetSizer(sizer);
 431
 432         m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT,
 433                                       wxEmptyString,
 434                                       wxDefaultPosition, wxDefaultSize,
 435                                       wxTE_PROCESS_ENTER);
 436         m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE,
 437                                       wxDefaultPosition, wxDefaultSize);
 438         m_SearchCaseSensitive = new wxCheckBox(dummy, wxID_ANY, _("Case sensitive"));
 439         m_SearchWholeWords = new wxCheckBox(dummy, wxID_ANY, _("Whole words only"));
 440         m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search"));
 441 #if wxUSE_TOOLTIPS
 442         m_SearchButton->SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above"));
 443 #endif //wxUSE_TOOLTIPS
 444         m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST,
 445                                      wxDefaultPosition, wxDefaultSize,
 446                                      0, NULL, wxLB_SINGLE);
 447
 448         sizer->Add(m_SearchText, 0, wxEXPAND | wxALL, 10);
 449         sizer->Add(m_SearchChoice, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 10);
 450         sizer->Add(m_SearchCaseSensitive, 0, wxLEFT | wxRIGHT, 10);
 451         sizer->Add(m_SearchWholeWords, 0, wxLEFT | wxRIGHT, 10);
 452         sizer->Add(m_SearchButton, 0, wxALL | wxALIGN_RIGHT, 8);
 453         sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2);
 454
 455         m_NavigNotebook->AddPage(dummy, _("Search"));
 456         m_SearchPage = notebook_page;
 457     }
 458
 459     m_HtmlWin->Show();
 460
 461     RefreshLists();
 462
 463     if ( navigSizer )
 464     {
 465         navigSizer->SetSizeHints(m_NavigPan);
 466         m_NavigPan->Layout();
 467     }
 468
 469     // showtime
 470     if ( m_NavigPan && m_Splitter )
 471     {
 472         m_Splitter->SetMinimumPaneSize(20);
 473         if ( m_Cfg.navig_on )
 474             m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
 475
 476         if ( m_Cfg.navig_on )
 477         {
 478             m_NavigPan->Show();
 479             m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
 480         }
 481         else
 482         {
 483             m_NavigPan->Show(false);
 484             m_Splitter->Initialize(m_HtmlWin);
 485         }
 486     }
 487
 488     // Reduce flicker by updating the splitter pane sizes before the
 489     // frame is shown
 490     wxSizeEvent sizeEvent(GetSize(), GetId());
 491     ProcessEvent(sizeEvent);
 492
 493     m_Splitter->UpdateSize();
 494
 495     return true;
 496 }
 497
 498 wxHtmlHelpFrame::~wxHtmlHelpFrame()
 499 {
 500     // PopEventHandler(); // wxhtmlhelpcontroller (not any more!)
 501     if (m_DataCreated)
 502         delete m_Data;
 503     if (m_NormalFonts) delete m_NormalFonts;
 504     if (m_FixedFonts) delete m_FixedFonts;
 505     if (m_PagesHash)
 506     {
 507         WX_CLEAR_HASH_TABLE(*m_PagesHash);
 508         delete m_PagesHash;
 509     }
 510 #if wxUSE_PRINTING_ARCHITECTURE
 511     if (m_Printer) delete m_Printer;
 512 #endif
 513 }
 514
 515
 516 #if wxUSE_TOOLBAR
 517 void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
 518 {
 519     wxBitmap wpanelBitmap =
 520         wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_HELP_BROWSER);
 521     wxBitmap wbackBitmap =
 522         wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_HELP_BROWSER);
 523     wxBitmap wforwardBitmap =
 524         wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_HELP_BROWSER);
 525     wxBitmap wupnodeBitmap =
 526         wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_HELP_BROWSER);
 527     wxBitmap wupBitmap =
 528         wxArtProvider::GetBitmap(wxART_GO_UP, wxART_HELP_BROWSER);
 529     wxBitmap wdownBitmap =
 530         wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_HELP_BROWSER);
 531     wxBitmap wopenBitmap =
 532         wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_HELP_BROWSER);
 533     wxBitmap wprintBitmap =
 534         wxArtProvider::GetBitmap(wxART_PRINT, wxART_HELP_BROWSER);
 535     wxBitmap woptionsBitmap =
 536         wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_HELP_BROWSER);
 537
 538     wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() &&
 539                    wforwardBitmap.Ok() && wupnodeBitmap.Ok() &&
 540                    wupBitmap.Ok() && wdownBitmap.Ok() &&
 541                    wopenBitmap.Ok() && wprintBitmap.Ok() &&
 542                    woptionsBitmap.Ok()),
 543                   wxT("One or more HTML help frame toolbar bitmap could not be loaded.")) ;
 544
 545
 546     toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap,
 547                        false, -1, -1, (wxObject *) NULL,
 548                        _("Show/hide navigation panel"));
 549
 550     toolBar->AddSeparator();
 551     toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap,
 552                        false, -1, -1, (wxObject *) NULL,
 553                        _("Go back"));
 554     toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap,
 555                        false, -1, -1, (wxObject *) NULL,
 556                        _("Go forward"));
 557     toolBar->AddSeparator();
 558
 559     toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap,
 560                        false, -1, -1, (wxObject *) NULL,
 561                        _("Go one level up in document hierarchy"));
 562     toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap,
 563                        false, -1, -1, (wxObject *) NULL,
 564                        _("Previous page"));
 565     toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap,
 566                        false, -1, -1, (wxObject *) NULL,
 567                        _("Next page"));
 568
 569     if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES))
 570         toolBar->AddSeparator();
 571
 572     if (style & wxHF_OPEN_FILES)
 573         toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap,
 574                            false, -1, -1, (wxObject *) NULL,
 575                            _("Open HTML document"));
 576
 577 #if wxUSE_PRINTING_ARCHITECTURE
 578     if (style & wxHF_PRINT)
 579         toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap,
 580                            false, -1, -1, (wxObject *) NULL,
 581                            _("Print this page"));
 582 #endif
 583
 584     toolBar->AddSeparator();
 585     toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap,
 586                        false, -1, -1, (wxObject *) NULL,
 587                        _("Display options dialog"));
 588 }
 589 #endif //wxUSE_TOOLBAR
 590
 591
 592 void wxHtmlHelpFrame::SetTitleFormat(const wxString& format)
 593 {
 594     if (m_HtmlWin)
 595         m_HtmlWin->SetRelatedFrame(this, format);
 596     m_TitleFormat = format;
 597 }
 598
 599
 600 bool wxHtmlHelpFrame::Display(const wxString& x)
 601 {
 602     wxString url = m_Data->FindPageByName(x);
 603     if (!url.IsEmpty())
 604     {
 605         m_HtmlWin->LoadPage(url);
 606         NotifyPageChanged();
 607         return true;
 608     }
 609
 610     return false;
 611 }
 612
 613 bool wxHtmlHelpFrame::Display(const int id)
 614 {
 615     wxString url = m_Data->FindPageById(id);
 616     if (!url.IsEmpty())
 617     {
 618         m_HtmlWin->LoadPage(url);
 619         NotifyPageChanged();
 620         return true;
 621     }
 622
 623     return false;
 624 }
 625
 626
 627
 628 bool wxHtmlHelpFrame::DisplayContents()
 629 {
 630     if (! m_ContentsBox)
 631         return false;
 632
 633     if (!m_Splitter->IsSplit())
 634     {
 635         m_NavigPan->Show();
 636         m_HtmlWin->Show();
 637         m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
 638         m_Cfg.navig_on = true;
 639     }
 640
 641     m_NavigNotebook->SetSelection(0);
 642
 643     if (m_Data->GetBookRecArray().GetCount() > 0)
 644     {
 645         wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
 646         if (!book.GetStart().IsEmpty())
 647             m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
 648     }
 649
 650     return true;
 651 }
 652
 653
 654
 655 bool wxHtmlHelpFrame::DisplayIndex()
 656 {
 657     if (! m_IndexList)
 658         return false;
 659
 660     if (!m_Splitter->IsSplit())
 661     {
 662         m_NavigPan->Show();
 663         m_HtmlWin->Show();
 664         m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
 665     }
 666
 667     m_NavigNotebook->SetSelection(1);
 668
 669     if (m_Data->GetBookRecArray().GetCount() > 0)
 670     {
 671         wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
 672         if (!book.GetStart().IsEmpty())
 673             m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
 674     }
 675
 676     return true;
 677 }
 678
 679
 680
 681 bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword,
 682                                     wxHelpSearchMode mode)
 683 {
 684     if (mode == wxHELP_SEARCH_ALL)
 685     {
 686         if ( !(m_SearchList &&
 687                m_SearchButton && m_SearchText && m_SearchChoice) )
 688             return false;
 689     }
 690     else if (mode == wxHELP_SEARCH_INDEX)
 691     {
 692         if ( !(m_IndexList &&
 693                m_IndexButton && m_IndexButtonAll && m_IndexText) )
 694             return false;
 695     }
 696
 697     int foundcnt = 0;
 698     wxString foundstr;
 699     wxString book = wxEmptyString;
 700
 701     if (!m_Splitter->IsSplit())
 702     {
 703         m_NavigPan->Show();
 704         m_HtmlWin->Show();
 705         m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
 706     }
 707
 708     if (mode == wxHELP_SEARCH_ALL)
 709     {
 710         m_NavigNotebook->SetSelection(m_SearchPage);
 711         m_SearchList->Clear();
 712         m_SearchText->SetValue(keyword);
 713         m_SearchButton->Disable();
 714
 715         if (m_SearchChoice->GetSelection() != 0)
 716             book = m_SearchChoice->GetStringSelection();
 717
 718         wxHtmlSearchStatus status(m_Data, keyword,
 719                                   m_SearchCaseSensitive->GetValue(),
 720                                   m_SearchWholeWords->GetValue(),
 721                                   book);
 722
 723 #if wxUSE_PROGRESSDLG
 724         wxProgressDialog progress(_("Searching..."),
 725                                   _("No matching page found yet"),
 726                                   status.GetMaxIndex(), this,
 727                                   wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE);
 728 #endif
 729
 730         int curi;
 731         while (status.IsActive())
 732         {
 733             curi = status.GetCurIndex();
 734             if (curi % 32 == 0
 735 #if wxUSE_PROGRESSDLG
 736                 && !progress.Update(curi)
 737 #endif
 738                )
 739                 break;
 740             if (status.Search())
 741             {
 742                 foundstr.Printf(_("Found %i matches"), ++foundcnt);
 743 #if wxUSE_PROGRESSDLG
 744                 progress.Update(status.GetCurIndex(), foundstr);
 745 #endif
 746                 m_SearchList->Append(status.GetName(), status.GetContentsItem());
 747             }
 748         }
 749
 750         m_SearchButton->Enable();
 751         m_SearchText->SetSelection(0, keyword.Length());
 752         m_SearchText->SetFocus();
 753     }
 754     else if (mode == wxHELP_SEARCH_INDEX)
 755     {
 756         m_NavigNotebook->SetSelection(m_IndexPage);
 757         m_IndexList->Clear();
 758         m_IndexButton->Disable();
 759         m_IndexButtonAll->Disable();
 760         m_IndexText->SetValue(keyword);
 761
 762         wxCommandEvent dummy;
 763         OnIndexFind(dummy); // what a hack...
 764         m_IndexButton->Enable();
 765         m_IndexButtonAll->Enable();
 766         foundcnt = m_IndexList->GetCount();
 767     }
 768
 769     if (foundcnt)
 770     {
 771         wxHtmlContentsItem *it;
 772         switch ( mode )
 773         {
 774             default:
 775                 wxFAIL_MSG( _T("unknown help search mode") );
 776                 // fall back
 777
 778             case wxHELP_SEARCH_ALL:
 779                 it = (wxHtmlContentsItem*) m_SearchList->GetClientData(0);
 780                 break;
 781
 782             case wxHELP_SEARCH_INDEX:
 783                 it = (wxHtmlContentsItem*) m_IndexList->GetClientData(0);
 784                 break;
 785         }
 786
 787         if (it)
 788         {
 789             m_HtmlWin->LoadPage(it->GetFullPath());
 790             NotifyPageChanged();
 791         }
 792     }
 793
 794     return foundcnt > 0;
 795 }
 796
 797 void wxHtmlHelpFrame::CreateContents()
 798 {
 799     if (! m_ContentsBox)
 800         return ;
 801
 802     if (m_PagesHash)
 803     {
 804         WX_CLEAR_HASH_TABLE(*m_PagesHash);
 805         delete m_PagesHash;
 806     }
 807     m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * m_Data->GetContentsCnt());
 808
 809     int cnt = m_Data->GetContentsCnt();
 810     int i;
 811
 812     wxHtmlContentsItem *it;
 813
 814     const int MAX_ROOTS = 64;
 815     wxTreeItemId roots[MAX_ROOTS];
 816     // VS: this array holds information about whether we've set item icon at
 817     //     given level. This is neccessary because m_Data has flat structure
 818     //     and there's no way of recognizing if some item has subitems or not.
 819     //     We set the icon later: when we find an item with level=n, we know
 820     //     that the last item with level=n-1 was folder with subitems, so we
 821     //     set its icon accordingly
 822     bool imaged[MAX_ROOTS];
 823     m_ContentsBox->DeleteAllItems();
 824
 825     roots[0] = m_ContentsBox->AddRoot(_("(Help)"));
 826     imaged[0] = true;
 827
 828     for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++)
 829     {
 830         // Handle books:
 831         if (it->m_Level == 0)
 832         {
 833             if (m_hfStyle & wxHF_MERGE_BOOKS)
 834                 // VS: we don't want book nodes, books' content should
 835                 //    appear under tree's root. This line will create "fake"
 836                 //    record about book node so that the rest of this look
 837                 //    will believe there really _is_ book node and will
 838                 //    behave correctly.
 839                 roots[1] = roots[0];
 840             else
 841             {
 842                 roots[1] = m_ContentsBox->AppendItem(roots[0],
 843                                          it->m_Name, IMG_Book, -1,
 844                                          new wxHtmlHelpTreeItemData(i));
 845                 m_ContentsBox->SetItemBold(roots[1], true);
 846             }
 847             imaged[1] = true;
 848         }
 849         // ...and their contents:
 850         else
 851         {
 852             roots[it->m_Level + 1] = m_ContentsBox->AppendItem(
 853                                      roots[it->m_Level], it->m_Name, IMG_Page,
 854                                      -1, new wxHtmlHelpTreeItemData(i));
 855             imaged[it->m_Level + 1] = false;
 856         }
 857
 858         m_PagesHash->Put(it->GetFullPath(),
 859                            new wxHtmlHelpHashData(i, roots[it->m_Level + 1]));
 860
 861         // Set the icon for the node one level up in the hiearachy,
 862         // unless already done (see comment above imaged[] declaration)
 863         if (!imaged[it->m_Level])
 864         {
 865             int image = IMG_Folder;
 866             if (m_hfStyle & wxHF_ICONS_BOOK)
 867                 image = IMG_Book;
 868             else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER)
 869                 image = (it->m_Level == 1) ? IMG_Book : IMG_Folder;
 870             m_ContentsBox->SetItemImage(roots[it->m_Level], image);
 871             m_ContentsBox->SetItemImage(roots[it->m_Level], image,
 872                                         wxTreeItemIcon_Selected);
 873             imaged[it->m_Level] = true;
 874         }
 875     }
 876 }
 877
 878
 879 void wxHtmlHelpFrame::CreateIndex()
 880 {
 881     if (! m_IndexList)
 882         return ;
 883
 884     m_IndexList->Clear();
 885
 886     int cnt = m_Data->GetIndexCnt();
 887
 888     wxString cnttext;
 889     if (cnt > INDEX_IS_SMALL) cnttext.Printf(_("%i of %i"), 0, cnt);
 890     else cnttext.Printf(_("%i of %i"), cnt, cnt);
 891     m_IndexCountInfo->SetLabel(cnttext);
 892     if (cnt > INDEX_IS_SMALL) return;
 893
 894     wxHtmlContentsItem* index = m_Data->GetIndex();
 895
 896     for (int i = 0; i < cnt; i++)
 897         m_IndexList->Append(index[i].m_Name, (char*)(index + i));
 898 }
 899
 900 void wxHtmlHelpFrame::CreateSearch()
 901 {
 902     if (! (m_SearchList && m_SearchChoice))
 903         return ;
 904     m_SearchList->Clear();
 905     m_SearchChoice->Clear();
 906     m_SearchChoice->Append(_("Search in all books"));
 907     const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray();
 908     int i, cnt = bookrec.GetCount();
 909     for (i = 0; i < cnt; i++)
 910         m_SearchChoice->Append(bookrec[i].GetTitle());
 911     m_SearchChoice->SetSelection(0);
 912 }
 913
 914
 915 void wxHtmlHelpFrame::RefreshLists()
 916 {
 917     CreateContents();
 918     CreateIndex();
 919     CreateSearch();
 920 }
 921
 922 void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
 923 {
 924     wxString oldpath;
 925     wxString tmp;
 926
 927     if (path != wxEmptyString)
 928     {
 929         oldpath = cfg->GetPath();
 930         cfg->SetPath(_T("/") + path);
 931     }
 932
 933     m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0;
 934     m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos);
 935     m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x);
 936     m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y);
 937     m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w);
 938     m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h);
 939
 940     m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace);
 941     m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace);
 942     m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize);
 943
 944     {
 945         int i;
 946         int cnt;
 947         wxString val, s;
 948
 949         cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L);
 950         if (cnt != 0)
 951         {
 952             m_BookmarksNames.Clear();
 953             m_BookmarksPages.Clear();
 954             if (m_Bookmarks)
 955             {
 956                 m_Bookmarks->Clear();
 957                 m_Bookmarks->Append(_("(bookmarks)"));
 958             }
 959
 960             for (i = 0; i < cnt; i++)
 961             {
 962                 val.Printf(wxT("hcBookmark_%i"), i);
 963                 s = cfg->Read(val);
 964                 m_BookmarksNames.Add(s);
 965                 if (m_Bookmarks) m_Bookmarks->Append(s);
 966                 val.Printf(wxT("hcBookmark_%i_url"), i);
 967                 s = cfg->Read(val);
 968                 m_BookmarksPages.Add(s);
 969             }
 970         }
 971     }
 972
 973     if (m_HtmlWin)
 974         m_HtmlWin->ReadCustomization(cfg);
 975
 976     if (path != wxEmptyString)
 977         cfg->SetPath(oldpath);
 978 }
 979
 980 void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path)
 981 {
 982     wxString oldpath;
 983     wxString tmp;
 984
 985     if (path != wxEmptyString)
 986     {
 987         oldpath = cfg->GetPath();
 988         cfg->SetPath(_T("/") + path);
 989     }
 990
 991     cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on);
 992     cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos);
 993     if ( !IsIconized() )
 994     {
 995         //  Don't write if iconized as this would make the window
 996         //  disappear next time it is shown!
 997         cfg->Write(wxT("hcX"), (long)m_Cfg.x);
 998         cfg->Write(wxT("hcY"), (long)m_Cfg.y);
 999         cfg->Write(wxT("hcW"), (long)m_Cfg.w);
1000         cfg->Write(wxT("hcH"), (long)m_Cfg.h);
1001     }
1002     cfg->Write(wxT("hcFixedFace"), m_FixedFace);
1003     cfg->Write(wxT("hcNormalFace"), m_NormalFace);
1004     cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize);
1005
1006     if (m_Bookmarks)
1007     {
1008         int i;
1009         int cnt = m_BookmarksNames.GetCount();
1010         wxString val;
1011
1012         cfg->Write(wxT("hcBookmarksCnt"), (long)cnt);
1013         for (i = 0; i < cnt; i++)
1014         {
1015             val.Printf(wxT("hcBookmark_%i"), i);
1016             cfg->Write(val, m_BookmarksNames[i]);
1017             val.Printf(wxT("hcBookmark_%i_url"), i);
1018             cfg->Write(val, m_BookmarksPages[i]);
1019         }
1020     }
1021
1022     if (m_HtmlWin)
1023         m_HtmlWin->WriteCustomization(cfg);
1024
1025     if (path != wxEmptyString)
1026         cfg->SetPath(oldpath);
1027 }
1028
1029
1030
1031
1032
1033 static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size)
1034 {
1035     int f_sizes[7];
1036     f_sizes[0] = int(size * 0.6);
1037     f_sizes[1] = int(size * 0.8);
1038     f_sizes[2] = size;
1039     f_sizes[3] = int(size * 1.2);
1040     f_sizes[4] = int(size * 1.4);
1041     f_sizes[5] = int(size * 1.6);
1042     f_sizes[6] = int(size * 1.8);
1043
1044     win->SetFonts(scalf, fixf, f_sizes);
1045 }
1046
1047
1048 class wxHtmlHelpFrameOptionsDialog : public wxDialog
1049 {
1050 public:
1051     wxComboBox *NormalFont, *FixedFont;
1052     wxSpinCtrl *FontSize;
1053     wxHtmlWindow *TestWin;
1054
1055     wxHtmlHelpFrameOptionsDialog(wxWindow *parent)
1056         : wxDialog(parent, wxID_ANY, wxString(_("Help Browser Options")))
1057     {
1058         wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
1059         wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5);
1060
1061         sizer->Add(new wxStaticText(this, wxID_ANY, _("Normal font:")));
1062         sizer->Add(new wxStaticText(this, wxID_ANY, _("Fixed font:")));
1063         sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:")));
1064
1065         sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
1066                       wxSize(200, 200),
1067                       0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1068
1069         sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
1070                       wxSize(200, 200),
1071                       0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1072
1073         sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY));
1074         FontSize->SetRange(2, 100);
1075
1076         topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10);
1077
1078         topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")),
1079                         0, wxLEFT | wxTOP, 10);
1080         topsizer->Add(TestWin = new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxSize(20, 150),
1081                                                  wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER),
1082                         1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10);
1083
1084         wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
1085         wxButton *ok;
1086         sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10);
1087         ok->SetDefault();
1088         sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10);
1089         topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
1090
1091         SetSizer(topsizer);
1092         topsizer->Fit(this);
1093         Centre(wxBOTH);
1094     }
1095
1096
1097     void UpdateTestWin()
1098     {
1099         wxBusyCursor bcur;
1100         SetFontsToHtmlWin(TestWin,
1101                           NormalFont->GetStringSelection(),
1102                           FixedFont->GetStringSelection(),
1103                           FontSize->GetValue());
1104
1105         wxString content(_("font size"));
1106
1107         content = _T("<font size=-2>") + content + _T(" -2</font><br>")
1108                   _T("<font size=-1>") + content + _T(" -1</font><br>")
1109                   _T("<font size=+0>") + content + _T(" +0</font><br>")
1110                   _T("<font size=+1>") + content + _T(" +1</font><br>")
1111                   _T("<font size=+2>") + content + _T(" +2</font><br>")
1112                   _T("<font size=+3>") + content + _T(" +3</font><br>")
1113                   _T("<font size=+4>") + content + _T(" +4</font><br>") ;
1114
1115         content = wxString( _T("<html><body><table><tr><td>") ) +
1116                   _("Normal face<br>and <u>underlined</u>. ") +
1117                   _("<i>Italic face.</i> ") +
1118                   _("<b>Bold face.</b> ") +
1119                   _("<b><i>Bold italic face.</i></b><br>") +
1120                   content +
1121                   wxString( _T("</td><td><tt>") ) +
1122                   _("Fixed size face.<br> <b>bold</b> <i>italic</i> ") +
1123                   _("<b><i>bold italic <u>underlined</u></i></b><br>") +
1124                   content +
1125                   _T("</tt></td></tr></table></body></html>");
1126
1127         TestWin->SetPage( content );
1128     }
1129
1130     void OnUpdate(wxCommandEvent& WXUNUSED(event))
1131     {
1132         UpdateTestWin();
1133     }
1134     void OnUpdateSpin(wxSpinEvent& WXUNUSED(event))
1135     {
1136         UpdateTestWin();
1137     }
1138
1139     DECLARE_EVENT_TABLE()
1140     DECLARE_NO_COPY_CLASS(wxHtmlHelpFrameOptionsDialog)
1141 };
1142
1143 BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog)
1144     EVT_COMBOBOX(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdate)
1145     EVT_SPINCTRL(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdateSpin)
1146 END_EVENT_TABLE()
1147
1148 void wxHtmlHelpFrame::OptionsDialog()
1149 {
1150     wxHtmlHelpFrameOptionsDialog dlg(this);
1151     unsigned i;
1152
1153     if (m_NormalFonts == NULL)
1154     {
1155         wxFontEnumerator enu;
1156         enu.EnumerateFacenames();
1157         m_NormalFonts = new wxArrayString;
1158         *m_NormalFonts = *enu.GetFacenames();
1159         m_NormalFonts->Sort(wxStringSortAscending);
1160     }
1161     if (m_FixedFonts == NULL)
1162     {
1163         wxFontEnumerator enu;
1164         enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/);
1165         m_FixedFonts = new wxArrayString;
1166         *m_FixedFonts = *enu.GetFacenames();
1167         m_FixedFonts->Sort(wxStringSortAscending);
1168     }
1169
1170     // VS: We want to show the font that is actually used by wxHtmlWindow.
1171     //     If customization dialog wasn't used yet, facenames are empty and
1172     //     wxHtmlWindow uses default fonts -- let's find out what they
1173     //     are so that we can pass them to the dialog:
1174     if (m_NormalFace.empty())
1175     {
1176         wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, false);
1177         m_NormalFace = fnt.GetFaceName();
1178     }
1179     if (m_FixedFace.empty())
1180     {
1181         wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, false);
1182         m_FixedFace = fnt.GetFaceName();
1183     }
1184
1185     for (i = 0; i < m_NormalFonts->GetCount(); i++)
1186         dlg.NormalFont->Append((*m_NormalFonts)[i]);
1187     for (i = 0; i < m_FixedFonts->GetCount(); i++)
1188         dlg.FixedFont->Append((*m_FixedFonts)[i]);
1189     if (!m_NormalFace.empty())
1190         dlg.NormalFont->SetStringSelection(m_NormalFace);
1191     else
1192         dlg.NormalFont->SetSelection(0);
1193     if (!m_FixedFace.empty())
1194         dlg.FixedFont->SetStringSelection(m_FixedFace);
1195     else
1196         dlg.FixedFont->SetSelection(0);
1197     dlg.FontSize->SetValue(m_FontSize);
1198     dlg.UpdateTestWin();
1199
1200     if (dlg.ShowModal() == wxID_OK)
1201     {
1202         m_NormalFace = dlg.NormalFont->GetStringSelection();
1203         m_FixedFace = dlg.FixedFont->GetStringSelection();
1204         m_FontSize = dlg.FontSize->GetValue();
1205         SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize);
1206     }
1207 }
1208
1209
1210
1211 void wxHtmlHelpFrame::NotifyPageChanged()
1212 {
1213     if (m_UpdateContents && m_PagesHash)
1214     {
1215         wxString an = m_HtmlWin->GetOpenedAnchor();
1216         wxHtmlHelpHashData *ha;
1217         if (an.IsEmpty())
1218             ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1219         else
1220             ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1221         if (ha)
1222         {
1223             bool olduc = m_UpdateContents;
1224             m_UpdateContents = false;
1225             m_ContentsBox->SelectItem(ha->m_Id);
1226             m_ContentsBox->EnsureVisible(ha->m_Id);
1227             m_UpdateContents = olduc;
1228         }
1229     }
1230 }
1231
1232
1233
1234 /*
1235 EVENT HANDLING :
1236 */
1237
1238
1239 void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
1240 {
1241     // This saves one mouse click when using the
1242     // wxHTML for context sensitive help systems
1243 #ifndef __WXGTK__
1244     // NB: wxActivateEvent is a bit broken in wxGTK
1245     //     and is sometimes sent when it should not be
1246     if (event.GetActive() && m_HtmlWin)
1247         m_HtmlWin->SetFocus();
1248 #endif
1249
1250     event.Skip();
1251 }
1252
1253 void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
1254 {
1255     switch (event.GetId())
1256     {
1257         case wxID_HTML_BACK :
1258             m_HtmlWin->HistoryBack();
1259             NotifyPageChanged();
1260             break;
1261
1262         case wxID_HTML_FORWARD :
1263             m_HtmlWin->HistoryForward();
1264             NotifyPageChanged();
1265             break;
1266
1267         case wxID_HTML_UP :
1268             if (m_PagesHash)
1269             {
1270                 wxString an = m_HtmlWin->GetOpenedAnchor();
1271                 wxHtmlHelpHashData *ha;
1272                 if (an.IsEmpty())
1273                     ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1274                 else
1275                     ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1276                 if (ha && ha->m_Index > 0)
1277                 {
1278                     wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index - 1);
1279                     if (it->m_Page[0] != 0)
1280                     {
1281                         m_HtmlWin->LoadPage(it->GetFullPath());
1282                         NotifyPageChanged();
1283                     }
1284                 }
1285             }
1286             break;
1287
1288         case wxID_HTML_UPNODE :
1289             if (m_PagesHash)
1290             {
1291                 wxString an = m_HtmlWin->GetOpenedAnchor();
1292                 wxHtmlHelpHashData *ha;
1293                 if (an.IsEmpty())
1294                     ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1295                 else
1296                     ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1297                 if (ha && ha->m_Index > 0)
1298                 {
1299                     int level = m_Data->GetContents()[ha->m_Index].m_Level - 1;
1300                     wxHtmlContentsItem *it;
1301                     int ind = ha->m_Index - 1;
1302
1303                     it = m_Data->GetContents() + ind;
1304                     while (ind >= 0 && it->m_Level != level) ind--, it--;
1305                     if (ind >= 0)
1306                     {
1307                         if (it->m_Page[0] != 0)
1308                         {
1309                             m_HtmlWin->LoadPage(it->GetFullPath());
1310                             NotifyPageChanged();
1311                         }
1312                     }
1313                 }
1314             }
1315             break;
1316
1317         case wxID_HTML_DOWN :
1318             if (m_PagesHash)
1319             {
1320                 wxString an = m_HtmlWin->GetOpenedAnchor();
1321                 wxString adr;
1322                 wxHtmlHelpHashData *ha;
1323
1324                 if (an.IsEmpty()) adr = m_HtmlWin->GetOpenedPage();
1325                 else adr = m_HtmlWin->GetOpenedPage() + wxT("#") + an;
1326
1327                 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(adr);
1328
1329                 if (ha && ha->m_Index < m_Data->GetContentsCnt() - 1)
1330                 {
1331                     wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index + 1);
1332
1333                     while (it->GetFullPath() == adr) it++;
1334
1335                     if (it->m_Page[0] != 0)
1336                     {
1337                         m_HtmlWin->LoadPage(it->GetFullPath());
1338                         NotifyPageChanged();
1339                     }
1340                 }
1341             }
1342             break;
1343
1344         case wxID_HTML_PANEL :
1345             {
1346                 if (! (m_Splitter && m_NavigPan))
1347                     return ;
1348                 if (m_Splitter->IsSplit())
1349                 {
1350                     m_Cfg.sashpos = m_Splitter->GetSashPosition();
1351                     m_Splitter->Unsplit(m_NavigPan);
1352                     m_Cfg.navig_on = false;
1353                 }
1354                 else
1355                 {
1356                     m_NavigPan->Show();
1357                     m_HtmlWin->Show();
1358                     m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
1359                     m_Cfg.navig_on = true;
1360                 }
1361             }
1362             break;
1363
1364         case wxID_HTML_OPTIONS :
1365             OptionsDialog();
1366             break;
1367
1368         case wxID_HTML_BOOKMARKSADD :
1369             {
1370                 wxString item;
1371                 wxString url;
1372
1373                 item = m_HtmlWin->GetOpenedPageTitle();
1374                 url = m_HtmlWin->GetOpenedPage();
1375                 if (item == wxEmptyString)
1376                     item = url.AfterLast(wxT('/'));
1377                 if (m_BookmarksPages.Index(url) == wxNOT_FOUND)
1378                 {
1379                     m_Bookmarks->Append(item);
1380                     m_BookmarksNames.Add(item);
1381                     m_BookmarksPages.Add(url);
1382                 }
1383             }
1384             break;
1385
1386         case wxID_HTML_BOOKMARKSREMOVE :
1387             {
1388                 wxString item;
1389                 int pos;
1390
1391                 item = m_Bookmarks->GetStringSelection();
1392                 pos = m_BookmarksNames.Index(item);
1393                 if (pos != wxNOT_FOUND)
1394                 {
1395                     m_BookmarksNames.RemoveAt(pos);
1396                     m_BookmarksPages.RemoveAt(pos);
1397                     m_Bookmarks->Delete(m_Bookmarks->GetSelection());
1398                 }
1399             }
1400             break;
1401
1402 #if wxUSE_PRINTING_ARCHITECTURE
1403         case wxID_HTML_PRINT :
1404             {
1405                 if (m_Printer == NULL)
1406                     m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this);
1407                 if (!m_HtmlWin->GetOpenedPage())
1408                     wxLogWarning(_("Cannot print empty page."));
1409                 else
1410                     m_Printer->PrintFile(m_HtmlWin->GetOpenedPage());
1411             }
1412             break;
1413 #endif
1414
1415         case wxID_HTML_OPENFILE :
1416             {
1417                 wxString filemask = wxString(
1418                     _("HTML files (*.html;*.htm)|*.html;*.htm|")) +
1419                     _("Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|") +
1420                     _("HTML Help Project (*.hhp)|*.hhp|") +
1421 #if wxUSE_LIBMSPACK
1422                     _("Compressed HTML Help file (*.chm)|*.chm|") +
1423 #endif
1424                     _("All files (*.*)|*");
1425                 wxString s = wxFileSelector(_("Open HTML document"),
1426                                             wxEmptyString,
1427                                             wxEmptyString,
1428                                             wxEmptyString,
1429                                             filemask,
1430                                             wxOPEN | wxFILE_MUST_EXIST,
1431                                             this);
1432                 if (!s.IsEmpty())
1433                 {
1434                     wxString ext = s.Right(4).Lower();
1435                     if (ext == _T(".zip") || ext == _T(".htb") ||
1436 #if wxUSE_LIBMSPACK
1437                         ext == _T(".chm") ||
1438 #endif
1439                         ext == _T(".hhp"))
1440                     {
1441                         wxBusyCursor bcur;
1442                         m_Data->AddBook(s);
1443                         RefreshLists();
1444                     }
1445                     else
1446                         m_HtmlWin->LoadPage(s);
1447                 }
1448             }
1449             break;
1450     }
1451 }
1452
1453
1454
1455 void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event)
1456 {
1457     wxHtmlHelpTreeItemData *pg;
1458     wxHtmlContentsItem *it;
1459
1460     pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem());
1461
1462     if (pg && m_UpdateContents)
1463     {
1464         it = m_Data->GetContents() + (pg->m_Id);
1465         m_UpdateContents = false;
1466         if (it->m_Page[0] != 0)
1467             m_HtmlWin->LoadPage(it->GetFullPath());
1468         m_UpdateContents = true;
1469     }
1470 }
1471
1472
1473
1474 void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event))
1475 {
1476     wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_IndexList->GetClientData(m_IndexList->GetSelection());
1477     if (it->m_Page[0] != 0)
1478         m_HtmlWin->LoadPage(it->GetFullPath());
1479     NotifyPageChanged();
1480 }
1481
1482
1483 void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
1484 {
1485     wxString sr = m_IndexText->GetLineText(0);
1486     sr.MakeLower();
1487     if (sr == wxEmptyString)
1488     {
1489         OnIndexAll(event);
1490     }
1491     else
1492     {
1493         wxBusyCursor bcur;
1494         const wxChar *cstr = sr.c_str();
1495         wxChar mybuff[512];
1496         wxChar *ptr;
1497         bool first = true;
1498
1499         m_IndexList->Clear();
1500         int cnt = m_Data->GetIndexCnt();
1501         wxHtmlContentsItem* index = m_Data->GetIndex();
1502
1503         int displ = 0;
1504         for (int i = 0; i < cnt; i++)
1505         {
1506             wxStrncpy(mybuff, index[i].m_Name, 512);
1507             mybuff[511] = _T('\0');
1508             for (ptr = mybuff; *ptr != 0; ptr++)
1509                 if (*ptr >= _T('A') && *ptr <= _T('Z'))
1510                     *ptr -= (wxChar)(_T('A') - _T('a'));
1511             if (wxStrstr(mybuff, cstr) != NULL)
1512             {
1513                 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1514                 displ++;
1515                 if (first)
1516                 {
1517                     if (index[i].m_Page[0] != 0)
1518                         m_HtmlWin->LoadPage(index[i].GetFullPath());
1519                     NotifyPageChanged();
1520                     first = false;
1521                 }
1522             }
1523         }
1524
1525         wxString cnttext;
1526         cnttext.Printf(_("%i of %i"), displ, cnt);
1527         m_IndexCountInfo->SetLabel(cnttext);
1528
1529         m_IndexText->SetSelection(0, sr.Length());
1530         m_IndexText->SetFocus();
1531     }
1532 }
1533
1534 void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event))
1535 {
1536     wxBusyCursor bcur;
1537
1538     m_IndexList->Clear();
1539     int cnt = m_Data->GetIndexCnt();
1540     bool first = true;
1541     wxHtmlContentsItem* index = m_Data->GetIndex();
1542
1543     for (int i = 0; i < cnt; i++)
1544     {
1545         m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1546         if (first)
1547         {
1548             if (index[i].m_Page[0] != 0)
1549                 m_HtmlWin->LoadPage(index[i].GetFullPath());
1550             NotifyPageChanged();
1551             first = false;
1552         }
1553     }
1554
1555     wxString cnttext;
1556     cnttext.Printf(_("%i of %i"), cnt, cnt);
1557     m_IndexCountInfo->SetLabel(cnttext);
1558 }
1559
1560
1561 void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event))
1562 {
1563     wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList->GetClientData(m_SearchList->GetSelection());
1564     if (it)
1565     {
1566         if (it->m_Page[0] != 0)
1567             m_HtmlWin->LoadPage(it->GetFullPath());
1568         NotifyPageChanged();
1569     }
1570 }
1571
1572 void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event))
1573 {
1574     wxString sr = m_SearchText->GetLineText(0);
1575
1576     if (!sr.empty())
1577         KeywordSearch(sr, wxHELP_SEARCH_ALL);
1578 }
1579
1580 void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event))
1581 {
1582     wxString sr = m_Bookmarks->GetStringSelection();
1583
1584     if (sr != wxEmptyString && sr != _("(bookmarks)"))
1585     {
1586        m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]);
1587        NotifyPageChanged();
1588     }
1589 }
1590
1591 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
1592 {
1593     GetSize(&m_Cfg.w, &m_Cfg.h);
1594     GetPosition(&m_Cfg.x, &m_Cfg.y);
1595
1596 #ifdef __WXGTK__
1597     if (IsGrabbed())
1598     {
1599         RemoveGrab();
1600     }
1601 #endif
1602
1603     if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter->GetSashPosition();
1604
1605     if (m_Config)
1606         WriteCustomization(m_Config, m_ConfigRoot);
1607
1608     if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
1609     {
1610         ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
1611     }
1612
1613     evt.Skip();
1614 }
1615
1616 #ifdef __WXMAC__
1617 void wxHtmlHelpFrame::OnClose(wxCommandEvent& event)
1618 {
1619     Close(true);
1620 }
1621
1622 void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event)
1623 {
1624     wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2003, Vaclav Slavik et al"), wxT("HelpView"),
1625         wxICON_INFORMATION|wxOK, this);
1626 }
1627 #endif
1628
1629 BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
1630     EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate)
1631     EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpFrame::OnToolbar)
1632     EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar)
1633     EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpFrame::OnToolbar)
1634     EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpFrame::OnContentsSel)
1635     EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpFrame::OnIndexSel)
1636     EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpFrame::OnSearchSel)
1637     EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpFrame::OnSearch)
1638     EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpFrame::OnSearch)
1639     EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpFrame::OnIndexFind)
1640     EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpFrame::OnIndexFind)
1641     EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpFrame::OnIndexAll)
1642     EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpFrame::OnBookmarksSel)
1643     EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow)
1644 #ifdef __WXMAC__
1645     EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
1646     EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
1647 #endif
1648
1649 END_EVENT_TABLE()
1650
1651 #endif // wxUSE_WXHTML_HELP
1652