]> git.saurik.com Git - wxWidgets.git/blob - samples/dialup/nettest.cpp
extending docs according #9713
[wxWidgets.git] / samples / dialup / nettest.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: net.cpp
3 // Purpose: wxWidgets sample demonstrating network-related functions
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 07.07.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 // For compilers that support precompilation, includes "wx/wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 // for all others, include the necessary headers (this file is usually all you
28 // need because it includes almost all "standard" wxWidgets headers
29 #ifndef WX_PRECOMP
30 #include "wx/wx.h"
31 #endif
32
33 #if !wxUSE_DIALUP_MANAGER
34 #error You must set wxUSE_DIALUP_MANAGER to 1 in setup.h!
35 #endif
36
37 #include "wx/dialup.h"
38
39 // ----------------------------------------------------------------------------
40 // private classes
41 // ----------------------------------------------------------------------------
42
43 // Define a new application type, each program should derive a class from wxApp
44 class MyApp : public wxApp
45 {
46 public:
47 // override base class virtuals
48 // ----------------------------
49
50 // this one is called on application startup and is a good place for the app
51 // initialization (doing it here and not in the ctor allows to have an error
52 // return: if OnInit() returns false, the application terminates)
53 virtual bool OnInit();
54
55 // called before the application termination
56 virtual int OnExit();
57
58 // event handlers
59 void OnConnected(wxDialUpEvent& event);
60
61 // accessor to dial up manager
62 wxDialUpManager *GetDialer() const { return m_dial; }
63
64 private:
65 wxDialUpManager *m_dial;
66
67 DECLARE_EVENT_TABLE()
68 };
69
70 // Define a new frame type: this is going to be our main frame
71 class MyFrame : public wxFrame
72 {
73 public:
74 // ctor(s)
75 MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
76
77 // event handlers (these functions should _not_ be virtual)
78 void OnQuit(wxCommandEvent& event);
79 void OnAbout(wxCommandEvent& event);
80 void OnHangUp(wxCommandEvent& event);
81 void OnDial(wxCommandEvent& event);
82 void OnEnumISPs(wxCommandEvent& event);
83 void OnCheck(wxCommandEvent& event);
84 void OnUpdateUI(wxUpdateUIEvent& event);
85
86 void OnIdle(wxIdleEvent& event);
87
88 private:
89 // any class wishing to process wxWidgets events must use this macro
90 DECLARE_EVENT_TABLE()
91 };
92
93 // ----------------------------------------------------------------------------
94 // constants
95 // ----------------------------------------------------------------------------
96
97 // IDs for the controls and the menu commands
98 enum
99 {
100 // menu items
101 NetTest_Quit = 1,
102 NetTest_About,
103 NetTest_HangUp,
104 NetTest_Dial,
105 NetTest_EnumISP,
106 NetTest_Check,
107 NetTest_Max
108 };
109
110 // ----------------------------------------------------------------------------
111 // event tables and other macros for wxWidgets
112 // ----------------------------------------------------------------------------
113
114 BEGIN_EVENT_TABLE(MyApp, wxApp)
115 EVT_DIALUP_CONNECTED(MyApp::OnConnected)
116 EVT_DIALUP_DISCONNECTED(MyApp::OnConnected)
117 END_EVENT_TABLE()
118
119 // the event tables connect the wxWidgets events with the functions (event
120 // handlers) which process them. It can be also done at run-time, but for the
121 // simple menu events like this the static method is much simpler.
122 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
123 EVT_MENU(NetTest_Quit, MyFrame::OnQuit)
124 EVT_MENU(NetTest_About, MyFrame::OnAbout)
125 EVT_MENU(NetTest_HangUp, MyFrame::OnHangUp)
126 EVT_MENU(NetTest_Dial, MyFrame::OnDial)
127 EVT_MENU(NetTest_EnumISP, MyFrame::OnEnumISPs)
128 EVT_MENU(NetTest_Check, MyFrame::OnCheck)
129
130 EVT_UPDATE_UI(NetTest_Dial, MyFrame::OnUpdateUI)
131
132 EVT_IDLE(MyFrame::OnIdle)
133 END_EVENT_TABLE()
134
135 // Create a new application object: this macro will allow wxWidgets to create
136 // the application object during program execution (it's better than using a
137 // static object for many reasons) and also declares the accessor function
138 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
139 // not wxApp)
140 IMPLEMENT_APP(MyApp)
141
142 // ============================================================================
143 // implementation
144 // ============================================================================
145
146 // ----------------------------------------------------------------------------
147 // the application class
148 // ----------------------------------------------------------------------------
149
150 // `Main program' equivalent: the program execution "starts" here
151 bool MyApp::OnInit()
152 {
153 if ( !wxApp::OnInit() )
154 return false;
155
156 // Create the main application window
157 MyFrame *frame = new MyFrame(_T("Dial-up wxWidgets demo"),
158 wxPoint(50, 50), wxSize(450, 340));
159
160 // Show it and tell the application that it's our main window
161 frame->Show(true);
162 SetTopWindow(frame);
163
164 // Init dial up manager
165 m_dial = wxDialUpManager::Create();
166
167 if ( !m_dial->IsOk() )
168 {
169 wxLogError(wxT("The sample can't run on this system."));
170
171 #if wxUSE_LOG
172 wxLog::GetActiveTarget()->Flush();
173 #endif // wxUSE_LOG
174
175 // do it here, OnExit() won't be called
176 delete m_dial;
177
178 return false;
179 }
180
181 #if wxUSE_STATUSBAR
182 frame->SetStatusText(GetDialer()->IsAlwaysOnline() ? _T("LAN") : _T("No LAN"), 2);
183 #endif // wxUSE_STATUSBAR
184
185 return true;
186 }
187
188 int MyApp::OnExit()
189 {
190 delete m_dial;
191
192 // exit code is 0, everything is ok
193 return 0;
194 }
195
196 void MyApp::OnConnected(wxDialUpEvent& event)
197 {
198 const wxChar *msg;
199 if ( event.IsOwnEvent() )
200 {
201 msg = event.IsConnectedEvent() ? wxT("Successfully connected")
202 : wxT("Dialing failed");
203
204 wxLogStatus(wxEmptyString);
205 }
206 else
207 {
208 msg = event.IsConnectedEvent() ? wxT("Just connected!")
209 : wxT("Disconnected");
210 }
211
212 wxLogMessage(msg);
213 }
214
215 // ----------------------------------------------------------------------------
216 // main frame
217 // ----------------------------------------------------------------------------
218
219 // frame constructor
220 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
221 : wxFrame((wxFrame *)NULL, wxID_ANY, title, pos, size)
222 {
223 // create a menu bar
224 wxMenu *menuFile = new wxMenu;
225
226 menuFile->Append(NetTest_Dial, _T("&Dial\tCtrl-D"), _T("Dial default ISP"));
227 menuFile->Append(NetTest_HangUp, _T("&HangUp\tCtrl-H"), _T("Hang up modem"));
228 menuFile->AppendSeparator();
229 menuFile->Append(NetTest_EnumISP, _T("&Enumerate ISPs...\tCtrl-E"));
230 menuFile->Append(NetTest_Check, _T("&Check connection status...\tCtrl-C"));
231 menuFile->AppendSeparator();
232 menuFile->Append(NetTest_About, _T("&About...\tCtrl-A"), _T("Show about dialog"));
233 menuFile->AppendSeparator();
234 menuFile->Append(NetTest_Quit, _T("E&xit\tAlt-X"), _T("Quit this program"));
235
236 // now append the freshly created menu to the menu bar...
237 wxMenuBar *menuBar = new wxMenuBar;
238 menuBar->Append(menuFile, _T("&File"));
239
240 // ... and attach this menu bar to the frame
241 SetMenuBar(menuBar);
242
243 #if wxUSE_STATUSBAR
244 // create status bar and fill the LAN field
245 CreateStatusBar(3);
246 static const int widths[3] = { -1, 100, 60 };
247 SetStatusWidths(3, widths);
248 #endif // wxUSE_STATUSBAR
249 }
250
251
252 // event handlers
253
254 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
255 {
256 // true is to force the frame to close
257 Close(true);
258 }
259
260 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
261 {
262 wxString msg;
263 msg.Printf( wxT("This is the network functions test sample.\n")
264 wxT("(c) 1999 Vadim Zeitlin") );
265
266 wxMessageBox(msg, wxT("About NetTest"), wxOK | wxICON_INFORMATION, this);
267 }
268
269 void MyFrame::OnHangUp(wxCommandEvent& WXUNUSED(event))
270 {
271 if ( wxGetApp().GetDialer()->HangUp() )
272 {
273 wxLogStatus(this, wxT("Connection was successfully terminated."));
274 }
275 else
276 {
277 wxLogStatus(this, wxT("Failed to hang up."));
278 }
279 }
280
281 void MyFrame::OnDial(wxCommandEvent& WXUNUSED(event))
282 {
283 wxLogStatus(this, wxT("Preparing to dial..."));
284 wxYield();
285 wxBeginBusyCursor();
286
287 if ( wxGetApp().GetDialer()->Dial() )
288 {
289 wxLogStatus(this, wxT("Dialing..."));
290 }
291 else
292 {
293 wxLogStatus(this, wxT("Dialing attempt failed."));
294 }
295
296 wxEndBusyCursor();
297 }
298
299 void MyFrame::OnCheck(wxCommandEvent& WXUNUSED(event))
300 {
301 if(wxGetApp().GetDialer()->IsOnline())
302 wxLogMessage(wxT("Network is online."));
303 else
304 wxLogMessage(wxT("Network is offline."));
305 }
306
307 void MyFrame::OnEnumISPs(wxCommandEvent& WXUNUSED(event))
308 {
309 wxArrayString names;
310 size_t nCount = wxGetApp().GetDialer()->GetISPNames(names);
311 if ( nCount == 0 )
312 {
313 wxLogWarning(wxT("No ISPs found."));
314 }
315 else
316 {
317 wxString msg = _T("Known ISPs:\n");
318 for ( size_t n = 0; n < nCount; n++ )
319 {
320 msg << names[n] << '\n';
321 }
322
323 wxLogMessage(msg);
324 }
325 }
326
327 void MyFrame::OnUpdateUI(wxUpdateUIEvent& event)
328 {
329 // disable this item while dialing
330 event.Enable( !wxGetApp().GetDialer()->IsDialing() );
331 }
332
333 void MyFrame::OnIdle(wxIdleEvent& WXUNUSED(event))
334 {
335 static int s_isOnline = -1; // not true nor false
336
337 bool isOnline = wxGetApp().GetDialer()->IsOnline();
338 if ( s_isOnline != (int)isOnline )
339 {
340 s_isOnline = isOnline;
341
342 #if wxUSE_STATUSBAR
343 SetStatusText(isOnline ? _T("Online") : _T("Offline"), 1);
344 #endif // wxUSE_STATUSBAR
345 }
346 }