]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: tipdlg.cpp | |
3 | // Purpose: implementation of wxTipDialog | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 28.06.99 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Vadim Zeitlin | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | // ============================================================================ | |
13 | // declarations | |
14 | // ============================================================================ | |
15 | ||
16 | // ---------------------------------------------------------------------------- | |
17 | // headers | |
18 | // ---------------------------------------------------------------------------- | |
19 | ||
20 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) | |
21 | #pragma implementation "tipdlg.h" | |
22 | #endif | |
23 | ||
24 | // For compilers that support precompilation, includes "wx.h". | |
25 | #include "wx/wxprec.h" | |
26 | ||
27 | #ifdef __BORLANDC__ | |
28 | #pragma hdrstop | |
29 | #endif | |
30 | ||
31 | #if wxUSE_STARTUP_TIPS | |
32 | ||
33 | #ifndef WX_PRECOMP | |
34 | #include "wx/button.h" | |
35 | #include "wx/checkbox.h" | |
36 | #include "wx/statbox.h" | |
37 | #include "wx/dialog.h" | |
38 | #include "wx/icon.h" | |
39 | #include "wx/intl.h" | |
40 | #include "wx/settings.h" | |
41 | #include "wx/textctrl.h" | |
42 | #include "wx/statbmp.h" | |
43 | #include "wx/stattext.h" | |
44 | #include "wx/sizer.h" | |
45 | #endif // WX_PRECOMP | |
46 | ||
47 | #include "wx/statline.h" | |
48 | #include "wx/artprov.h" | |
49 | ||
50 | #include "wx/tipdlg.h" | |
51 | ||
52 | // ---------------------------------------------------------------------------- | |
53 | // constants | |
54 | // ---------------------------------------------------------------------------- | |
55 | ||
56 | static const int wxID_NEXT_TIP = 32000; // whatever | |
57 | ||
58 | // ---------------------------------------------------------------------------- | |
59 | // private classes | |
60 | // ---------------------------------------------------------------------------- | |
61 | ||
62 | // an implementation which takes the tips from the text file - each line | |
63 | // represents a tip | |
64 | class WXDLLIMPEXP_ADV wxFileTipProvider : public wxTipProvider | |
65 | { | |
66 | public: | |
67 | wxFileTipProvider(const wxString& filename, size_t currentTip); | |
68 | ||
69 | virtual wxString GetTip(); | |
70 | ||
71 | private: | |
72 | wxTextFile m_textfile; | |
73 | ||
74 | DECLARE_NO_COPY_CLASS(wxFileTipProvider) | |
75 | }; | |
76 | ||
77 | #ifdef __WIN32__ | |
78 | // TODO an implementation which takes the tips from the given registry key | |
79 | class WXDLLIMPEXP_ADV wxRegTipProvider : public wxTipProvider | |
80 | { | |
81 | public: | |
82 | wxRegTipProvider(const wxString& keyname); | |
83 | ||
84 | virtual wxString GetTip(); | |
85 | }; | |
86 | ||
87 | // Empty implementation for now to keep the linker happy | |
88 | wxString wxRegTipProvider::GetTip() | |
89 | { | |
90 | return wxEmptyString; | |
91 | } | |
92 | ||
93 | #endif // __WIN32__ | |
94 | ||
95 | // the dialog we show in wxShowTip() | |
96 | class WXDLLIMPEXP_ADV wxTipDialog : public wxDialog | |
97 | { | |
98 | public: | |
99 | wxTipDialog(wxWindow *parent, | |
100 | wxTipProvider *tipProvider, | |
101 | bool showAtStartup); | |
102 | ||
103 | // the tip dialog has "Show tips on startup" checkbox - return true if it | |
104 | // was checked (or wasn't unchecked) | |
105 | bool ShowTipsOnStartup() const { return m_checkbox->GetValue(); } | |
106 | ||
107 | // sets the (next) tip text | |
108 | void SetTipText() { m_text->SetValue(m_tipProvider->GetTip()); } | |
109 | ||
110 | // "Next" button handler | |
111 | void OnNextTip(wxCommandEvent& WXUNUSED(event)) { SetTipText(); } | |
112 | ||
113 | private: | |
114 | wxTipProvider *m_tipProvider; | |
115 | ||
116 | wxTextCtrl *m_text; | |
117 | wxCheckBox *m_checkbox; | |
118 | ||
119 | DECLARE_EVENT_TABLE() | |
120 | DECLARE_NO_COPY_CLASS(wxTipDialog) | |
121 | }; | |
122 | ||
123 | // ============================================================================ | |
124 | // implementation | |
125 | // ============================================================================ | |
126 | ||
127 | // ---------------------------------------------------------------------------- | |
128 | // wxFileTipProvider | |
129 | // ---------------------------------------------------------------------------- | |
130 | ||
131 | wxFileTipProvider::wxFileTipProvider(const wxString& filename, | |
132 | size_t currentTip) | |
133 | : wxTipProvider(currentTip), m_textfile(filename) | |
134 | { | |
135 | m_textfile.Open(); | |
136 | } | |
137 | ||
138 | wxString wxFileTipProvider::GetTip() | |
139 | { | |
140 | size_t count = m_textfile.GetLineCount(); | |
141 | if ( !count ) | |
142 | { | |
143 | return _("Tips not available, sorry!"); | |
144 | } | |
145 | ||
146 | wxString tip; | |
147 | ||
148 | // Comments start with a # symbol. | |
149 | // Loop reading lines until get the first one that isn't a comment. | |
150 | // The max number of loop executions is the number of lines in the | |
151 | // textfile so that can't go into an eternal loop in the [oddball] | |
152 | // case of a comment-only tips file, or the developer has vetoed | |
153 | // them all via PreprecessTip(). | |
154 | for ( size_t i=0; i < count; i++ ) | |
155 | { | |
156 | // The current tip may be at the last line of the textfile, (or | |
157 | // past it, if the number of lines in the textfile changed, such | |
158 | // as changing to a different textfile, with less tips). So check | |
159 | // to see at last line of text file, (or past it)... | |
160 | if ( m_currentTip >= count ) | |
161 | { | |
162 | // .. and if so, wrap back to line 0. | |
163 | m_currentTip = 0; | |
164 | } | |
165 | ||
166 | // Read the tip, and increment the current tip counter. | |
167 | tip = m_textfile.GetLine(m_currentTip++); | |
168 | ||
169 | // Allow a derived class's overrided virtual to modify the tip | |
170 | // now if so desired. | |
171 | tip = PreprocessTip(tip); | |
172 | ||
173 | // Break if tip isn't a comment, and isn't an empty string | |
174 | // (or only stray space characters). | |
175 | if ( !tip.StartsWith(wxT("#")) && (tip.Trim() != wxEmptyString) ) | |
176 | { | |
177 | break; | |
178 | } | |
179 | } | |
180 | ||
181 | // If tip starts with '_(', then it is a gettext string of format | |
182 | // _("My \"global\" tip text") so first strip off the leading '_("'... | |
183 | if ( tip.StartsWith(wxT("_(\"" ), &tip)) | |
184 | { | |
185 | //...and strip off the trailing '")'... | |
186 | tip = tip.BeforeLast(wxT('\"')); | |
187 | // ...and replace escaped quotes | |
188 | tip.Replace(wxT("\\\""), wxT("\"")); | |
189 | } | |
190 | ||
191 | return tip; | |
192 | } | |
193 | ||
194 | // ---------------------------------------------------------------------------- | |
195 | // wxTipDialog | |
196 | // ---------------------------------------------------------------------------- | |
197 | ||
198 | BEGIN_EVENT_TABLE(wxTipDialog, wxDialog) | |
199 | EVT_BUTTON(wxID_NEXT_TIP, wxTipDialog::OnNextTip) | |
200 | END_EVENT_TABLE() | |
201 | ||
202 | wxTipDialog::wxTipDialog(wxWindow *parent, | |
203 | wxTipProvider *tipProvider, | |
204 | bool showAtStartup) | |
205 | : wxDialog(parent, wxID_ANY, _("Tip of the Day"), | |
206 | wxDefaultPosition, wxDefaultSize, | |
207 | wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER) | |
208 | { | |
209 | m_tipProvider = tipProvider; | |
210 | ||
211 | // 1) create all controls in tab order | |
212 | ||
213 | wxButton *btnClose = new wxButton(this, wxID_CANCEL, _("&Close")); | |
214 | ||
215 | m_checkbox = new wxCheckBox(this, wxID_ANY, _("&Show tips at startup")); | |
216 | m_checkbox->SetValue(showAtStartup); | |
217 | ||
218 | wxButton *btnNext = new wxButton(this, wxID_NEXT_TIP, _("&Next Tip")); | |
219 | ||
220 | wxStaticText *text = new wxStaticText(this, wxID_ANY, _("Did you know...")); | |
221 | ||
222 | wxFont font = text->GetFont(); | |
223 | font.SetPointSize(int(1.6 * font.GetPointSize())); | |
224 | font.SetWeight(wxFONTWEIGHT_BOLD); | |
225 | ||
226 | text->SetFont(font); | |
227 | ||
228 | m_text = new wxTextCtrl(this, wxID_ANY, wxEmptyString, | |
229 | wxDefaultPosition, wxSize(200, 160), | |
230 | wxTE_MULTILINE | | |
231 | wxTE_READONLY | | |
232 | wxTE_NO_VSCROLL | | |
233 | wxTE_RICH | // a hack to get rid of vert scrollbar | |
234 | wxSUNKEN_BORDER); | |
235 | #if defined(__WXMSW__) | |
236 | m_text->SetFont(wxFont(12, wxSWISS, wxNORMAL, wxNORMAL)); | |
237 | #endif | |
238 | ||
239 | //#if defined(__WXPM__) | |
240 | // | |
241 | // The only way to get icons into an OS/2 static bitmap control | |
242 | // | |
243 | // wxBitmap vBitmap; | |
244 | ||
245 | // vBitmap.SetId(wxICON_TIP); // OS/2 specific bitmap method--OS/2 wxBitmaps all have an ID. | |
246 | // // and for StatBmp's under OS/2 it MUST be a valid resource ID. | |
247 | // | |
248 | // wxStaticBitmap* bmp = new wxStaticBitmap(this, wxID_ANY, vBitmap); | |
249 | // | |
250 | //#else | |
251 | ||
252 | wxIcon icon = wxArtProvider::GetIcon(wxART_TIP, wxART_CMN_DIALOG); | |
253 | wxStaticBitmap *bmp = new wxStaticBitmap(this, wxID_ANY, icon); | |
254 | ||
255 | //#endif | |
256 | ||
257 | // 2) put them in boxes | |
258 | ||
259 | wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL ); | |
260 | ||
261 | wxBoxSizer *icon_text = new wxBoxSizer( wxHORIZONTAL ); | |
262 | icon_text->Add( bmp, 0, wxCENTER ); | |
263 | icon_text->Add( text, 1, wxCENTER | wxLEFT, 20 ); | |
264 | topsizer->Add( icon_text, 0, wxEXPAND | wxALL, 10 ); | |
265 | ||
266 | topsizer->Add( m_text, 1, wxEXPAND | wxLEFT|wxRIGHT, 10 ); | |
267 | ||
268 | wxBoxSizer *bottom = new wxBoxSizer( wxHORIZONTAL ); | |
269 | bottom->Add( m_checkbox, 0, wxCENTER ); | |
270 | bottom->Add( 10,10,1 ); | |
271 | bottom->Add( btnNext, 0, wxCENTER | wxLEFT, 10 ); | |
272 | bottom->Add( btnClose, 0, wxCENTER | wxLEFT, 10 ); | |
273 | topsizer->Add( bottom, 0, wxEXPAND | wxALL, 10 ); | |
274 | ||
275 | SetTipText(); | |
276 | ||
277 | SetSizer( topsizer ); | |
278 | ||
279 | topsizer->SetSizeHints( this ); | |
280 | topsizer->Fit( this ); | |
281 | ||
282 | Centre(wxBOTH | wxCENTER_FRAME); | |
283 | ||
284 | } | |
285 | ||
286 | // ---------------------------------------------------------------------------- | |
287 | // our public interface | |
288 | // ---------------------------------------------------------------------------- | |
289 | ||
290 | wxTipProvider *wxCreateFileTipProvider(const wxString& filename, | |
291 | size_t currentTip) | |
292 | { | |
293 | return new wxFileTipProvider(filename, currentTip); | |
294 | } | |
295 | ||
296 | bool wxShowTip(wxWindow *parent, | |
297 | wxTipProvider *tipProvider, | |
298 | bool showAtStartup) | |
299 | { | |
300 | wxTipDialog dlg(parent, tipProvider, showAtStartup); | |
301 | dlg.ShowModal(); | |
302 | ||
303 | return dlg.ShowTipsOnStartup(); | |
304 | } | |
305 | ||
306 | #endif // wxUSE_STARTUP_TIPS | |
307 |