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