Commit | Line | Data |
---|---|---|
8ec2b484 | 1 | ///////////////////////////////////////////////////////////////////////////// |
8e3f3880 | 2 | // Name: src/html/helpfrm.cpp |
8ec2b484 | 3 | // Purpose: wxHtmlHelpFrame |
d5bb85a0 | 4 | // Notes: Based on htmlhelp.cpp, implementing a monolithic |
8ec2b484 HH |
5 | // HTML Help controller class, by Vaclav Slavik |
6 | // Author: Harm van der Heijden and Vaclav Slavik | |
69941f05 | 7 | // RCS-ID: $Id$ |
8ec2b484 | 8 | // Copyright: (c) Harm van der Heijden and Vaclav Slavik |
65571936 | 9 | // Licence: wxWindows licence |
8ec2b484 HH |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
c32bfc10 VS |
12 | // For compilers that support precompilation, includes "wx.h" |
13 | ||
8ec2b484 HH |
14 | #include "wx/wxprec.h" |
15 | ||
16 | #ifdef __BORLANDC__ | |
8e3f3880 | 17 | #pragma hdrstop |
8ec2b484 HH |
18 | #endif |
19 | ||
3379ed37 | 20 | #if wxUSE_WXHTML_HELP |
07b8d7ec | 21 | |
b4f4d3dd | 22 | #ifndef WX_PRECOMP |
8e3f3880 | 23 | #include "wx/object.h" |
ad9835c9 | 24 | #include "wx/dynarray.h" |
07b8d7ec VZ |
25 | #include "wx/intl.h" |
26 | #include "wx/log.h" | |
530ecef0 WS |
27 | #if wxUSE_STREAMS |
28 | #include "wx/stream.h" | |
29 | #endif | |
07b8d7ec | 30 | |
07b8d7ec VZ |
31 | #include "wx/sizer.h" |
32 | ||
33 | #include "wx/bmpbuttn.h" | |
34 | #include "wx/statbox.h" | |
35 | #include "wx/radiobox.h" | |
3b3dc801 | 36 | #include "wx/menu.h" |
9eddec69 | 37 | #include "wx/settings.h" |
c718e0b3 | 38 | #include "wx/msgdlg.h" |
fec9cc08 | 39 | #include "wx/textctrl.h" |
4e3e485b | 40 | #include "wx/toolbar.h" |
949c9f74 WS |
41 | #include "wx/choicdlg.h" |
42 | #include "wx/filedlg.h" | |
b4f4d3dd | 43 | #endif // WX_PRECOMP |
c718e0b3 | 44 | |
8ec2b484 | 45 | #include "wx/html/helpfrm.h" |
b4414c1f | 46 | #include "wx/html/helpctrl.h" |
8ec2b484 HH |
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" | |
83efdf33 | 55 | #include "wx/fontenum.h" |
f435c1f0 | 56 | #include "wx/artprov.h" |
c269cf62 | 57 | #include "wx/spinctrl.h" |
8ec2b484 | 58 | |
3755cfa6 | 59 | IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame) |
8ec2b484 | 60 | |
3755cfa6 JS |
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) | |
da4cc40c | 68 | #endif |
3755cfa6 | 69 | END_EVENT_TABLE() |
8ec2b484 HH |
70 | |
71 | wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title, | |
b4246849 VZ |
72 | int style, wxHtmlHelpData* data |
73 | #if wxUSE_CONFIG | |
74 | , wxConfigBase *config, const wxString& rootpath | |
75 | #endif // wxUSE_CONFIG | |
76 | ) | |
8ec2b484 HH |
77 | { |
78 | Init(data); | |
b4246849 VZ |
79 | Create(parent, id, title, style |
80 | #if wxUSE_CONFIG | |
81 | , config, rootpath | |
82 | #endif // wxUSE_CONFIG | |
83 | ); | |
8ec2b484 | 84 | } |
d5bb85a0 | 85 | |
8ec2b484 HH |
86 | void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) |
87 | { | |
3755cfa6 JS |
88 | // Simply pass the pointer on to the help window |
89 | m_Data = data; | |
90 | m_HtmlHelpWin = NULL; | |
d3b9f782 | 91 | m_helpController = NULL; |
bd45b3e1 | 92 | m_shouldPreventAppExit = false; |
8ec2b484 HH |
93 | } |
94 | ||
664d1729 VS |
95 | void wxHtmlHelpFrame::SetController(wxHtmlHelpController* controller) |
96 | { | |
97 | m_helpController = controller; | |
98 | if ( m_HtmlHelpWin ) | |
99 | m_HtmlHelpWin->SetController(controller); | |
100 | } | |
101 | ||
d5bb85a0 | 102 | // Create: builds the GUI components. |
3379ed37 | 103 | bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, |
b4246849 VZ |
104 | const wxString& WXUNUSED(title), int style |
105 | #if wxUSE_CONFIG | |
106 | , wxConfigBase *config, const wxString& rootpath | |
107 | #endif // wxUSE_CONFIG | |
108 | ) | |
8ec2b484 | 109 | { |
3755cfa6 | 110 | m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data); |
664d1729 | 111 | m_HtmlHelpWin->SetController(m_helpController); |
b4246849 VZ |
112 | #if wxUSE_CONFIG |
113 | if ( config ) | |
18fc6059 | 114 | m_HtmlHelpWin->UseConfig(config, rootpath); |
b4246849 | 115 | #endif // wxUSE_CONFIG |
03647350 | 116 | |
8e3f3880 | 117 | wxFrame::Create(parent, id, _("Help"), |
3755cfa6 | 118 | wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y), |
8e3f3880 | 119 | wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h), |
5229b11d | 120 | wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp")); |
3755cfa6 JS |
121 | #if wxUSE_STATUSBAR |
122 | CreateStatusBar(); | |
123 | #endif | |
8e3f3880 | 124 | m_HtmlHelpWin->Create(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, |
3755cfa6 | 125 | wxTAB_TRAVERSAL|wxNO_BORDER, style); |
8ec2b484 | 126 | |
3755cfa6 | 127 | GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y); |
5c172c17 | 128 | |
6c4a2734 | 129 | SetIcons(wxArtProvider::GetIconBundle(wxART_HELP, wxART_FRAME_ICON)); |
9ffdee80 | 130 | |
d9b21c9f JS |
131 | // On the Mac, each modeless frame must have a menubar. |
132 | // TODO: add more menu items, and perhaps add a style to show | |
133 | // the menubar: compulsory on the Mac, optional elsewhere. | |
134 | #ifdef __WXMAC__ | |
135 | wxMenuBar* menuBar = new wxMenuBar; | |
136 | ||
137 | wxMenu* fileMenu = new wxMenu; | |
138 | fileMenu->Append(wxID_HTML_OPENFILE, _("&Open...")); | |
d9b21c9f JS |
139 | fileMenu->AppendSeparator(); |
140 | fileMenu->Append(wxID_CLOSE, _("&Close")); | |
141 | ||
b05206c9 | 142 | wxMenu* helpMenu = new wxMenu; |
2d143b66 | 143 | helpMenu->Append(wxID_ABOUT, _("&About")); |
322a5b45 | 144 | // Ensures we don't get an empty help menu |
2d143b66 | 145 | helpMenu->Append(wxID_HELP_CONTENTS, _("&About")); |
d9b21c9f | 146 | |
c3eeb758 RD |
147 | menuBar->Append(fileMenu,_("&File")); |
148 | menuBar->Append(helpMenu,_("&Help")); | |
d9b21c9f JS |
149 | SetMenuBar(menuBar); |
150 | #endif | |
151 | ||
3755cfa6 | 152 | m_HtmlHelpWin->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat); |
67a99992 | 153 | #if wxUSE_STATUSBAR |
3755cfa6 | 154 | m_HtmlHelpWin->GetHtmlWindow()->SetRelatedStatusBar(0); |
8fbc9912 | 155 | #endif |
dabbc6a5 | 156 | return true; |
8ec2b484 HH |
157 | } |
158 | ||
159 | wxHtmlHelpFrame::~wxHtmlHelpFrame() | |
160 | { | |
b854b7b8 | 161 | } |
b854b7b8 | 162 | |
721ab905 VS |
163 | void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) |
164 | { | |
3755cfa6 JS |
165 | if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow()) |
166 | GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format); | |
721ab905 VS |
167 | m_TitleFormat = format; |
168 | } | |
169 | ||
8ec2b484 HH |
170 | /* |
171 | EVENT HANDLING : | |
172 | */ | |
173 | ||
174 | ||
d45bc436 RR |
175 | void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event) |
176 | { | |
177 | // This saves one mouse click when using the | |
178 | // wxHTML for context sensitive help systems | |
2b5f62a0 VZ |
179 | #ifndef __WXGTK__ |
180 | // NB: wxActivateEvent is a bit broken in wxGTK | |
181 | // and is sometimes sent when it should not be | |
3755cfa6 JS |
182 | if (event.GetActive() && m_HtmlHelpWin) |
183 | m_HtmlHelpWin->GetHtmlWindow()->SetFocus(); | |
2b5f62a0 | 184 | #endif |
fbd90401 VS |
185 | |
186 | event.Skip(); | |
d45bc436 RR |
187 | } |
188 | ||
3755cfa6 | 189 | void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt) |
8ec2b484 | 190 | { |
3755cfa6 | 191 | if (!IsIconized()) |
4f9297b0 | 192 | { |
3755cfa6 JS |
193 | GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h)); |
194 | GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y)); | |
8ec2b484 | 195 | } |
8ec2b484 | 196 | |
3755cfa6 JS |
197 | #ifdef __WXGTK__ |
198 | if (IsGrabbed()) | |
0646614d | 199 | { |
3755cfa6 | 200 | RemoveGrab(); |
0646614d | 201 | } |
3755cfa6 | 202 | #endif |
8ec2b484 | 203 | |
3755cfa6 JS |
204 | if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on) |
205 | m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition(); | |
8ec2b484 | 206 | |
345c78ca | 207 | if (m_helpController && wxDynamicCast(m_helpController, wxHtmlHelpController)) |
4f9297b0 | 208 | { |
3755cfa6 | 209 | ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt); |
4f9297b0 | 210 | } |
f0b6a33f | 211 | |
3755cfa6 | 212 | evt.Skip(); |
f0b6a33f VS |
213 | } |
214 | ||
3755cfa6 JS |
215 | // Make the help controller's frame 'modal' if |
216 | // needed | |
217 | void wxHtmlHelpFrame::AddGrabIfNeeded() | |
f0b6a33f | 218 | { |
3755cfa6 JS |
219 | // So far, wxGTK only |
220 | #ifdef __WXGTK__ | |
8e3f3880 WS |
221 | bool needGrab = false; |
222 | ||
3755cfa6 JS |
223 | // Check if there are any modal windows present, |
224 | // in which case we need to add a grab. | |
3e63c315 MW |
225 | for ( wxWindowList::iterator it = wxTopLevelWindows.begin(); |
226 | it != wxTopLevelWindows.end(); | |
227 | ++it ) | |
4f9297b0 | 228 | { |
3e63c315 | 229 | wxWindow *win = *it; |
3755cfa6 | 230 | wxDialog *dialog = wxDynamicCast(win, wxDialog); |
8ec2b484 | 231 | |
3755cfa6 | 232 | if (dialog && dialog->IsModal()) |
8e3f3880 | 233 | needGrab = true; |
0646614d | 234 | } |
8ec2b484 | 235 | |
3755cfa6 JS |
236 | if (needGrab) |
237 | AddGrab(); | |
238 | #endif // __WXGTK__ | |
8ec2b484 HH |
239 | } |
240 | ||
b4246849 | 241 | #if wxUSE_CONFIG |
3755cfa6 JS |
242 | // For compatibility |
243 | void wxHtmlHelpFrame::UseConfig(wxConfigBase *config, const wxString& rootPath) | |
382e6efe | 244 | { |
3755cfa6 JS |
245 | if (m_HtmlHelpWin) |
246 | m_HtmlHelpWin->UseConfig(config, rootPath); | |
8ec2b484 | 247 | } |
b4246849 | 248 | #endif // wxUSE_CONFIG |
8ec2b484 | 249 | |
bd45b3e1 VZ |
250 | void wxHtmlHelpFrame::SetShouldPreventAppExit(bool enable) |
251 | { | |
252 | m_shouldPreventAppExit = enable; | |
253 | } | |
254 | ||
d9b21c9f | 255 | #ifdef __WXMAC__ |
8a088306 | 256 | void wxHtmlHelpFrame::OnClose(wxCommandEvent& WXUNUSED(event)) |
d9b21c9f | 257 | { |
dabbc6a5 | 258 | Close(true); |
d9b21c9f JS |
259 | } |
260 | ||
8a088306 | 261 | void wxHtmlHelpFrame::OnAbout(wxCommandEvent& WXUNUSED(event)) |
d9b21c9f | 262 | { |
3755cfa6 | 263 | wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"), |
d9b21c9f JS |
264 | wxICON_INFORMATION|wxOK, this); |
265 | } | |
266 | #endif | |
267 | ||
3379ed37 | 268 | #endif // wxUSE_WXHTML_HELP |