Doc fixes

[wxWidgets.git] / samples / minimal / minimal.cpp

diff --git a/samples/minimal/minimal.cpp b/samples/minimal/minimal.cpp
index 29c30397a598b959fe5e3293a5965d9bb7b821c1..fa6a0067f6b3ddf65d3cef32bdd7942ec9ff031b 100644 (file)
--- a/samples/minimal/minimal.cpp
+++ b/samples/minimal/minimal.cpp
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minimal.cpp
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minimal.cpp

-// Purpose:     Minimal wxWindows sample
+// Purpose:     Minimal wxWidgets sample

 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98


@@ -25,7 +25,7 @@
 #endif
 
 // for all others, include the necessary headers (this file is usually all you
 #endif
 
 // for all others, include the necessary headers (this file is usually all you

-// need because it includes almost all "standard" wxWindows headers)
+// need because it includes almost all "standard" wxWidgets headers)

 #ifndef WX_PRECOMP
     #include "wx/wx.h"
 #endif
 #ifndef WX_PRECOMP
     #include "wx/wx.h"
 #endif


@@ -34,9 +34,10 @@
 // resources
 // ----------------------------------------------------------------------------
 
 // resources
 // ----------------------------------------------------------------------------
 

-// the application icon (under Windows and OS/2 it is in resources)
-#if defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__) || defined(__WXX11__)
-    #include "mondrian.xpm"
+// the application icon (under Windows and OS/2 it is in resources and even
+// though we could still include the XPM here it would be unused)
+#if !defined(__WXMSW__) && !defined(__WXPM__)
+    #include "../sample.xpm"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -61,15 +62,14 @@ class MyFrame : public wxFrame
 {
 public:
     // ctor(s)
 {
 public:
     // ctor(s)

-    MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size,
-            long style = wxDEFAULT_FRAME_STYLE);
+    MyFrame(const wxString& title);

 
     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);
     void OnAbout(wxCommandEvent& event);
 
 private:
 
     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);
     void OnAbout(wxCommandEvent& event);
 
 private:

-    // any class wishing to process wxWindows events must use this macro
+    // any class wishing to process wxWidgets events must use this macro

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -81,7 +81,7 @@ private:
 enum
 {
     // menu items
 enum
 {
     // menu items

-    Minimal_Quit = 1,
+    Minimal_Quit = wxID_EXIT,

 
     // it is important for the id corresponding to the "About" command to have
     // this standard value as otherwise it won't be handled properly under Mac
 
     // it is important for the id corresponding to the "About" command to have
     // this standard value as otherwise it won't be handled properly under Mac


@@ -90,10 +90,10 @@ enum
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// event tables and other macros for wxWindows
+// event tables and other macros for wxWidgets

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// the event tables connect the wxWindows events with the functions (event
+// the event tables connect the wxWidgets events with the functions (event

 // handlers) which process them. It can be also done at run-time, but for the
 // simple menu events like this the static method is much simpler.
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 // handlers) which process them. It can be also done at run-time, but for the
 // simple menu events like this the static method is much simpler.
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)


@@ -101,9 +101,9 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(Minimal_About, MyFrame::OnAbout)
 END_EVENT_TABLE()
 
     EVT_MENU(Minimal_About, MyFrame::OnAbout)
 END_EVENT_TABLE()
 

-// Create a new application object: this macro will allow wxWindows to create
+// Create a new application object: this macro will allow wxWidgets to create

 // the application object during program execution (it's better than using a
 // the application object during program execution (it's better than using a

-// static object for many reasons) and also declares the accessor function
+// static object for many reasons) and also implements the accessor function

 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 // not wxApp)
 IMPLEMENT_APP(MyApp)
 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 // not wxApp)
 IMPLEMENT_APP(MyApp)


@@ -120,17 +120,16 @@ IMPLEMENT_APP(MyApp)
 bool MyApp::OnInit()
 {
     // create the main application window
 bool MyApp::OnInit()
 {
     // create the main application window

-    MyFrame *frame = new MyFrame(_T("Minimal wxWindows App"),
-                                 wxPoint(50, 50), wxSize(450, 340));
+    MyFrame *frame = new MyFrame(_T("Minimal wxWidgets App"));

 
     // and show it (the frames, unlike simple controls, are not shown when
     // created initially)
 
     // and show it (the frames, unlike simple controls, are not shown when
     // created initially)

-    frame->Show(TRUE);
+    frame->Show(true);

 
     // success: wxApp::OnRun() will be called which will enter the main message
 
     // success: wxApp::OnRun() will be called which will enter the main message

-    // loop and the application will run. If we returned FALSE here, the
+    // loop and the application will run. If we returned false here, the

     // application would exit immediately.
     // application would exit immediately.

-    return TRUE;
+    return true;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -138,11 +137,11 @@ bool MyApp::OnInit()
 // ----------------------------------------------------------------------------
 
 // frame constructor
 // ----------------------------------------------------------------------------
 
 // frame constructor

-MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
-       : wxFrame(NULL, -1, title, pos, size, style)
+MyFrame::MyFrame(const wxString& title)
+       : wxFrame(NULL, wxID_ANY, title)

 {
     // set the frame icon
 {
     // set the frame icon

-    SetIcon(wxICON(mondrian));
+    SetIcon(wxICON(sample));

 
 #if wxUSE_MENUS
     // create a menu bar
 
 #if wxUSE_MENUS
     // create a menu bar


@@ -166,7 +165,7 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size,
 #if wxUSE_STATUSBAR
     // create a status bar just for fun (by default with 1 pane only)
     CreateStatusBar(2);
 #if wxUSE_STATUSBAR
     // create a status bar just for fun (by default with 1 pane only)
     CreateStatusBar(2);

-    SetStatusText(_T("Welcome to wxWindows!"));
+    SetStatusText(_T("Welcome to wxWidgets!"));

 #endif // wxUSE_STATUSBAR
 }
 
 #endif // wxUSE_STATUSBAR
 }
 


@@ -175,14 +174,14 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size,
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {

-    // TRUE is to force the frame to close
-    Close(TRUE);
+    // true is to force the frame to close
+    Close(true);

 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {
     wxString msg;
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {
     wxString msg;

-    msg.Printf( _T("This is the about dialog of minimal sample.\n")
+    msg.Printf( _T("This is the About dialog of the minimal sample.\n")

                 _T("Welcome to %s"), wxVERSION_STRING);
 
     wxMessageBox(msg, _T("About Minimal"), wxOK | wxICON_INFORMATION, this);
                 _T("Welcome to %s"), wxVERSION_STRING);
 
     wxMessageBox(msg, _T("About Minimal"), wxOK | wxICON_INFORMATION, this);