Don't document private event handlers in doc/view frame classes.

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

diff --git a/samples/display/display.cpp b/samples/display/display.cpp
index 9373aa3fa39e5ecdb8c49672ecaffca63259a12a..7f686a2e43c92f868c382c1f06c11f1ef53e42ea 100644 (file)
--- a/samples/display/display.cpp
+++ b/samples/display/display.cpp
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        display.cpp
 /////////////////////////////////////////////////////////////////////////////
 // Name:        display.cpp

-// Purpose:     wxWindows sample showing the features of wxDisplay class
+// Purpose:     wxWidgets sample showing the features of wxDisplay class

 // Author:      Vadim Zeitlin
 // Author:      Vadim Zeitlin

-// Modified by:
+// Modified by: Ryan Norton & Brian Victor

 // Created:     23.02.03
 // RCS-ID:      $Id$
 // Created:     23.02.03
 // RCS-ID:      $Id$

-// Copyright:   (c) Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-// for compilers that support precompilation, includes "wx/wx.h".from here
+// for compilers that support precompilation, includes "wx/wx.h"

 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__


@@ -26,18 +26,20 @@
 
 // for all others, include the necessary headers explicitly
 #ifndef WX_PRECOMP
 
 // for all others, include the necessary headers explicitly
 #ifndef WX_PRECOMP

-    #include "wx/app.h"
-    #include "wx/frame.h"
-
-    #include "wx/stattext.h"
-
-    #include "wx/layout.h"
+    #include "wx/wx.h"

 #endif
 
 #endif
 

-#include "wx/notebook.h"
+#include "wx/bookctrl.h"
+#include "wx/sysopt.h"

 
 #include "wx/display.h"
 
 
 #include "wx/display.h"
 

+
+// the application icon (under Windows and OS/2 it is in resources)
+#if defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXX11__)
+    #include "../sample.xpm"
+#endif
+

 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------


@@ -65,13 +67,41 @@ public:
 
     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);
 
     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);

+    void OnFromPoint(wxCommandEvent& event);
+    void OnFullScreen(wxCommandEvent& event);

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

+#if wxUSE_DISPLAY
+    void OnChangeMode(wxCommandEvent& event);
+    void OnResetMode(wxCommandEvent& event);
+
+    void OnDisplayChanged(wxDisplayChangedEvent& event);
+#endif // wxUSE_DISPLAY
+
+    void OnLeftClick(wxMouseEvent& event);
+

 private:
 private:

-    // any class wishing to process wxWindows events must use this macro
+#if wxUSE_DISPLAY
+    // convert video mode to textual description
+    wxString VideoModeToText(const wxVideoMode& mode);
+#endif // wxUSE_DISPLAY
+
+    // GUI controls
+    wxBookCtrl *m_book;
+
+    // any class wishing to process wxWidgets events must use this macro

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 

+// Client data class for the choice control containing the video modes
+class MyVideoModeClientData : public wxClientData
+{
+public:
+    MyVideoModeClientData(const wxVideoMode& m) : mode(m) { }
+
+    const wxVideoMode mode;
+};
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -80,27 +110,46 @@ private:
 enum
 {
     // menu items
 enum
 {
     // menu items

-    Display_Quit = 1,
+    Display_FromPoint = wxID_HIGHEST + 1,
+    Display_FullScreen,
+
+    // controls
+    Display_ChangeMode,
+    Display_ResetMode,
+    Display_CurrentMode,
+

 
     // 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)
 
     // 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)

+    Display_Quit = wxID_EXIT,

     Display_About = wxID_ABOUT
 };
 
 // ----------------------------------------------------------------------------
     Display_About = wxID_ABOUT
 };
 
 // ----------------------------------------------------------------------------

-// 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)
     EVT_MENU(Display_Quit,  MyFrame::OnQuit)
 // 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)
     EVT_MENU(Display_Quit,  MyFrame::OnQuit)

+    EVT_MENU(Display_FromPoint,  MyFrame::OnFromPoint)
+    EVT_MENU(Display_FullScreen, MyFrame::OnFullScreen)

     EVT_MENU(Display_About, MyFrame::OnAbout)
     EVT_MENU(Display_About, MyFrame::OnAbout)

+
+#if wxUSE_DISPLAY
+    EVT_CHOICE(Display_ChangeMode, MyFrame::OnChangeMode)
+    EVT_BUTTON(Display_ResetMode, MyFrame::OnResetMode)
+
+    EVT_DISPLAY_CHANGED(MyFrame::OnDisplayChanged)
+#endif // wxUSE_DISPLAY
+
+    EVT_LEFT_UP(MyFrame::OnLeftClick)

 END_EVENT_TABLE()
 
 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
 // static object for many reasons) and also declares the accessor function
 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 // the application object during program execution (it's better than using a
 // static object for many reasons) and also declares the accessor function
 // wxGetApp() which will return the reference of the right type (i.e. MyApp and


@@ -118,18 +167,28 @@ IMPLEMENT_APP(MyApp)
 // 'Main program' equivalent: the program execution "starts" here
 bool MyApp::OnInit()
 {
 // 'Main program' equivalent: the program execution "starts" here
 bool MyApp::OnInit()
 {

+    if ( !wxApp::OnInit() )
+        return false;
+
+#ifdef __WXMSW__
+    if ( argc == 2 && !wxStricmp(argv[1],  wxT("/dx")) )
+    {
+        wxSystemOptions::SetOption(wxT("msw.display.directdraw"), 1);
+    }
+#endif // __WXMSW__
+

     // create the main application window
     // create the main application window

-    MyFrame *frame = new MyFrame(_("Display wxWindows Sample"),
-                                 wxPoint(50, 50), wxSize(450, 340));
+    MyFrame *frame = new MyFrame(_("Display wxWidgets Sample"),
+                                 wxDefaultPosition, wxDefaultSize);

 
     // 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();

 
     // 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,89 +197,238 @@ bool MyApp::OnInit()
 
 // frame constructor
 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
 
 // frame constructor
 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)

-       : wxFrame(NULL, -1, title, pos, size, style)
+       : wxFrame(NULL, wxID_ANY, title, pos, size, style)

 {
     // 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

-    wxMenu *menuFile = new wxMenu;
+    wxMenu *menuDisplay = new wxMenu;
+    menuDisplay->Append(Display_FromPoint, _("Find from &point..."));
+    menuDisplay->AppendSeparator();
+    menuDisplay->AppendCheckItem(Display_FullScreen, _("Full &screen\tF12"));
+    menuDisplay->AppendSeparator();
+    menuDisplay->Append(Display_Quit, _("E&xit\tAlt-X"), _("Quit this program"));

 
     // the "About" item should be in the help menu
     wxMenu *helpMenu = new wxMenu;
 
     // the "About" item should be in the help menu
     wxMenu *helpMenu = new wxMenu;

-    helpMenu->Append(Display_About, _("&About...\tF1"), _("Show about dialog"));
-
-    menuFile->Append(Display_Quit, _("E&xit\tAlt-X"), _("Quit this program"));
+    helpMenu->Append(Display_About, _("&About\tF1"), _("Show about dialog"));

 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar();
 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar();

-    menuBar->Append(menuFile, _("&File"));
+    menuBar->Append(menuDisplay, _("&Display"));

     menuBar->Append(helpMenu, _("&Help"));
 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);
 #endif // wxUSE_MENUS
 
     menuBar->Append(helpMenu, _("&Help"));
 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);
 #endif // wxUSE_MENUS
 

+#if wxUSE_STATUSBAR
+    // create status bar
+    CreateStatusBar();
+#endif // wxUSE_STATUSBAR
+

     // create child controls
     // create child controls

-    wxNotebook *notebook = new wxNotebook(this, -1);
+    wxPanel *panel = new wxPanel(this, wxID_ANY);
+
+    m_book = new wxBookCtrl(panel, wxID_ANY);

     const size_t count = wxDisplay::GetCount();
     const size_t count = wxDisplay::GetCount();

-    for ( size_t n = 0; n < count; n++ )
+    for ( size_t nDpy = 0; nDpy < count; nDpy++ )

     {
     {

-        wxDisplay display(n);
+        wxDisplay display(nDpy);

 
 

-        wxWindow *page = new wxPanel(notebook, -1);
+        wxWindow *page = new wxPanel(m_book, wxID_ANY);

 
         // create 2 column flex grid sizer with growable 2nd column
         wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 10, 20);
         sizer->AddGrowableCol(1);
 
         const wxRect r(display.GetGeometry());
 
         // create 2 column flex grid sizer with growable 2nd column
         wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 10, 20);
         sizer->AddGrowableCol(1);
 
         const wxRect r(display.GetGeometry());

-        sizer->Add(new wxStaticText(page, -1, _T("Geometry: ")));
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("Origin: ")));
+        sizer->Add(new wxStaticText
+                       (
+                        page,
+                        wxID_ANY,
+                        wxString::Format(wxT("(%d, %d)"),
+                                         r.x, r.y)
+                       ));
+
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("Size: ")));

         sizer->Add(new wxStaticText
                        (
                         page,
         sizer->Add(new wxStaticText
                        (
                         page,

-                        -1,
-                        wxString::Format(_T("(%d, %d)-(%d, %d)"),
-                                         r.x, r.y,
-                                         r.x + r.width, r.y + r.height)
+                        wxID_ANY,
+                        wxString::Format(wxT("(%d, %d)"),
+                                         r.width, r.height)

                        ));
 
                        ));
 

-        sizer->Add(new wxStaticText(page, -1, _T("Depth: ")));
+        const wxRect rc(display.GetClientArea());
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("Client area: ")));

         sizer->Add(new wxStaticText
                        (
                         page,
         sizer->Add(new wxStaticText
                        (
                         page,

-                        -1,
-                        wxString::Format(_T("%d bpp"), display.GetDepth())
+                        wxID_ANY,
+                        wxString::Format(wxT("(%d, %d)-(%d, %d)"),
+                                         rc.x, rc.y, rc.width, rc.height)

                        ));
 
                        ));
 

-        sizer->Add(new wxStaticText(page, -1, _T("Colour: ")));
-        sizer->Add(new wxStaticText(page, -1, display.IsColour() ? _T("Yes")
-                                                                 : _T("No")));
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("Name: ")));
+        sizer->Add(new wxStaticText(page, wxID_ANY, display.GetName()));

 
 

-        // add it to another sizer to have borders around it

         wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
         sizerTop->Add(sizer, 1, wxALL | wxEXPAND, 10);
         wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
         sizerTop->Add(sizer, 1, wxALL | wxEXPAND, 10);

+
+#if wxUSE_DISPLAY
+        wxChoice *choiceModes = new wxChoice(page, Display_ChangeMode);
+        const wxArrayVideoModes modes = display.GetModes();
+        const size_t count = modes.GetCount();
+        for ( size_t nMode = 0; nMode < count; nMode++ )
+        {
+            const wxVideoMode& mode = modes[nMode];
+
+            choiceModes->Append(VideoModeToText(mode),
+                                new MyVideoModeClientData(mode));
+        }
+
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("&Modes: ")));
+        sizer->Add(choiceModes, 0, wxEXPAND);
+
+        sizer->Add(new wxStaticText(page, wxID_ANY, wxT("Current: ")));
+        sizer->Add(new wxStaticText(page, Display_CurrentMode,
+                                    VideoModeToText(display.GetCurrentMode())));
+
+        // add it to another sizer to have borders around it and button below
+        sizerTop->Add(new wxButton(page, Display_ResetMode, wxT("&Reset mode")),
+                      0, wxALL | wxCENTRE, 5);
+#endif // wxUSE_DISPLAY
+

         page->SetSizer(sizerTop);
 
         page->SetSizer(sizerTop);
 

-        notebook->AddPage(page,
-                          wxString::Format(_T("Display %lu"), (unsigned long)n));
+        m_book->AddPage(page,
+                        wxString::Format(wxT("Display %lu"),
+                                         (unsigned long)nDpy));
+    }
+
+    wxBoxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
+    sizer->Add(m_book, 1, wxEXPAND);
+    panel->SetSizer(sizer);
+    sizer->SetSizeHints(this);
+}
+
+#if wxUSE_DISPLAY
+
+wxString MyFrame::VideoModeToText(const wxVideoMode& mode)
+{
+    wxString s;
+    s.Printf(wxT("%dx%d"), mode.w, mode.h);
+
+    if ( mode.bpp )
+    {
+        s += wxString::Format(wxT(", %dbpp"), mode.bpp);

     }
     }

+
+    if ( mode.refresh )
+    {
+        s += wxString::Format(wxT(", %dHz"), mode.refresh);
+    }
+
+    return s;

 }
 
 }
 

+#endif // wxUSE_DISPLAY

 
 // event handlers
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {
 
 // event handlers
 
 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))
 {
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {

-    wxMessageBox(_T("Demo program for wxDisplay class.\n\n(c) 2003 Vadim Zeitlin"),
-                 _T("About Display Sample"),
+    wxMessageBox(wxT("Demo program for wxDisplay class.\n\n(c) 2003-2006 Vadim Zeitlin"),
+                 wxT("About Display Sample"),

                  wxOK | wxICON_INFORMATION,
                  this);
 }
                  wxOK | wxICON_INFORMATION,
                  this);
 }

+
+void MyFrame::OnFromPoint(wxCommandEvent& WXUNUSED(event))
+{
+#if wxUSE_STATUSBAR
+    SetStatusText(wxT("Press the mouse anywhere..."));
+#endif // wxUSE_STATUSBAR
+
+    CaptureMouse();
+}
+
+void MyFrame::OnFullScreen(wxCommandEvent& event)
+{
+    ShowFullScreen(event.IsChecked());
+}
+
+#if wxUSE_DISPLAY
+
+void MyFrame::OnChangeMode(wxCommandEvent& event)
+{
+    wxDisplay dpy(m_book->GetSelection());
+
+    // you wouldn't write this in real code, would you?
+    if ( !dpy.ChangeMode(((MyVideoModeClientData *)
+                wxDynamicCast(event.GetEventObject(), wxChoice)->
+                    GetClientObject(event.GetInt()))->mode) )
+    {
+        wxLogError(wxT("Changing video mode failed!"));
+    }
+}
+
+void MyFrame::OnResetMode(wxCommandEvent& WXUNUSED(event))
+{
+    wxDisplay dpy(m_book->GetSelection());
+
+    dpy.ResetMode();
+}
+
+#endif // wxUSE_DISPLAY
+
+void MyFrame::OnLeftClick(wxMouseEvent& event)
+{
+    if ( HasCapture() )
+    {
+        // mouse events are in client coords, wxDisplay works in screen ones
+        const wxPoint ptScreen = ClientToScreen(event.GetPosition());
+        int dpy = wxDisplay::GetFromPoint(ptScreen);
+        if ( dpy == wxNOT_FOUND )
+        {
+            wxLogError(wxT("Mouse clicked outside of display!?"));
+        }
+
+        wxLogStatus(this, wxT("Mouse clicked in display %d (at (%d, %d))"),
+                    dpy, ptScreen.x, ptScreen.y);
+
+        ReleaseMouse();
+    }
+}
+
+#if wxUSE_DISPLAY
+
+void MyFrame::OnDisplayChanged(wxDisplayChangedEvent& event)
+{
+    // update the current mode text
+    for ( size_t n = 0; n < m_book->GetPageCount(); n++ )
+    {
+        wxStaticText *label = wxDynamicCast(m_book->GetPage(n)->
+                                                FindWindow(Display_CurrentMode),
+                                            wxStaticText);
+        if ( label )
+            label->SetLabel(VideoModeToText(wxDisplay(n).GetCurrentMode()));
+    }
+
+
+    wxLogStatus(this, wxT("Display resolution was changed."));
+
+    event.Skip();
+}
+
+#endif // wxUSE_DISPLAY