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