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