new file added

[wxWidgets.git] / src / generic / tipwin.cpp

diff --git a/src/generic/tipwin.cpp b/src/generic/tipwin.cpp
index 26f83781ba3ae9ae4a258d8129dc7f71be649e9b..b50fb47a9647790dc36e8a521bb159da1e5943fc 100644 (file)
--- a/src/generic/tipwin.cpp
+++ b/src/generic/tipwin.cpp
@@ -6,7 +6,7 @@
 // Created:     10.09.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     10.09.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,23 +17,23 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "tipwin.h"
-#endif
-
-// For compilers that support precompilatixon, includes "wx/wx.h".
+// For compilers that support precompilation, includes "wx/wx.h".

 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 

+#if wxUSE_TIPWINDOW
+
+#include "wx/tipwin.h"
+

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

+    #include "wx/timer.h"
+    #include "wx/settings.h"

 #endif // WX_PRECOMP
 
 #endif // WX_PRECOMP
 

-#include "wx/tipwin.h"
-

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


@@ -41,6 +41,39 @@
 static const wxCoord TEXT_MARGIN_X = 3;
 static const wxCoord TEXT_MARGIN_Y = 3;
 
 static const wxCoord TEXT_MARGIN_X = 3;
 static const wxCoord TEXT_MARGIN_Y = 3;
 

+// ----------------------------------------------------------------------------
+// wxTipWindowView
+// ----------------------------------------------------------------------------
+
+// Viewer window to put in the frame
+class WXDLLEXPORT wxTipWindowView : public wxWindow
+{
+public:
+    wxTipWindowView(wxWindow *parent);
+
+    // event handlers
+    void OnPaint(wxPaintEvent& event);
+    void OnMouseClick(wxMouseEvent& event);
+    void OnMouseMove(wxMouseEvent& event);
+
+#if !wxUSE_POPUPWIN
+    void OnKillFocus(wxFocusEvent& event);
+#endif // wxUSE_POPUPWIN
+
+    // calculate the client rect we need to display the text
+    void Adjust(const wxString& text, wxCoord maxLength);
+
+private:
+    wxTipWindow* m_parent;
+
+#if !wxUSE_POPUPWIN
+    long m_creationTime;
+#endif // !wxUSE_POPUPWIN
+
+    DECLARE_EVENT_TABLE()
+    wxDECLARE_NO_COPY_CLASS(wxTipWindowView);
+};
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -49,14 +82,29 @@ static const wxCoord TEXT_MARGIN_Y = 3;
 // event tables
 // ----------------------------------------------------------------------------
 
 // event tables
 // ----------------------------------------------------------------------------
 

-BEGIN_EVENT_TABLE(wxTipWindow, wxFrame)
-    EVT_PAINT(wxTipWindow::OnPaint)
-
+BEGIN_EVENT_TABLE(wxTipWindow, wxTipWindowBase)

     EVT_LEFT_DOWN(wxTipWindow::OnMouseClick)
     EVT_RIGHT_DOWN(wxTipWindow::OnMouseClick)
     EVT_MIDDLE_DOWN(wxTipWindow::OnMouseClick)
     EVT_LEFT_DOWN(wxTipWindow::OnMouseClick)
     EVT_RIGHT_DOWN(wxTipWindow::OnMouseClick)
     EVT_MIDDLE_DOWN(wxTipWindow::OnMouseClick)

+
+#if !wxUSE_POPUPWIN

     EVT_KILL_FOCUS(wxTipWindow::OnKillFocus)
     EVT_ACTIVATE(wxTipWindow::OnActivate)
     EVT_KILL_FOCUS(wxTipWindow::OnKillFocus)
     EVT_ACTIVATE(wxTipWindow::OnActivate)

+#endif // !wxUSE_POPUPWIN
+END_EVENT_TABLE()
+
+BEGIN_EVENT_TABLE(wxTipWindowView, wxWindow)
+    EVT_PAINT(wxTipWindowView::OnPaint)
+
+    EVT_LEFT_DOWN(wxTipWindowView::OnMouseClick)
+    EVT_RIGHT_DOWN(wxTipWindowView::OnMouseClick)
+    EVT_MIDDLE_DOWN(wxTipWindowView::OnMouseClick)
+
+    EVT_MOTION(wxTipWindowView::OnMouseMove)
+
+#if !wxUSE_POPUPWIN
+    EVT_KILL_FOCUS(wxTipWindowView::OnKillFocus)
+#endif // !wxUSE_POPUPWIN

 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------
 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------


@@ -65,32 +113,146 @@ END_EVENT_TABLE()
 
 wxTipWindow::wxTipWindow(wxWindow *parent,
                          const wxString& text,
 
 wxTipWindow::wxTipWindow(wxWindow *parent,
                          const wxString& text,

-                         wxCoord maxLength)
-           : wxFrame(parent, -1, _T(""),
+                         wxCoord maxLength,
+                         wxTipWindow** windowPtr,
+                         wxRect *rectBounds)
+#if wxUSE_POPUPWIN
+           : wxPopupTransientWindow(parent)
+#else
+           : wxFrame(parent, wxID_ANY, wxEmptyString,

                      wxDefaultPosition, wxDefaultSize,
                      wxDefaultPosition, wxDefaultSize,

-                     wxNO_BORDER | wxFRAME_FLOAT_ON_PARENT)
+                     wxNO_BORDER | wxFRAME_NO_TASKBAR )
+#endif

 {
 {

+    SetTipWindowPtr(windowPtr);
+    if ( rectBounds )
+    {
+        SetBoundingRect(*rectBounds);
+    }
+

     // set colours
     // set colours

-    SetForegroundColour(*wxBLACK);
-#if !defined(__WXPM__)
-    SetBackgroundColour(wxColour(0xc3ffff));
-#else
-    // What is 0xc3ffff, try some legable documentation for those of us who don't memorize hex codes??
-    SetBackgroundColour(wxColour(*wxWHITE));
-#endif
-    // set position and size
+    SetForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));
+
+    // set size, position and show it
+    m_view = new wxTipWindowView(this);
+    m_view->Adjust(text, maxLength);
+    m_view->SetFocus();
+

     int x, y;
     wxGetMousePosition(&x, &y);
     int x, y;
     wxGetMousePosition(&x, &y);

-    Move(x, y + 20);

 
 

-    Adjust(text, maxLength);
+    // we want to show the tip below the mouse, not over it
+    //
+    // NB: the reason we use "/ 2" here is that we don't know where the current
+    //     cursors hot spot is... it would be nice if we could find this out
+    //     though
+    y += wxSystemSettings::GetMetric(wxSYS_CURSOR_Y) / 2;
+
+#if wxUSE_POPUPWIN
+    Position(wxPoint(x, y), wxSize(0,0));
+    Popup(m_view);
+    #ifdef __WXGTK__
+        m_view->CaptureMouse();
+    #endif
+#else
+    Move(x, y);
+    Show(true);
+#endif
+}

 
 

-    SetFocus();
+wxTipWindow::~wxTipWindow()
+{
+    if ( m_windowPtr )
+    {
+        *m_windowPtr = NULL;
+    }
+    #if wxUSE_POPUPWIN
+        #ifdef __WXGTK__
+            if ( m_view->HasCapture() )
+                m_view->ReleaseMouse();
+        #endif
+    #endif
+}

 
 

-    Show(TRUE);
+void wxTipWindow::OnMouseClick(wxMouseEvent& WXUNUSED(event))
+{
+    Close();

 }
 
 }
 

-void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
+#if wxUSE_POPUPWIN
+
+void wxTipWindow::OnDismiss()
+{
+    Close();
+}
+
+#else // !wxUSE_POPUPWIN
+
+void wxTipWindow::OnActivate(wxActivateEvent& event)
+{
+    if (!event.GetActive())
+        Close();
+}
+
+void wxTipWindow::OnKillFocus(wxFocusEvent& WXUNUSED(event))
+{
+    // Under Windows at least, we will get this immediately
+    // because when the view window is focussed, the
+    // tip window goes out of focus.
+#ifdef __WXGTK__
+    Close();
+#endif
+}
+
+#endif // wxUSE_POPUPWIN // !wxUSE_POPUPWIN
+
+void wxTipWindow::SetBoundingRect(const wxRect& rectBound)
+{
+    m_rectBound = rectBound;
+}
+
+void wxTipWindow::Close()
+{
+    if ( m_windowPtr )
+    {
+        *m_windowPtr = NULL;
+        m_windowPtr = NULL;
+    }
+
+#if wxUSE_POPUPWIN
+    Show(false);
+    #ifdef __WXGTK__
+        if ( m_view->HasCapture() )
+            m_view->ReleaseMouse();
+    #endif
+    Destroy();
+#else
+    wxFrame::Close();
+#endif
+}
+
+// ----------------------------------------------------------------------------
+// wxTipWindowView
+// ----------------------------------------------------------------------------
+
+wxTipWindowView::wxTipWindowView(wxWindow *parent)
+               : wxWindow(parent, wxID_ANY,
+                          wxDefaultPosition, wxDefaultSize,
+                          wxNO_BORDER)
+{
+    // set colours
+    SetForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));
+
+#if !wxUSE_POPUPWIN
+    m_creationTime = wxGetLocalTime();
+#endif // !wxUSE_POPUPWIN
+
+    m_parent = (wxTipWindow*)parent;
+}
+
+void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)

 {
     wxClientDC dc(this);
     dc.SetFont(GetFont());
 {
     wxClientDC dc(this);
     dc.SetFont(GetFont());


@@ -100,21 +262,21 @@ void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
     wxString current;
     wxCoord height, width,
             widthMax = 0;
     wxString current;
     wxCoord height, width,
             widthMax = 0;

-    m_heightLine = 0;
+    m_parent->m_heightLine = 0;

 
 

-    bool breakLine = FALSE;
+    bool breakLine = false;

     for ( const wxChar *p = text.c_str(); ; p++ )
     {
     for ( const wxChar *p = text.c_str(); ; p++ )
     {

-        if ( *p == _T('\n') || *p == _T('\0') )
+        if ( *p == wxT('\n') || *p == wxT('\0') )

         {
             dc.GetTextExtent(current, &width, &height);
             if ( width > widthMax )
                 widthMax = width;
 
         {
             dc.GetTextExtent(current, &width, &height);
             if ( width > widthMax )
                 widthMax = width;
 

-            if ( height > m_heightLine )
-                m_heightLine = height;
+            if ( height > m_parent->m_heightLine )
+                m_parent->m_heightLine = height;

 
 

-            m_textLines.Add(current);
+            m_parent->m_textLines.Add(current);

 
             if ( !*p )
             {
 
             if ( !*p )
             {


@@ -123,36 +285,38 @@ void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
             }
 
             current.clear();
             }
 
             current.clear();

-            breakLine = FALSE;
+            breakLine = false;

         }
         }

-        else if ( breakLine && (*p == _T(' ') || *p == _T('\t')) )
+        else if ( breakLine && (*p == wxT(' ') || *p == wxT('\t')) )

         {
             // word boundary - break the line here
         {
             // word boundary - break the line here

-            m_textLines.Add(current);
+            m_parent->m_textLines.Add(current);

             current.clear();
             current.clear();

-            breakLine = FALSE;
+            breakLine = false;

         }
         else // line goes on
         {
             current += *p;
             dc.GetTextExtent(current, &width, &height);
             if ( width > maxLength )
         }
         else // line goes on
         {
             current += *p;
             dc.GetTextExtent(current, &width, &height);
             if ( width > maxLength )

-                breakLine = TRUE;
+                breakLine = true;

 
             if ( width > widthMax )
                 widthMax = width;
 
 
             if ( width > widthMax )
                 widthMax = width;
 

-            if ( height > m_heightLine )
-                m_heightLine = height;
+            if ( height > m_parent->m_heightLine )
+                m_parent->m_heightLine = height;

         }
     }
 
     // take into account the border size and the margins
         }
     }
 
     // take into account the border size and the margins

-    SetClientSize(2*(TEXT_MARGIN_X + 1) + widthMax,
-                  2*(TEXT_MARGIN_Y + 1) + m_textLines.GetCount()*m_heightLine);
+    width  = 2*(TEXT_MARGIN_X + 1) + widthMax;
+    height = 2*(TEXT_MARGIN_Y + 1) + wx_truncate_cast(wxCoord, m_parent->m_textLines.GetCount())*m_parent->m_heightLine;
+    m_parent->SetClientSize(width, height);
+    SetSize(0, 0, width, height);

 }
 
 }
 

-void wxTipWindow::OnPaint(wxPaintEvent& event)
+void wxTipWindowView::OnPaint(wxPaintEvent& WXUNUSED(event))

 {
     wxPaintDC dc(this);
 
 {
     wxPaintDC dc(this);
 


@@ -162,43 +326,55 @@ void wxTipWindow::OnPaint(wxPaintEvent& event)
     rect.height = size.y;
 
     // first filll the background
     rect.height = size.y;
 
     // first filll the background

-    dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
-
-    // Under Windows, you apparently get a thin black border whether you like it or not :-(
-#ifdef __WXMSW__
-    dc.SetPen( * wxTRANSPARENT_PEN );
-#else
-    dc.SetPen( * wxBLACK_PEN );
-#endif
+    dc.SetBrush(wxBrush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID));
+    dc.SetPen(wxPen(GetForegroundColour(), 1, wxPENSTYLE_SOLID));

     dc.DrawRectangle(rect);
 
     // and then draw the text line by line
     dc.DrawRectangle(rect);
 
     // and then draw the text line by line

+    dc.SetTextBackground(GetBackgroundColour());
+    dc.SetTextForeground(GetForegroundColour());

     dc.SetFont(GetFont());
 
     wxPoint pt;
     pt.x = TEXT_MARGIN_X;
     pt.y = TEXT_MARGIN_Y;
     dc.SetFont(GetFont());
 
     wxPoint pt;
     pt.x = TEXT_MARGIN_X;
     pt.y = TEXT_MARGIN_Y;

-    size_t count = m_textLines.GetCount();
+    size_t count = m_parent->m_textLines.GetCount();

     for ( size_t n = 0; n < count; n++ )
     {
     for ( size_t n = 0; n < count; n++ )
     {

-        dc.DrawText(m_textLines[n], pt);
+        dc.DrawText(m_parent->m_textLines[n], pt);

 
 

-        pt.y += m_heightLine;
+        pt.y += m_parent->m_heightLine;

     }
 }
 
     }
 }
 

-void wxTipWindow::OnMouseClick(wxMouseEvent& event)
+void wxTipWindowView::OnMouseClick(wxMouseEvent& WXUNUSED(event))

 {
 {

-    Close();
+    m_parent->Close();

 }
 
 }
 

-void wxTipWindow::OnActivate(wxActivateEvent& event)
+void wxTipWindowView::OnMouseMove(wxMouseEvent& event)

 {
 {

-    if (!event.GetActive())
-        Close();
+    const wxRect& rectBound = m_parent->m_rectBound;
+
+    if ( rectBound.width &&
+            !rectBound.Contains(ClientToScreen(event.GetPosition())) )
+    {
+        // mouse left the bounding rect, disappear
+        m_parent->Close();
+    }
+    else
+    {
+        event.Skip();
+    }

 }
 
 }
 

-void wxTipWindow::OnKillFocus(wxFocusEvent& event)
+#if !wxUSE_POPUPWIN
+void wxTipWindowView::OnKillFocus(wxFocusEvent& WXUNUSED(event))

 {
 {

-    Close();
+    // Workaround the kill focus event happening just after creation in wxGTK
+    if (wxGetLocalTime() > m_creationTime + 1)
+        m_parent->Close();

 }
 }

+#endif // !wxUSE_POPUPWIN
+
+#endif // wxUSE_TIPWINDOW