Minor changes, just trim trailing spaces in webview code.

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

diff --git a/samples/caret/caret.cpp b/samples/caret/caret.cpp
index 9142ef3094b74d4e27444f022b1e33505e59b202..a9c44ca2f9bfa47b46df65d7eefd13f9335e836d 100644 (file)
--- a/samples/caret/caret.cpp
+++ b/samples/caret/caret.cpp
@@ -9,41 +9,30 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

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

 // For compilers that support precompilation, includes "wx/wx.h".
 // For compilers that support precompilation, includes "wx/wx.h".

-#include <wx/wxprec.h>
+#include "wx/wxprec.h"

 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
 // for all others, include the necessary headers (this file is usually all you
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #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
 #ifndef WX_PRECOMP

-    #include <wx/wx.h>
-
-    #include <wx/log.h>
+    #include "wx/wx.h"
+    #include "wx/log.h"

 #endif
 
 #include "wx/caret.h"
 #endif
 
 #include "wx/caret.h"

+#include "wx/numdlg.h"

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

-// ressources
+// resources

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

+

 // the application icon
 // the application icon

-#if defined(__WXGTK__) || defined(__WXMOTIF__)
-    #include "mondrian.xpm"
+#ifndef wxHAS_IMAGES_IN_RESOURCES
+    #include "../sample.xpm"

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


@@ -63,22 +52,6 @@ public:
     virtual bool OnInit();
 };
 
     virtual bool OnInit();
 };
 

-// Define a new frame type: this is going to be our main frame
-class MyFrame : public wxFrame
-{
-public:
-    // ctor(s)
-    MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
-
-    // 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
-    DECLARE_EVENT_TABLE()
-};
-

 // MyCanvas is a canvas on which you can type
 class MyCanvas: public wxScrolledWindow
 {
 // MyCanvas is a canvas on which you can type
 class MyCanvas: public wxScrolledWindow
 {


@@ -89,6 +62,11 @@ public:
 
     wxChar& CharAt(int x, int y) { return *(m_text + x + m_xChars * y); }
 
 
     wxChar& CharAt(int x, int y) { return *(m_text + x + m_xChars * y); }
 

+    // operations
+    void SetFontSize(int fontSize);
+    void CreateCaret();
+    void MoveCaret(int x, int y);
+

     // caret movement
     void Home() { m_xCaret = 0; }
     void End() { m_xCaret = m_xChars - 1; }
     // caret movement
     void Home() { m_xCaret = 0; }
     void End() { m_xCaret = m_xChars - 1; }


@@ -105,7 +83,12 @@ public:
     void OnChar( wxKeyEvent &event );
 
 private:
     void OnChar( wxKeyEvent &event );
 
 private:

-    wxCaret  m_caret;
+    // move the caret to m_xCaret, m_yCaret
+    void DoMoveCaret();
+
+    // update the geometry
+    void ChangeSize();
+

     wxFont   m_font;
 
     // the margin around the text (looks nicer)
     wxFont   m_font;
 
     // the margin around the text (looks nicer)


@@ -127,6 +110,28 @@ private:
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 

+
+// Define a new frame type: this is going to be our main frame
+class MyFrame : public wxFrame
+{
+public:
+    // ctor(s)
+    MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
+
+    // event handlers (these functions should _not_ be virtual)
+    void OnQuit(wxCommandEvent& event);
+    void OnAbout(wxCommandEvent& event);
+    void OnSetBlinkTime(wxCommandEvent& event);
+    void OnSetFontSize(wxCommandEvent& event);
+    void OnCaretMove(wxCommandEvent& event);
+
+private:
+    MyCanvas *m_canvas;
+
+    // any class wishing to process wxWidgets events must use this macro
+    DECLARE_EVENT_TABLE()
+};
+

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


@@ -135,28 +140,32 @@ private:
 enum
 {
     // menu items
 enum
 {
     // menu items

-    Minimal_Quit = 1,
-    Minimal_About,
-    Minimal_Test1,
-    Minimal_Test2,
+    Caret_Quit = 1,
+    Caret_About,
+    Caret_SetBlinkTime,
+    Caret_SetFontSize,
+    Caret_Move,

 
     // controls start here (the numbers are, of course, arbitrary)
 
     // controls start here (the numbers are, of course, arbitrary)

-    Minimal_Text = 1000,
+    Caret_Text = 1000

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

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

-    EVT_MENU(Minimal_Quit,  MyFrame::OnQuit)
-    EVT_MENU(Minimal_About, MyFrame::OnAbout)
+    EVT_MENU(Caret_Quit,  MyFrame::OnQuit)
+    EVT_MENU(Caret_About, MyFrame::OnAbout)
+    EVT_MENU(Caret_SetBlinkTime, MyFrame::OnSetBlinkTime)
+    EVT_MENU(Caret_SetFontSize, MyFrame::OnSetFontSize)
+    EVT_MENU(Caret_Move, MyFrame::OnCaretMove)

 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


@@ -174,19 +183,19 @@ 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()
 {

-    // Create the main application window
-    MyFrame *frame = new MyFrame("Minimal wxWindows App",
+    if ( !wxApp::OnInit() )
+        return false;
+
+    // create and show the main application window
+    MyFrame *frame = new MyFrame(wxT("Caret wxWidgets sample"),

                                  wxPoint(50, 50), wxSize(450, 340));
 
                                  wxPoint(50, 50), wxSize(450, 340));
 

-    // Show it and tell the application that it's our main window
-    // @@@ what does it do exactly, in fact? is it necessary here?
-    frame->Show(TRUE);
-    SetTopWindow(frame);
+    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;

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


@@ -195,30 +204,36 @@ bool MyApp::OnInit()
 
 // frame constructor
 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 
 // frame constructor
 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)

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

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

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

 
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 
 
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 

-    menuFile->Append(Minimal_About, "&About...\tCtrl-A", "Show about dialog");
+    menuFile->Append(Caret_SetBlinkTime, wxT("&Blink time...\tCtrl-B"));
+    menuFile->Append(Caret_SetFontSize, wxT("&Font size...\tCtrl-S"));
+    menuFile->Append(Caret_Move, wxT("&Move caret\tCtrl-C"));
+    menuFile->AppendSeparator();
+    menuFile->Append(Caret_About, wxT("&About\tCtrl-A"), wxT("Show about dialog"));

     menuFile->AppendSeparator();
     menuFile->AppendSeparator();

-    menuFile->Append(Minimal_Quit, "E&xit\tAlt-X", "Quit this program");
+    menuFile->Append(Caret_Quit, wxT("E&xit\tAlt-X"), wxT("Quit this program"));

 
     // 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(menuFile, wxT("&File"));

 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);
 
     // ... and attach this menu bar to the frame
     SetMenuBar(menuBar);

-    
-    (void) new MyCanvas( this );

 
 

+    m_canvas = new MyCanvas(this);
+
+#if wxUSE_STATUSBAR

     // create a status bar just for fun (by default with 1 pane only)
     CreateStatusBar(2);
     // create a status bar just for fun (by default with 1 pane only)
     CreateStatusBar(2);

-    SetStatusText("Welcome to wxWindows!");
+    SetStatusText(wxT("Welcome to wxWidgets!"));
+#endif // wxUSE_STATUSBAR

 }
 
 
 }
 
 


@@ -226,27 +241,55 @@ 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))
 {
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 {

-    wxString msg;
-    msg.Printf( _T("This is the about dialog of minimal sample.\n")
-                _T("Welcome to %s")
-#ifdef wxBETA_NUMBER
-               _T(" (beta %d)!")
-#endif // wxBETA_NUMBER
-               , wxVERSION_STRING
-#ifdef wxBETA_NUMBER
-               , wxBETA_NUMBER
-#endif // wxBETA_NUMBER
-              );
-
-    wxMessageBox(msg, "About Minimal", wxOK | wxICON_INFORMATION, this);
+    wxMessageBox(wxT("The caret wxWidgets sample.\n(c) 1999 Vadim Zeitlin"),
+                 wxT("About Caret"), wxOK | wxICON_INFORMATION, this);
+}
+
+void MyFrame::OnCaretMove(wxCommandEvent& WXUNUSED(event))
+{
+    m_canvas->MoveCaret(10, 10);
+}
+
+void MyFrame::OnSetBlinkTime(wxCommandEvent& WXUNUSED(event))
+{
+    long blinkTime = wxGetNumberFromUser
+                     (
+                      wxT("The caret blink time is the time between two blinks"),
+                      wxT("Time in milliseconds:"),
+                      wxT("wxCaret sample"),
+                      wxCaret::GetBlinkTime(), 0, 10000,
+                      this
+                     );
+    if ( blinkTime != -1 )
+    {
+        wxCaret::SetBlinkTime((int)blinkTime);
+        m_canvas->CreateCaret();
+        wxLogStatus(this, wxT("Blink time set to %ld milliseconds."), blinkTime);
+    }

 }
 
 }
 

+void MyFrame::OnSetFontSize(wxCommandEvent& WXUNUSED(event))
+{
+    long fontSize = wxGetNumberFromUser
+                    (
+                        wxT("The font size also determines the caret size so\nthis demonstrates resizing the caret."),
+                        wxT("Font size (in points):"),
+                        wxT("wxCaret sample"),
+                        12, 1, 100,
+                        this
+                    );
+
+    if ( fontSize != -1 )
+    {
+        m_canvas->SetFontSize((int)fontSize);
+    }
+}

 
 // ----------------------------------------------------------------------------
 // MyCanvas
 
 // ----------------------------------------------------------------------------
 // MyCanvas


@@ -261,29 +304,22 @@ BEGIN_EVENT_TABLE(MyCanvas, wxScrolledWindow)
 END_EVENT_TABLE()
 
 MyCanvas::MyCanvas( wxWindow *parent )
 END_EVENT_TABLE()
 
 MyCanvas::MyCanvas( wxWindow *parent )

-        : wxScrolledWindow( parent, -1,
+        : wxScrolledWindow( parent, wxID_ANY,

                             wxDefaultPosition, wxDefaultSize,
                             wxSUNKEN_BORDER )
 {
     m_text = (wxChar *)NULL;
 
                             wxDefaultPosition, wxDefaultSize,
                             wxSUNKEN_BORDER )
 {
     m_text = (wxChar *)NULL;
 

-    SetBackgroundColour(* wxWHITE);
-
-    m_font = *wxNORMAL_FONT;
-
-    wxClientDC dc(this);
-    dc.SetFont( m_font );
-    m_heightChar = dc.GetCharHeight();
-    m_widthChar = dc.GetCharWidth();
+    SetBackgroundColour(*wxWHITE);

 
 

-    m_caret.Create( this, m_widthChar, m_heightChar );
+    SetFontSize(12);

 
     m_xCaret = m_yCaret =
     m_xChars = m_yChars = 0;
 
     m_xMargin = m_yMargin = 5;
 
     m_xCaret = m_yCaret =
     m_xChars = m_yChars = 0;
 
     m_xMargin = m_yMargin = 5;

-    m_caret.Move(m_xMargin, m_yMargin);
-    m_caret.Show();
+
+    CreateCaret();

 }
 
 MyCanvas::~MyCanvas()
 }
 
 MyCanvas::~MyCanvas()


@@ -291,10 +327,62 @@ MyCanvas::~MyCanvas()
     free(m_text);
 }
 
     free(m_text);
 }
 

-void MyCanvas::OnSize( wxSizeEvent &event )
+void MyCanvas::CreateCaret()
+{
+    wxCaret *caret = new wxCaret(this, m_widthChar, m_heightChar);
+    SetCaret(caret);
+
+    caret->Move(m_xMargin, m_yMargin);
+    caret->Show();
+}
+
+void MyCanvas::SetFontSize(int fontSize)
+{
+    m_font = wxFont(fontSize, wxFONTFAMILY_TELETYPE,
+                    wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
+
+    wxClientDC dc(this);
+    dc.SetFont(m_font);
+    m_heightChar = dc.GetCharHeight();
+    m_widthChar = dc.GetCharWidth();
+
+    wxCaret *caret = GetCaret();
+    if ( caret )
+    {
+        caret->SetSize(m_widthChar, m_heightChar);
+
+        ChangeSize();
+    }
+}
+
+void MyCanvas::MoveCaret(int x, int y)
+{
+    m_xCaret = x;
+    m_yCaret = y;
+
+    DoMoveCaret();
+}
+
+void MyCanvas::DoMoveCaret()
+{
+    wxLogStatus(wxT("Caret is at (%d, %d)"), m_xCaret, m_yCaret);
+
+    GetCaret()->Move(m_xMargin + m_xCaret * m_widthChar,
+                     m_yMargin + m_yCaret * m_heightChar);
+}
+
+void MyCanvas::OnSize(wxSizeEvent& event)
+{
+    ChangeSize();
+
+    event.Skip();
+}
+
+void MyCanvas::ChangeSize()

 {
 {

-    m_xChars = (event.GetSize().x - 2*m_xMargin) / m_widthChar;
-    m_yChars = (event.GetSize().y - 2*m_yMargin) / m_heightChar;
+    wxSize size = GetClientSize();
+    m_xChars = (size.x - 2*m_xMargin) / m_widthChar;
+    m_yChars = (size.y - 2*m_yMargin) / m_heightChar;

     if ( !m_xChars )
         m_xChars = 1;
     if ( !m_yChars )
     if ( !m_xChars )
         m_xChars = 1;
     if ( !m_yChars )


@@ -303,18 +391,28 @@ void MyCanvas::OnSize( wxSizeEvent &event )
     free(m_text);
     m_text = (wxChar *)calloc(m_xChars * m_yChars, sizeof(wxChar));
 
     free(m_text);
     m_text = (wxChar *)calloc(m_xChars * m_yChars, sizeof(wxChar));
 

-    wxString msg;
-    msg.Printf(_T("Panel size is (%d, %d)"), m_xChars, m_yChars);
-
-    ((wxFrame *)GetParent())->SetStatusText(msg, 1);
+#if wxUSE_STATUSBAR
+    wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);

 
 

-    event.Skip();
+    if ( frame && frame->GetStatusBar() )
+    {
+        wxString msg;
+        msg.Printf(wxT("Panel size is (%d, %d)"), m_xChars, m_yChars);
+        frame->SetStatusText(msg, 1);
+    }
+#endif // wxUSE_STATUSBAR

 }
 
 }
 

+// NB: this method is horrible inefficient especially because the caret
+//     needs to be redrawn often and in this case we only have to redraw
+//     the caret location and not the entire window - in a real program we
+//     would use GetUpdateRegion() and iterate over rectangles it contains

 void MyCanvas::OnPaint( wxPaintEvent &WXUNUSED(event) )
 {
 void MyCanvas::OnPaint( wxPaintEvent &WXUNUSED(event) )
 {

+    wxCaretSuspend cs(this);

     wxPaintDC dc( this );
     PrepareDC( dc );
     wxPaintDC dc( this );
     PrepareDC( dc );

+    dc.Clear();

 
     dc.SetFont( m_font );
 
 
     dc.SetFont( m_font );
 


@@ -326,17 +424,24 @@ void MyCanvas::OnPaint( wxPaintEvent &WXUNUSED(event) )
         {
             wxChar ch = CharAt(x, y);
             if ( !ch )
         {
             wxChar ch = CharAt(x, y);
             if ( !ch )

-                ch = _T(' ');
+                ch = wxT(' ');
+#ifdef __WXOSX__
+            dc.DrawText(ch, m_xMargin + x * m_widthChar,
+                        m_yMargin + y * m_heightChar );
+#else

             line += ch;
             line += ch;

+#endif

         }
 
         }
 

+#ifndef __WXOSX__

         dc.DrawText( line, m_xMargin, m_yMargin + y * m_heightChar );
         dc.DrawText( line, m_xMargin, m_yMargin + y * m_heightChar );

+#endif

     }
 }
 
 void MyCanvas::OnChar( wxKeyEvent &event )
 {
     }
 }
 
 void MyCanvas::OnChar( wxKeyEvent &event )
 {

-    switch ( event.KeyCode() )
+    switch ( event.GetKeyCode() )

     {
         case WXK_LEFT:
             PrevChar();
     {
         case WXK_LEFT:
             PrevChar();


@@ -368,23 +473,26 @@ void MyCanvas::OnChar( wxKeyEvent &event )
             break;
 
         default:
             break;
 
         default:

-            if ( wxIsprint(event.KeyCode()) )
+            if ( !event.AltDown() && wxIsprint(event.GetKeyCode()) )

             {
             {

-                CharAt(m_xCaret, m_yCaret) = (wxChar)event.KeyCode();
+                wxChar ch = (wxChar)event.GetKeyCode();
+                CharAt(m_xCaret, m_yCaret) = ch;
+
+                wxCaretSuspend cs(this);
+                wxClientDC dc(this);
+                dc.SetFont(m_font);
+                dc.SetBackgroundMode(wxSOLID); // overwrite old value
+                dc.DrawText(ch, m_xMargin + m_xCaret * m_widthChar,
+                                m_yMargin + m_yCaret * m_heightChar );
+

                 NextChar();
             }
             else
             {
                 NextChar();
             }
             else
             {

-                // don't refresh
-                return;
+                event.Skip();

             }
     }
 
             }
     }
 

-    wxLogStatus(_T("Caret is at (%d, %d)"), m_xCaret, m_yCaret);
-
-    m_caret.Move(m_xMargin + m_xCaret * m_widthChar,
-                 m_yMargin + m_yCaret * m_heightChar);
-
-    Refresh();
+    DoMoveCaret();

 }
 
 }