]> git.saurik.com Git - wxWidgets.git/blob - include/wx/html/helpfrm.h
Implement SelectAll for OSX WebKit.
[wxWidgets.git] / include / wx / html / helpfrm.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/html/helpfrm.h
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 #ifndef _WX_HELPFRM_H_
13 #define _WX_HELPFRM_H_
14
15 #include "wx/defs.h"
16
17 #if wxUSE_WXHTML_HELP
18
19 #include "wx/helpbase.h"
20 #include "wx/html/helpdata.h"
21 #include "wx/window.h"
22 #include "wx/frame.h"
23 #include "wx/config.h"
24 #include "wx/splitter.h"
25 #include "wx/notebook.h"
26 #include "wx/listbox.h"
27 #include "wx/choice.h"
28 #include "wx/combobox.h"
29 #include "wx/checkbox.h"
30 #include "wx/stattext.h"
31 #include "wx/html/htmlwin.h"
32 #include "wx/html/helpwnd.h"
33 #include "wx/html/htmprint.h"
34
35 class WXDLLIMPEXP_FWD_CORE wxButton;
36 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
37 class WXDLLIMPEXP_FWD_CORE wxTreeEvent;
38 class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
39
40
41 // style flags for the Help Frame
42 #define wxHF_TOOLBAR 0x0001
43 #define wxHF_CONTENTS 0x0002
44 #define wxHF_INDEX 0x0004
45 #define wxHF_SEARCH 0x0008
46 #define wxHF_BOOKMARKS 0x0010
47 #define wxHF_OPEN_FILES 0x0020
48 #define wxHF_PRINT 0x0040
49 #define wxHF_FLAT_TOOLBAR 0x0080
50 #define wxHF_MERGE_BOOKS 0x0100
51 #define wxHF_ICONS_BOOK 0x0200
52 #define wxHF_ICONS_BOOK_CHAPTER 0x0400
53 #define wxHF_ICONS_FOLDER 0x0000 // this is 0 since it is default
54 #define wxHF_DEFAULT_STYLE (wxHF_TOOLBAR | wxHF_CONTENTS | \
55 wxHF_INDEX | wxHF_SEARCH | \
56 wxHF_BOOKMARKS | wxHF_PRINT)
57 //compatibility:
58 #define wxHF_OPENFILES wxHF_OPEN_FILES
59 #define wxHF_FLATTOOLBAR wxHF_FLAT_TOOLBAR
60 #define wxHF_DEFAULTSTYLE wxHF_DEFAULT_STYLE
61
62 struct wxHtmlHelpMergedIndexItem;
63 class wxHtmlHelpMergedIndex;
64
65 class WXDLLIMPEXP_FWD_CORE wxHelpControllerBase;
66 class WXDLLIMPEXP_FWD_HTML wxHtmlHelpController;
67 class WXDLLIMPEXP_FWD_HTML wxHtmlHelpWindow;
68
69 class WXDLLIMPEXP_HTML wxHtmlHelpFrame : public wxFrame
70 {
71 DECLARE_DYNAMIC_CLASS(wxHtmlHelpFrame)
72
73 public:
74 wxHtmlHelpFrame(wxHtmlHelpData* data = NULL) { Init(data); }
75 wxHtmlHelpFrame(wxWindow* parent, wxWindowID wxWindowID,
76 const wxString& title = wxEmptyString,
77 int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL
78 #if wxUSE_CONFIG
79 , wxConfigBase *config=NULL, const wxString& rootpath = wxEmptyString
80 #endif // wxUSE_CONFIG
81 );
82 bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString,
83 int style = wxHF_DEFAULT_STYLE
84 #if wxUSE_CONFIG
85 , wxConfigBase *config=NULL, const wxString& rootpath = wxEmptyString
86 #endif // wxUSE_CONFIG
87 );
88 virtual ~wxHtmlHelpFrame();
89
90 /// Returns the data associated with the window.
91 wxHtmlHelpData* GetData() { return m_Data; }
92
93 /// Returns the help controller associated with the window.
94 wxHtmlHelpController* GetController() const { return m_helpController; }
95
96 /// Sets the help controller associated with the window.
97 void SetController(wxHtmlHelpController* controller);
98
99 /// Returns the help window.
100 wxHtmlHelpWindow* GetHelpWindow() const { return m_HtmlHelpWin; }
101
102 // Sets format of title of the frame. Must contain exactly one "%s"
103 // (for title of displayed HTML page)
104 void SetTitleFormat(const wxString& format);
105
106 #if wxUSE_CONFIG
107 // For compatibility
108 void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
109 #endif // wxUSE_CONFIG
110
111 // Make the help controller's frame 'modal' if
112 // needed
113 void AddGrabIfNeeded();
114
115 // Override to add custom buttons to the toolbar
116 virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}
117
118 void SetShouldPreventAppExit(bool enable);
119
120 // we don't want to prevent the app from closing just because a help window
121 // remains opened
122 virtual bool ShouldPreventAppExit() const { return m_shouldPreventAppExit; }
123
124 protected:
125 void Init(wxHtmlHelpData* data = NULL);
126
127 void OnCloseWindow(wxCloseEvent& event);
128 void OnActivate(wxActivateEvent& event);
129
130 #ifdef __WXMAC__
131 void OnClose(wxCommandEvent& event);
132 void OnAbout(wxCommandEvent& event);
133 #endif
134
135 // Images:
136 enum {
137 IMG_Book = 0,
138 IMG_Folder,
139 IMG_Page
140 };
141
142 protected:
143 wxHtmlHelpData* m_Data;
144 bool m_DataCreated; // m_Data created by frame, or supplied?
145 wxString m_TitleFormat; // title of the help frame
146 wxHtmlHelpWindow *m_HtmlHelpWin;
147 wxHtmlHelpController* m_helpController;
148 bool m_shouldPreventAppExit;
149
150 private:
151
152 DECLARE_EVENT_TABLE()
153 wxDECLARE_NO_COPY_CLASS(wxHtmlHelpFrame);
154 };
155
156 #endif // wxUSE_WXHTML_HELP
157
158 #endif