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