Doc fixes

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

diff --git a/samples/minimal/minimal.cpp b/samples/minimal/minimal.cpp
index 623245f6ae60f7c5996481581feb97f2827b6fc0..fa6a0067f6b3ddf65d3cef32bdd7942ec9ff031b 100644 (file)
--- a/samples/minimal/minimal.cpp
+++ b/samples/minimal/minimal.cpp
@@ -1,116 +1,188 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minimal.cpp
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minimal.cpp

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

 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "minimal.cpp"
-#pragma interface "minimal.cpp"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 // For compilers that support precompilation, includes "wx/wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 
 // For compilers that support precompilation, includes "wx/wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+// for all others, include the necessary headers (this file is usually all you
+// need because it includes almost all "standard" wxWidgets headers)

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#include "wx/wx.h"
+    #include "wx/wx.h"

 #endif
 
 #endif
 

-// Define a new application type
-class MyApp: public wxApp
-{ public:
-    bool OnInit(void);
+// ----------------------------------------------------------------------------
+// resources
+// ----------------------------------------------------------------------------
+
+// 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
+
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
+
+// Define a new application type, each program should derive a class from wxApp
+class MyApp : public wxApp
+{
+public:
+    // override base class virtuals
+    // ----------------------------
+
+    // this one is called on application startup and is a good place for the app
+    // initialization (doing it here and not in the ctor allows to have an error
+    // return: if OnInit() returns false, the application terminates)
+    virtual bool OnInit();

 };
 
 };
 

-// Define a new frame type
-class MyFrame: public wxFrame
-{ public:
-    MyFrame(wxFrame *frame, char *title, int x, int y, int w, int h);
-    
- public:
+// Define a new frame type: this is going to be our main frame
+class MyFrame : public wxFrame
+{
+public:
+    // ctor(s)
+    MyFrame(const wxString& title);
+
+    // event handlers (these functions should _not_ be virtual)

     void OnQuit(wxCommandEvent& event);
     void OnAbout(wxCommandEvent& event);
     void OnQuit(wxCommandEvent& event);
     void OnAbout(wxCommandEvent& event);

-       bool OnClose(void) { return TRUE; }

 
 

-   DECLARE_EVENT_TABLE()
-    
+private:
+    // any class wishing to process wxWidgets events must use this macro
+    DECLARE_EVENT_TABLE()
+};
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// IDs for the controls and the menu commands
+enum
+{
+    // menu items
+    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
+    // (where it is special and put into the "Apple" menu)
+    Minimal_About = wxID_ABOUT

 };
 
 };
 

-// ID for the menu commands
-#define MINIMAL_QUIT   1
-#define MINIMAL_TEXT   101
-#define MINIMAL_ABOUT  102
+// ----------------------------------------------------------------------------
+// event tables and other macros for wxWidgets
+// ----------------------------------------------------------------------------

 
 

+// 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)
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)

-       EVT_MENU(MINIMAL_QUIT, MyFrame::OnQuit)
-       EVT_MENU(MINIMAL_ABOUT, MyFrame::OnAbout)
+    EVT_MENU(Minimal_Quit,  MyFrame::OnQuit)
+    EVT_MENU(Minimal_About, MyFrame::OnAbout)

 END_EVENT_TABLE()
 
 END_EVENT_TABLE()
 

-// Create a new application object
-IMPLEMENT_APP  (MyApp)
+// Create a new application object: this macro will allow wxWidgets to create
+// the application object during program execution (it's better than using a
+// 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)
+
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-// `Main program' equivalent, creating windows and returning main app frame
-bool MyApp::OnInit(void)
+// ----------------------------------------------------------------------------
+// the application class
+// ----------------------------------------------------------------------------
+
+// 'Main program' equivalent: the program execution "starts" here
+bool MyApp::OnInit()

 {
 {

-  // Create the main frame window
-  MyFrame *frame = new MyFrame(NULL, "Minimal wxWindows App", 50, 50, 450, 340);
+    // create the main application window
+    MyFrame *frame = new MyFrame(_T("Minimal wxWidgets App"));

 
 

-  // Give it an icon
-#ifdef __WXMSW__
-  frame->SetIcon(wxIcon("mondrian"));
-#endif
-#ifdef __X__
-  frame->SetIcon(wxIcon("aiai.xbm"));
-#endif
+    // and show it (the frames, unlike simple controls, are not shown when
+    // created initially)
+    frame->Show(true);

 
 

-  // Make a menubar
-  wxMenu *file_menu = new wxMenu;
+    // success: wxApp::OnRun() will be called which will enter the main message
+    // loop and the application will run. If we returned false here, the
+    // application would exit immediately.
+    return true;
+}

 
 

-  file_menu->Append(MINIMAL_ABOUT, "&About");
-  file_menu->Append(MINIMAL_QUIT, "E&xit");
-  wxMenuBar *menu_bar = new wxMenuBar;
-  menu_bar->Append(file_menu, "&File");
-  frame->SetMenuBar(menu_bar);
+// ----------------------------------------------------------------------------
+// main frame
+// ----------------------------------------------------------------------------

 
 

-  // Make a panel with a message
-  wxPanel *panel = new wxPanel(frame, -1, wxPoint(0, 0), wxSize(400, 200), wxTAB_TRAVERSAL);
+// frame constructor
+MyFrame::MyFrame(const wxString& title)
+       : wxFrame(NULL, wxID_ANY, title)
+{
+    // set the frame icon
+    SetIcon(wxICON(sample));

 
 

-  wxStaticText *msg = new wxStaticText(panel, 311, "Hello!", wxPoint(10, 10), wxSize(-1, -1),
-    0);
+#if wxUSE_MENUS
+    // create a menu bar
+    wxMenu *menuFile = new wxMenu;

 
 

-  // Show the frame
-  frame->Show(TRUE);
-  
-  SetTopWindow(frame);
+    // the "About" item should be in the help menu
+    wxMenu *helpMenu = new wxMenu;
+    helpMenu->Append(Minimal_About, _T("&About...\tF1"), _T("Show about dialog"));

 
 

-  return TRUE;
+    menuFile->Append(Minimal_Quit, _T("E&xit\tAlt-X"), _T("Quit this program"));
+
+    // now append the freshly created menu to the menu bar...
+    wxMenuBar *menuBar = new wxMenuBar();
+    menuBar->Append(menuFile, _T("&File"));
+    menuBar->Append(helpMenu, _T("&Help"));
+
+    // ... and attach this menu bar to the frame
+    SetMenuBar(menuBar);
+#endif // wxUSE_MENUS
+
+#if wxUSE_STATUSBAR
+    // create a status bar just for fun (by default with 1 pane only)
+    CreateStatusBar(2);
+    SetStatusText(_T("Welcome to wxWidgets!"));
+#endif // wxUSE_STATUSBAR

 }
 
 }
 

-// My frame constructor
-MyFrame::MyFrame(wxFrame *frame, char *title, int x, int y, int w, int h):
-  wxFrame(frame, -1, title, wxPoint(x, y), wxSize(w, h))
-{}

 
 

-void MyFrame::OnQuit(wxCommandEvent& event)
+// event handlers
+
+void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))

 {
 {

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

 }
 
 }
 

-void MyFrame::OnAbout(wxCommandEvent& event)
+void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))

 {
 {

-  wxMessageDialog dialog(this, "This is a minimal sample\nA second line in the message box",
-       "About Minimal", wxYES_NO|wxCANCEL);
+    wxString msg;
+    msg.Printf( _T("This is the About dialog of the minimal sample.\n")
+                _T("Welcome to %s"), wxVERSION_STRING);

 
 

-  dialog.ShowModal();
+    wxMessageBox(msg, _T("About Minimal"), wxOK | wxICON_INFORMATION, this);

 }
 }

-
-