]>
git.saurik.com Git - wxWidgets.git/blob - 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
8 // Copyright: (c) Harm van der Heijden and Vaclav Slavik
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx.h"
14 #include "wx/wxprec.h"
23 #include "wx/object.h"
24 #include "wx/dynarray.h"
28 #include "wx/stream.h"
33 #include "wx/bmpbuttn.h"
34 #include "wx/statbox.h"
35 #include "wx/radiobox.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"
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"
59 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame
, wxFrame
)
61 BEGIN_EVENT_TABLE(wxHtmlHelpFrame
, wxFrame
)
62 EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate
)
63 EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow
)
65 EVT_MENU(wxID_CLOSE
, wxHtmlHelpFrame::OnClose
)
66 EVT_MENU(wxID_ABOUT
, wxHtmlHelpFrame::OnAbout
)
67 EVT_MENU(wxID_HELP_CONTENTS
, wxHtmlHelpFrame::OnAbout
)
71 wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow
* parent
, wxWindowID id
, const wxString
& title
,
72 int style
, wxHtmlHelpData
* data
74 , wxConfigBase
*config
, const wxString
& rootpath
75 #endif // wxUSE_CONFIG
79 Create(parent
, id
, title
, style
82 #endif // wxUSE_CONFIG
86 void wxHtmlHelpFrame::Init(wxHtmlHelpData
* data
)
88 // Simply pass the pointer on to the help window
91 m_helpController
= NULL
;
92 m_shouldPreventAppExit
= false;
95 void wxHtmlHelpFrame::SetController(wxHtmlHelpController
* controller
)
97 m_helpController
= controller
;
99 m_HtmlHelpWin
->SetController(controller
);
102 // Create: builds the GUI components.
103 bool wxHtmlHelpFrame::Create(wxWindow
* parent
, wxWindowID id
,
104 const wxString
& WXUNUSED(title
), int style
106 , wxConfigBase
*config
, const wxString
& rootpath
107 #endif // wxUSE_CONFIG
110 m_HtmlHelpWin
= new wxHtmlHelpWindow(m_Data
);
111 m_HtmlHelpWin
->SetController(m_helpController
);
114 m_HtmlHelpWin
->UseConfig(config
, rootpath
);
115 #endif // wxUSE_CONFIG
117 wxFrame::Create(parent
, id
, _("Help"),
118 wxPoint(m_HtmlHelpWin
->GetCfgData().x
, m_HtmlHelpWin
->GetCfgData().y
),
119 wxSize(m_HtmlHelpWin
->GetCfgData().w
, m_HtmlHelpWin
->GetCfgData().h
),
120 wxDEFAULT_FRAME_STYLE
, wxT("wxHtmlHelp"));
124 m_HtmlHelpWin
->Create(this, wxID_ANY
, wxDefaultPosition
, wxDefaultSize
,
125 wxTAB_TRAVERSAL
|wxNO_BORDER
, style
);
127 GetPosition(& (m_HtmlHelpWin
->GetCfgData().x
), & (m_HtmlHelpWin
->GetCfgData()).y
);
129 SetIcons(wxArtProvider::GetIconBundle(wxART_HELP
, wxART_FRAME_ICON
));
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.
135 wxMenuBar
* menuBar
= new wxMenuBar
;
137 wxMenu
* fileMenu
= new wxMenu
;
138 fileMenu
->Append(wxID_HTML_OPENFILE
, _("&Open..."));
139 fileMenu
->AppendSeparator();
140 fileMenu
->Append(wxID_CLOSE
, _("&Close"));
142 wxMenu
* helpMenu
= new wxMenu
;
143 helpMenu
->Append(wxID_ABOUT
, _("&About"));
144 // Ensures we don't get an empty help menu
145 helpMenu
->Append(wxID_HELP_CONTENTS
, _("&About"));
147 menuBar
->Append(fileMenu
,_("&File"));
148 menuBar
->Append(helpMenu
,_("&Help"));
152 m_HtmlHelpWin
->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat
);
154 m_HtmlHelpWin
->GetHtmlWindow()->SetRelatedStatusBar(0);
159 wxHtmlHelpFrame::~wxHtmlHelpFrame()
163 void wxHtmlHelpFrame::SetTitleFormat(const wxString
& format
)
165 if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow())
166 GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format
);
167 m_TitleFormat
= format
;
175 void wxHtmlHelpFrame::OnActivate(wxActivateEvent
& event
)
177 // This saves one mouse click when using the
178 // wxHTML for context sensitive help systems
180 // NB: wxActivateEvent is a bit broken in wxGTK
181 // and is sometimes sent when it should not be
182 if (event
.GetActive() && m_HtmlHelpWin
)
183 m_HtmlHelpWin
->GetHtmlWindow()->SetFocus();
189 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent
& evt
)
193 GetSize(& (m_HtmlHelpWin
->GetCfgData().w
), &(m_HtmlHelpWin
->GetCfgData().h
));
194 GetPosition(& (m_HtmlHelpWin
->GetCfgData().x
), & (m_HtmlHelpWin
->GetCfgData().y
));
204 if (m_HtmlHelpWin
->GetSplitterWindow() && m_HtmlHelpWin
->GetCfgData().navig_on
)
205 m_HtmlHelpWin
->GetCfgData().sashpos
= m_HtmlHelpWin
->GetSplitterWindow()->GetSashPosition();
207 if (m_helpController
&& m_helpController
->IsKindOf(CLASSINFO(wxHtmlHelpController
)))
209 ((wxHtmlHelpController
*) m_helpController
)->OnCloseFrame(evt
);
215 // Make the help controller's frame 'modal' if
217 void wxHtmlHelpFrame::AddGrabIfNeeded()
219 // So far, wxGTK only
221 bool needGrab
= false;
223 // Check if there are any modal windows present,
224 // in which case we need to add a grab.
225 for ( wxWindowList::iterator it
= wxTopLevelWindows
.begin();
226 it
!= wxTopLevelWindows
.end();
230 wxDialog
*dialog
= wxDynamicCast(win
, wxDialog
);
232 if (dialog
&& dialog
->IsModal())
243 void wxHtmlHelpFrame::UseConfig(wxConfigBase
*config
, const wxString
& rootPath
)
246 m_HtmlHelpWin
->UseConfig(config
, rootPath
);
248 #endif // wxUSE_CONFIG
250 void wxHtmlHelpFrame::SetShouldPreventAppExit(bool enable
)
252 m_shouldPreventAppExit
= enable
;
256 void wxHtmlHelpFrame::OnClose(wxCommandEvent
& WXUNUSED(event
))
261 void wxHtmlHelpFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
263 wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"),
264 wxICON_INFORMATION
|wxOK
, this);
268 #endif // wxUSE_WXHTML_HELP