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 WX_PRECOMP
  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 // WX_PRECOMP
  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 void wxHtmlHelpFrame::SetController(wxHtmlHelpController* controller)
  88 {
  89     m_helpController = controller;
  90     if ( m_HtmlHelpWin )
  91         m_HtmlHelpWin->SetController(controller);
  92 }
  93
  94 // Create: builds the GUI components.
  95 bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
  96                              const wxString& WXUNUSED(title), int style,
  97                              wxConfigBase *config, const wxString& rootpath)
  98 {
  99     m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data);
 100     m_HtmlHelpWin->SetController(m_helpController);
 101     if ( config)
 102         m_HtmlHelpWin->UseConfig(config, rootpath);
 103
 104     wxFrame::Create(parent, id, _("Help"),
 105                     wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y),
 106                     wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h),
 107                     wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp"));
 108 #if wxUSE_STATUSBAR
 109     CreateStatusBar();
 110 #endif
 111     m_HtmlHelpWin->Create(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 112         wxTAB_TRAVERSAL|wxNO_BORDER, style);
 113
 114     GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y);
 115
 116     SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER));
 117
 118     // On the Mac, each modeless frame must have a menubar.
 119     // TODO: add more menu items, and perhaps add a style to show
 120     // the menubar: compulsory on the Mac, optional elsewhere.
 121 #ifdef __WXMAC__
 122     wxMenuBar* menuBar = new wxMenuBar;
 123
 124     wxMenu* fileMenu = new wxMenu;
 125     fileMenu->Append(wxID_HTML_OPENFILE, _("&Open..."));
 126     fileMenu->AppendSeparator();
 127     fileMenu->Append(wxID_CLOSE, _("&Close"));
 128
 129     wxMenu* helpMenu = new wxMenu;
 130     helpMenu->Append(wxID_ABOUT, _("&About..."));
 131     // Ensures we don't get an empty help menu
 132     helpMenu->Append(wxID_HELP_CONTENTS, _("&About..."));
 133
 134     menuBar->Append(fileMenu,_("&File"));
 135     menuBar->Append(helpMenu,_("&Help"));
 136     SetMenuBar(menuBar);
 137 #endif
 138
 139     m_HtmlHelpWin->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat);
 140 #if wxUSE_STATUSBAR
 141     m_HtmlHelpWin->GetHtmlWindow()->SetRelatedStatusBar(0);
 142 #endif
 143     return true;
 144 }
 145
 146 wxHtmlHelpFrame::~wxHtmlHelpFrame()
 147 {
 148 }
 149
 150 void wxHtmlHelpFrame::SetTitleFormat(const wxString& format)
 151 {
 152     if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow())
 153         GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format);
 154     m_TitleFormat = format;
 155 }
 156
 157 /*
 158 EVENT HANDLING :
 159 */
 160
 161
 162 void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
 163 {
 164     // This saves one mouse click when using the
 165     // wxHTML for context sensitive help systems
 166 #ifndef __WXGTK__
 167     // NB: wxActivateEvent is a bit broken in wxGTK
 168     //     and is sometimes sent when it should not be
 169     if (event.GetActive() && m_HtmlHelpWin)
 170         m_HtmlHelpWin->GetHtmlWindow()->SetFocus();
 171 #endif
 172
 173     event.Skip();
 174 }
 175
 176 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
 177 {
 178     if (!IsIconized())
 179     {
 180         GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h));
 181         GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y));
 182     }
 183
 184 #ifdef __WXGTK__
 185     if (IsGrabbed())
 186     {
 187         RemoveGrab();
 188     }
 189 #endif
 190
 191     if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on)
 192         m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition();
 193
 194     if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
 195     {
 196         ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
 197     }
 198
 199     evt.Skip();
 200 }
 201
 202 // Make the help controller's frame 'modal' if
 203 // needed
 204 void wxHtmlHelpFrame::AddGrabIfNeeded()
 205 {
 206     // So far, wxGTK only
 207 #ifdef __WXGTK__
 208     bool needGrab = false;
 209
 210     // Check if there are any modal windows present,
 211     // in which case we need to add a grab.
 212     for ( wxWindowList::iterator it = wxTopLevelWindows.begin();
 213           it != wxTopLevelWindows.end();
 214           ++it )
 215     {
 216         wxWindow *win = *it;
 217         wxDialog *dialog = wxDynamicCast(win, wxDialog);
 218
 219         if (dialog && dialog->IsModal())
 220             needGrab = true;
 221     }
 222
 223     if (needGrab)
 224         AddGrab();
 225 #endif // __WXGTK__
 226 }
 227
 228 // For compatibility
 229 void wxHtmlHelpFrame::UseConfig(wxConfigBase *config, const wxString& rootPath)
 230 {
 231     if (m_HtmlHelpWin)
 232         m_HtmlHelpWin->UseConfig(config, rootPath);
 233 }
 234
 235 #ifdef __WXMAC__
 236 void wxHtmlHelpFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 237 {
 238     Close(true);
 239 }
 240
 241 void wxHtmlHelpFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 242 {
 243     wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"),
 244         wxICON_INFORMATION|wxOK, this);
 245 }
 246 #endif
 247
 248 #endif // wxUSE_WXHTML_HELP