src/html/helpfrm.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/html/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 // For compilers that support precompilation, includes "wx.h"
  13
  14 #include "wx/wxprec.h"
  15
  16 #ifdef __BORLANDC__
  17     #pragma hdrstop
  18 #endif
  19
  20 #if wxUSE_WXHTML_HELP
  21
  22 #ifndef WXPRECOMP
  23     #include "wx/object.h"
  24     #include "wx/dynarray.h"
  25     #include "wx/intl.h"
  26     #include "wx/log.h"
  27     #if wxUSE_STREAMS
  28         #include "wx/stream.h"
  29     #endif
  30
  31     #include "wx/sizer.h"
  32
  33     #include "wx/bmpbuttn.h"
  34     #include "wx/statbox.h"
  35     #include "wx/radiobox.h"
  36     #include "wx/menu.h"
  37     #include "wx/settings.h"
  38     #include "wx/msgdlg.h"
  39     #include "wx/textctrl.h"
  40     #include "wx/toolbar.h"
  41     #include "wx/choicdlg.h"
  42     #include "wx/filedlg.h"
  43 #endif // WXPRECOMP
  44
  45 #include "wx/html/helpfrm.h"
  46 #include "wx/html/helpctrl.h"
  47 #include "wx/notebook.h"
  48 #include "wx/imaglist.h"
  49 #include "wx/treectrl.h"
  50 #include "wx/tokenzr.h"
  51 #include "wx/wfstream.h"
  52 #include "wx/html/htmlwin.h"
  53 #include "wx/busyinfo.h"
  54 #include "wx/progdlg.h"
  55 #include "wx/fontenum.h"
  56 #include "wx/artprov.h"
  57 #include "wx/spinctrl.h"
  58
  59 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame)
  60
  61 BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
  62     EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate)
  63     EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow)
  64 #ifdef __WXMAC__
  65     EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
  66     EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
  67     EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout)
  68 #endif
  69 END_EVENT_TABLE()
  70
  71 wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title,
  72                                  int style, wxHtmlHelpData* data,
  73                                  wxConfigBase *config, const wxString& rootpath)
  74 {
  75     Init(data);
  76     Create(parent, id, title, style, config, rootpath);
  77 }
  78
  79 void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
  80 {
  81     // Simply pass the pointer on to the help window
  82     m_Data = data;
  83     m_HtmlHelpWin = NULL;
  84     m_helpController = (wxHtmlHelpController*) NULL;
  85 }
  86
  87 // Create: builds the GUI components.
  88 bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
  89                              const wxString& WXUNUSED(title), int style,
  90                              wxConfigBase *config, const wxString& rootpath)
  91 {
  92     m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data);
  93     if ( config)
  94         m_HtmlHelpWin->UseConfig(config, rootpath);
  95
  96     wxFrame::Create(parent, id, _("Help"),
  97                     wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y),
  98                     wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h),
  99                     wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp"));
 100 #if wxUSE_STATUSBAR
 101     CreateStatusBar();
 102 #endif
 103     m_HtmlHelpWin->Create(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 104         wxTAB_TRAVERSAL|wxNO_BORDER, style);
 105
 106     GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y);
 107
 108     SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER));
 109
 110     // On the Mac, each modeless frame must have a menubar.
 111     // TODO: add more menu items, and perhaps add a style to show
 112     // the menubar: compulsory on the Mac, optional elsewhere.
 113 #ifdef __WXMAC__
 114     wxMenuBar* menuBar = new wxMenuBar;
 115
 116     wxMenu* fileMenu = new wxMenu;
 117     fileMenu->Append(wxID_HTML_OPENFILE, _("&Open..."));
 118     fileMenu->AppendSeparator();
 119     fileMenu->Append(wxID_CLOSE, _("&Close"));
 120
 121     wxMenu* helpMenu = new wxMenu;
 122     helpMenu->Append(wxID_ABOUT, _("&About..."));
 123     // Ensures we don't get an empty help menu
 124     helpMenu->Append(wxID_HELP_CONTENTS, _("&About..."));
 125
 126     menuBar->Append(fileMenu,_("&File"));
 127     menuBar->Append(helpMenu,_("&Help"));
 128     SetMenuBar(menuBar);
 129 #endif
 130
 131     m_HtmlHelpWin->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat);
 132 #if wxUSE_STATUSBAR
 133     m_HtmlHelpWin->GetHtmlWindow()->SetRelatedStatusBar(0);
 134 #endif
 135     return true;
 136 }
 137
 138 wxHtmlHelpFrame::~wxHtmlHelpFrame()
 139 {
 140 }
 141
 142 void wxHtmlHelpFrame::SetTitleFormat(const wxString& format)
 143 {
 144     if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow())
 145         GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format);
 146     m_TitleFormat = format;
 147 }
 148
 149 /*
 150 EVENT HANDLING :
 151 */
 152
 153
 154 void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
 155 {
 156     // This saves one mouse click when using the
 157     // wxHTML for context sensitive help systems
 158 #ifndef __WXGTK__
 159     // NB: wxActivateEvent is a bit broken in wxGTK
 160     //     and is sometimes sent when it should not be
 161     if (event.GetActive() && m_HtmlHelpWin)
 162         m_HtmlHelpWin->GetHtmlWindow()->SetFocus();
 163 #endif
 164
 165     event.Skip();
 166 }
 167
 168 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
 169 {
 170     if (!IsIconized())
 171     {
 172         GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h));
 173         GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y));
 174     }
 175
 176 #ifdef __WXGTK__
 177     if (IsGrabbed())
 178     {
 179         RemoveGrab();
 180     }
 181 #endif
 182
 183     if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on)
 184         m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition();
 185
 186     if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
 187     {
 188         ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
 189     }
 190
 191     evt.Skip();
 192 }
 193
 194 // Make the help controller's frame 'modal' if
 195 // needed
 196 void wxHtmlHelpFrame::AddGrabIfNeeded()
 197 {
 198     // So far, wxGTK only
 199 #ifdef __WXGTK__
 200     bool needGrab = false;
 201
 202     // Check if there are any modal windows present,
 203     // in which case we need to add a grab.
 204     for ( wxWindowList::iterator it = wxTopLevelWindows.begin();
 205           it != wxTopLevelWindows.end();
 206           ++it )
 207     {
 208         wxWindow *win = *it;
 209         wxDialog *dialog = wxDynamicCast(win, wxDialog);
 210
 211         if (dialog && dialog->IsModal())
 212             needGrab = true;
 213     }
 214
 215     if (needGrab)
 216         AddGrab();
 217 #endif // __WXGTK__
 218 }
 219
 220 // For compatibility
 221 void wxHtmlHelpFrame::UseConfig(wxConfigBase *config, const wxString& rootPath)
 222 {
 223     if (m_HtmlHelpWin)
 224         m_HtmlHelpWin->UseConfig(config, rootPath);
 225 }
 226
 227 #ifdef __WXMAC__
 228 void wxHtmlHelpFrame::OnClose(wxCommandEvent& event)
 229 {
 230     Close(true);
 231 }
 232
 233 void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event)
 234 {
 235     wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"),
 236         wxICON_INFORMATION|wxOK, this);
 237 }
 238 #endif
 239
 240 #endif // wxUSE_WXHTML_HELP