]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/helpfrm.cpp
added closing parenthesis inside comment, no real changes
[wxWidgets.git] / src / html / helpfrm.cpp
index abcdb10dcf3a7ab39211dd6e22efcd509f678176..0e107c11cc19844ef6a1da4389d6d4e79478185a 100644 (file)
@@ -59,6 +59,7 @@
 #include "wx/spinctrl.h"
 #include "wx/dynarray.h"
 #include "wx/choicdlg.h"
+#include "wx/settings.h"
 
 // what is considered "small index"?
 #define INDEX_IS_SMALL 100
@@ -110,7 +111,11 @@ class wxHtmlHelpHashData : public wxObject
 class wxHtmlHelpHtmlWindow : public wxHtmlWindow
 {
     public:
-        wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {}
+        wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent)
+            : wxHtmlWindow(parent), m_Frame(fr)
+        {
+            SetStandardFonts();
+        }
 
         virtual void OnLinkClicked(const wxHtmlLinkInfo& link)
         {
@@ -131,7 +136,7 @@ class wxHtmlHelpHtmlWindow : public wxHtmlWindow
 // wxHtmlHelpFrame::m_mergedIndex
 //---------------------------------------------------------------------------
 
-WX_DEFINE_ARRAY(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray);
+WX_DEFINE_ARRAY_PTR(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray);
 
 struct wxHtmlHelpMergedIndexItem
 {
@@ -154,12 +159,12 @@ void wxHtmlHelpFrame::UpdateMergedIndex()
     size_t len = items.size();
 
     wxHtmlHelpMergedIndexItem *history[128] = {NULL};
-    
+
     for (size_t i = 0; i < len; i++)
     {
         const wxHtmlHelpDataItem& item = items[i];
         wxASSERT_MSG( item.level < 128, _T("nested index entries too deep") );
-        
+
         if (history[item.level] &&
             history[item.level]->items[0]->name == item.name)
         {
@@ -175,10 +180,10 @@ void wxHtmlHelpFrame::UpdateMergedIndex()
             mi->parent = (item.level == 0) ? NULL : history[item.level - 1];
             history[item.level] = mi;
             merged.Add(mi);
-        }        
+        }
     }
 }
-    
+
 
 //---------------------------------------------------------------------------
 // wxHtmlHelpFrame
@@ -298,9 +303,15 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
     m_hfStyle = style;
 
     wxImageList *ContentsImageList = new wxImageList(16, 16);
-    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, wxART_HELP_BROWSER));
-    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, wxART_HELP_BROWSER));
-    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, wxART_HELP_BROWSER));
+    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK,
+                                                  wxART_HELP_BROWSER,
+                                                  wxSize(16, 16)));
+    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER,
+                                                  wxART_HELP_BROWSER,
+                                                  wxSize(16, 16)));
+    ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE,
+                                                  wxART_HELP_BROWSER,
+                                                  wxSize(16, 16)));
 
     // Do the config in two steps. We read the HtmlWindow customization after we
     // create the window.
@@ -328,6 +339,8 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
 
     wxMenu* helpMenu = new wxMenu;
     helpMenu->Append(wxID_ABOUT, _("&About..."));
+    // Ensures we don't get an empty help menu
+    helpMenu->Append(wxID_HELP_CONTENTS, _("&About..."));
 
     menuBar->Append(fileMenu,_("&File"));
     menuBar->Append(helpMenu,_("&Help"));
@@ -336,7 +349,9 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
 
     int notebook_page = 0;
 
+#if wxUSE_STATUSBAR
     CreateStatusBar();
+#endif // wxUSE_STATUSBAR
 
 #if wxUSE_TOOLBAR
     // toolbar?
@@ -375,7 +390,9 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
     }
 
     m_HtmlWin->SetRelatedFrame(this, m_TitleFormat);
+#if wxUSE_STATUSBAR
     m_HtmlWin->SetRelatedStatusBar(0);
+#endif // wxUSE_STATUSBAR
     if ( m_Config )
         m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot);
 
@@ -403,10 +420,10 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
             wxBitmapButton *bmpbt1, *bmpbt2;
             bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD,
                                  wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK,
-                                                          wxART_HELP_BROWSER));
+                                                          wxART_BUTTON));
             bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE,
                                  wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK,
-                                                          wxART_HELP_BROWSER));
+                                                          wxART_BUTTON));
 #if wxUSE_TOOLTIPS
             bmpbt1->SetToolTip(_("Add current page to bookmarks"));
             bmpbt2->SetToolTip(_("Remove current page from bookmarks"));
@@ -423,9 +440,16 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
 
         m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL,
                                        wxDefaultPosition, wxDefaultSize,
+#ifdef __WXGTK20__
                                        wxSUNKEN_BORDER |
                                        wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
-                                       wxTR_LINES_AT_ROOT);
+                                       wxTR_NO_LINES
+#else
+                                       wxSUNKEN_BORDER |
+                                       wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
+                                       wxTR_LINES_AT_ROOT
+#endif
+                                       );
 
         m_ContentsBox->AssignImageList(ContentsImageList);
 
@@ -490,7 +514,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
                                       wxDefaultPosition, wxDefaultSize,
                                       wxTE_PROCESS_ENTER);
         m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE,
-                                      wxDefaultPosition, wxDefaultSize);
+                                      wxDefaultPosition, wxSize(125,-1));
         m_SearchCaseSensitive = new wxCheckBox(dummy, wxID_ANY, _("Case sensitive"));
         m_SearchWholeWords = new wxCheckBox(dummy, wxID_ANY, _("Whole words only"));
         m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search"));
@@ -553,6 +577,8 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
 
 wxHtmlHelpFrame::~wxHtmlHelpFrame()
 {
+    delete m_mergedIndex;
+
     // PopEventHandler(); // wxhtmlhelpcontroller (not any more!)
     if (m_DataCreated)
         delete m_Data;
@@ -573,23 +599,23 @@ wxHtmlHelpFrame::~wxHtmlHelpFrame()
 void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
 {
     wxBitmap wpanelBitmap =
-        wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_TOOLBAR);
     wxBitmap wbackBitmap =
-        wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_TOOLBAR);
     wxBitmap wforwardBitmap =
-        wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_TOOLBAR);
     wxBitmap wupnodeBitmap =
-        wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_TOOLBAR);
     wxBitmap wupBitmap =
-        wxArtProvider::GetBitmap(wxART_GO_UP, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_GO_UP, wxART_TOOLBAR);
     wxBitmap wdownBitmap =
-        wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_TOOLBAR);
     wxBitmap wopenBitmap =
-        wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_TOOLBAR);
     wxBitmap wprintBitmap =
-        wxArtProvider::GetBitmap(wxART_PRINT, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_PRINT, wxART_TOOLBAR);
     wxBitmap woptionsBitmap =
-        wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_HELP_BROWSER);
+        wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_TOOLBAR);
 
     wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() &&
                    wforwardBitmap.Ok() && wupnodeBitmap.Ok() &&
@@ -600,26 +626,26 @@ void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
 
 
     toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Show/hide navigation panel"));
 
     toolBar->AddSeparator();
     toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Go back"));
     toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Go forward"));
     toolBar->AddSeparator();
 
     toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Go one level up in document hierarchy"));
     toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Previous page"));
     toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Next page"));
 
     if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES))
@@ -627,19 +653,19 @@ void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
 
     if (style & wxHF_OPEN_FILES)
         toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap,
-                           false, -1, -1, (wxObject *) NULL,
+                           false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                            _("Open HTML document"));
 
 #if wxUSE_PRINTING_ARCHITECTURE
     if (style & wxHF_PRINT)
         toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap,
-                           false, -1, -1, (wxObject *) NULL,
+                           false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                            _("Print this page"));
 #endif
 
     toolBar->AddSeparator();
     toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap,
-                       false, -1, -1, (wxObject *) NULL,
+                       false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
                        _("Display options dialog"));
 }
 #endif //wxUSE_TOOLBAR
@@ -890,7 +916,7 @@ bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword,
 
             case wxHELP_SEARCH_INDEX:
             {
-                wxHtmlHelpMergedIndexItem* it = 
+                wxHtmlHelpMergedIndexItem* it =
                     (wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0);
                 if (it)
                     DisplayIndexItem(it);
@@ -913,9 +939,9 @@ void wxHtmlHelpFrame::CreateContents()
         WX_CLEAR_HASH_TABLE(*m_PagesHash);
         delete m_PagesHash;
     }
-    
+
     const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray();
-    
+
     size_t cnt = contents.size();
 
     m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * cnt);
@@ -1178,11 +1204,11 @@ public:
         sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:")));
 
         sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
-                      wxSize(200, -1),
+                      wxSize(200, wxDefaultCoord),
                       0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
 
         sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
-                      wxSize(200, -1),
+                      wxSize(200, wxDefaultCoord),
                       0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
 
         sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY));
@@ -1198,9 +1224,9 @@ public:
 
         wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
         wxButton *ok;
-        sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10);
+        sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10);
         ok->SetDefault();
-        sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10);
+        sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10);
         topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
 
         SetSizer(topsizer);
@@ -1271,7 +1297,7 @@ void wxHtmlHelpFrame::OptionsDialog()
         enu.EnumerateFacenames();
         m_NormalFonts = new wxArrayString;
         *m_NormalFonts = *enu.GetFacenames();
-        m_NormalFonts->Sort(wxStringSortAscending);
+        m_NormalFonts->Sort(); // ascending sort
     }
     if (m_FixedFonts == NULL)
     {
@@ -1279,7 +1305,7 @@ void wxHtmlHelpFrame::OptionsDialog()
         enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/);
         m_FixedFonts = new wxArrayString;
         *m_FixedFonts = *enu.GetFacenames();
-        m_FixedFonts->Sort(wxStringSortAscending);
+        m_FixedFonts->Sort(); // ascending sort
     }
 
     // VS: We want to show the font that is actually used by wxHtmlWindow.
@@ -1411,15 +1437,15 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
                     ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
                 if (ha && ha->m_Index > 0)
                 {
-                    int level = 
+                    int level =
                         m_Data->GetContentsArray()[ha->m_Index].level - 1;
                     int ind = ha->m_Index - 1;
 
-                    const wxHtmlHelpDataItem *it = 
+                    const wxHtmlHelpDataItem *it =
                         &m_Data->GetContentsArray()[ind];
                     while (ind >= 0 && it->level != level)
                     {
-                        ind--, it--;
+                        ind--;
                         it = &m_Data->GetContentsArray()[ind];
                     }
                     if (ind >= 0)
@@ -1593,7 +1619,7 @@ void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event)
 
 void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event))
 {
-    wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*) 
+    wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*)
         m_IndexList->GetClientData(m_IndexList->GetSelection());
     if (it)
         DisplayIndexItem(it);
@@ -1626,8 +1652,13 @@ void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
 
                 if (displ++ == 0)
                 {
-                    m_IndexList->SetSelection(0);
-                    DisplayIndexItem(&index[i]);
+                    // don't automatically show topic selector if this
+                    // item points to multiple pages:
+                    if (index[i].items.size() == 1)
+                    {
+                        m_IndexList->SetSelection(0);
+                        DisplayIndexItem(&index[i]);
+                    }
                 }
 
                 // if this is nested item of the index, show its parent(s)
@@ -1636,7 +1667,7 @@ void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
                 wxHtmlHelpMergedIndexItem *parent = index[i].parent;
                 while (parent)
                 {
-                    if (pos == 0 || 
+                    if (pos == 0 ||
                         (index.Index(*(wxHtmlHelpMergedIndexItem*)m_IndexList->GetClientData(pos-1))) < index.Index(*parent))
                     {
                         m_IndexList->Insert(parent->name,
@@ -1645,6 +1676,19 @@ void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
                     }
                     else break;
                 }
+
+                // finally, it the item we just added is itself a parent for
+                // other items, show them as well, because they are refinements
+                // of the displayed index entry (i.e. it is implicitly contained
+                // in them: "foo" with parent "bar" reads as "bar, foo"):
+                int level = index[i].items[0]->level;
+                i++;
+                while (i < cnt && index[i].items[0]->level > level)
+                {
+                    m_IndexList->Append(index[i].name, (char*)(&index[i]));
+                    i++;
+                }
+                i--;
             }
         }
 
@@ -1671,7 +1715,12 @@ void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event))
         m_IndexList->Append(index[i].name, (char*)(&index[i]));
         if (first)
         {
-            DisplayIndexItem(&index[i]);
+            // don't automatically show topic selector if this
+            // item points to multiple pages:
+            if (index[i].items.size() == 1)
+            {
+                DisplayIndexItem(&index[i]);
+            }
             first = false;
         }
     }
@@ -1768,6 +1817,7 @@ BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
 #ifdef __WXMAC__
     EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
     EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
+    EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout)
 #endif
 
 END_EVENT_TABLE()