fixed bug #890430, parameter documented twice

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

diff --git a/src/generic/tipwin.cpp b/src/generic/tipwin.cpp
index 824df917432a5fec18738a45ef01cc01a4041f98..17093b2d9e5d71b8f2f7fe7b2ce9ac9f03eb16fd 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,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma implementation "tipwin.h"
 #endif
 
     #pragma implementation "tipwin.h"
 #endif
 


@@ -31,7 +31,9 @@
 #ifndef WX_PRECOMP
     #include "wx/dcclient.h"
 #endif // WX_PRECOMP
 #ifndef WX_PRECOMP
     #include "wx/dcclient.h"
 #endif // WX_PRECOMP

-
+#ifdef __WXGTK__
+    #include <gtk/gtk.h>
+#endif

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


@@ -46,6 +48,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()
+    DECLARE_NO_COPY_CLASS(wxTipWindowView)
+};
+

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


@@ -54,13 +89,30 @@ static const wxCoord TEXT_MARGIN_Y = 3;
 // event tables
 // ----------------------------------------------------------------------------
 
 // event tables
 // ----------------------------------------------------------------------------
 

-BEGIN_EVENT_TABLE(wxTipWindow, wxPopupTransientWindow)
+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)

-    EVT_PAINT(wxTipWindow::OnPaint)
+
+#if !wxUSE_POPUPWIN
+    EVT_KILL_FOCUS(wxTipWindow::OnKillFocus)
+    EVT_ACTIVATE(wxTipWindow::OnActivate)
+#endif // !wxUSE_POPUPWIN

 END_EVENT_TABLE()
 
 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()

 
 // ----------------------------------------------------------------------------
 // wxTipWindow
 
 // ----------------------------------------------------------------------------
 // wxTipWindow


@@ -68,38 +120,67 @@ END_EVENT_TABLE()
 
 wxTipWindow::wxTipWindow(wxWindow *parent,
                          const wxString& text,
 
 wxTipWindow::wxTipWindow(wxWindow *parent,
                          const wxString& text,

-                         wxCoord maxLength, wxTipWindow** windowPtr)
+                         wxCoord maxLength,
+                         wxTipWindow** windowPtr,
+                         wxRect *rectBounds)
+#if wxUSE_POPUPWIN

            : wxPopupTransientWindow(parent)
            : wxPopupTransientWindow(parent)

+#else
+           : wxFrame(parent, -1, _T(""),
+                     wxDefaultPosition, wxDefaultSize,
+                     wxNO_BORDER | wxFRAME_NO_TASKBAR )
+#endif

 {
 {

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

 
     // set colours
 
     // set colours

-    SetForegroundColour(*wxBLACK);
+    SetForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));

 
 

-#ifdef __WXMSW__
-    wxColour bkCol(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_INFOBK));
-#else
-    wxColour bkCol(wxColour(255, 255, 225));
-#endif
-    SetBackgroundColour(bkCol);
+    // set size, position and show it
+    m_view = new wxTipWindowView(this);
+    m_view->Adjust(text, maxLength);
+    m_view->SetFocus();

 
 

-    // set size and position
-    Adjust(text, maxLength);

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

-    Position(wxPoint(x, y+10), wxSize(0,0));

 
 

-    //Show(TRUE);
-    Popup();
-    SetFocus();
+    // 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__
+        if (!GTK_WIDGET_HAS_GRAB(m_widget))
+            gtk_grab_add( m_widget );
+    #endif   
+#else
+    Move(x, y);
+    Show(TRUE);
+#endif

 }
 
 wxTipWindow::~wxTipWindow()
 {
 }
 
 wxTipWindow::~wxTipWindow()
 {

-    if (m_windowPtr)
+    if ( m_windowPtr )

     {
         *m_windowPtr = NULL;
     }
     {
         *m_windowPtr = NULL;
     }

+    #ifdef wxUSE_POPUPWIN
+        #ifdef __WXGTK__
+            if (GTK_WIDGET_HAS_GRAB(m_widget))
+                gtk_grab_remove( m_widget );
+        #endif
+    #endif

 }
 
 void wxTipWindow::OnMouseClick(wxMouseEvent& WXUNUSED(event))
 }
 
 void wxTipWindow::OnMouseClick(wxMouseEvent& WXUNUSED(event))


@@ -107,39 +188,79 @@ void wxTipWindow::OnMouseClick(wxMouseEvent& WXUNUSED(event))
     Close();
 }
 
     Close();
 }
 

+#if wxUSE_POPUPWIN

 
 

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

 {
 {

-    wxPaintDC dc(this);
+    Close();
+}

 
 

-    wxRect rect;
-    wxSize size = GetClientSize();
-    rect.width = size.x;
-    rect.height = size.y;
+#else // !wxUSE_POPUPWIN

 
 

-    // first filll the background
-    dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
+void wxTipWindow::OnActivate(wxActivateEvent& event)
+{
+    if (!event.GetActive())
+        Close();
+}

 
 

-    dc.SetPen( * wxBLACK_PEN );
-    dc.DrawRectangle(rect);
+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
+}

 
 

-    // and then draw the text line by line
-    dc.SetFont(GetFont());
+#endif // wxUSE_POPUPWIN // !wxUSE_POPUPWIN

 
 

-    wxPoint pt;
-    pt.x = TEXT_MARGIN_X;
-    pt.y = TEXT_MARGIN_Y;
-    size_t count = m_textLines.GetCount();
-    for ( size_t n = 0; n < count; n++ )
-    {
-        dc.DrawText(m_textLines[n], pt);
+void wxTipWindow::SetBoundingRect(const wxRect& rectBound)
+{
+    m_rectBound = rectBound;
+}

 
 

-        pt.y += m_heightLine;
+void wxTipWindow::Close()
+{
+    if ( m_windowPtr )
+    {
+        *m_windowPtr = NULL;
+        m_windowPtr = NULL;

     }
     }

+
+#if wxUSE_POPUPWIN
+    Show(FALSE);
+    #ifdef __WXGTK__
+        if (GTK_WIDGET_HAS_GRAB(m_widget))
+            gtk_grab_remove( m_widget );
+    #endif   
+    Destroy();
+#else
+    wxFrame::Close();
+#endif

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// wxTipWindowView
+// ----------------------------------------------------------------------------

 
 

-void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
+wxTipWindowView::wxTipWindowView(wxWindow *parent)
+               : wxWindow(parent, -1,
+                          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());


@@ -149,7 +270,7 @@ 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;
     for ( const wxChar *p = text.c_str(); ; p++ )
 
     bool breakLine = FALSE;
     for ( const wxChar *p = text.c_str(); ; p++ )


@@ -160,10 +281,10 @@ void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
             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;

 
 

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

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


@@ -177,7 +298,7 @@ void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
         else if ( breakLine && (*p == _T(' ') || *p == _T('\t')) )
         {
             // word boundary - break the line here
         else if ( breakLine && (*p == _T(' ') || *p == _T('\t')) )
         {
             // word boundary - break the line here

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

             current.clear();
             breakLine = FALSE;
         }
             current.clear();
             breakLine = FALSE;
         }


@@ -191,22 +312,77 @@ void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
             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) + m_parent->m_textLines.GetCount()*m_parent->m_heightLine;
+    m_parent->SetClientSize(width, height);
+    SetSize(0, 0, width, height);

 }
 
 }
 

+void wxTipWindowView::OnPaint(wxPaintEvent& WXUNUSED(event))
+{
+    wxPaintDC dc(this);

 
 

-void wxTipWindow::Close()
+    wxRect rect;
+    wxSize size = GetClientSize();
+    rect.width = size.x;
+    rect.height = size.y;
+
+    // first filll the background
+    dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
+    dc.SetPen( wxPen(GetForegroundColour(), 1, wxSOLID) );
+    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;
+    size_t count = m_parent->m_textLines.GetCount();
+    for ( size_t n = 0; n < count; n++ )
+    {
+        dc.DrawText(m_parent->m_textLines[n], pt);
+
+        pt.y += m_parent->m_heightLine;
+    }
+}
+
+void wxTipWindowView::OnMouseClick(wxMouseEvent& WXUNUSED(event))

 {
 {

-    Show(FALSE);
-    Destroy();
+    m_parent->Close();

 }
 
 }
 

-#endif // wxUSE_TIPWINDOW
+void wxTipWindowView::OnMouseMove(wxMouseEvent& event)
+{
+    const wxRect& rectBound = m_parent->m_rectBound;

 
 

+    if ( rectBound.width &&
+            !rectBound.Inside(ClientToScreen(event.GetPosition())) )
+    {
+        // mouse left the bounding rect, disappear
+        m_parent->Close();
+    }
+    else
+    {
+        event.Skip();
+    }
+}
+
+#if !wxUSE_POPUPWIN
+void wxTipWindowView::OnKillFocus(wxFocusEvent& WXUNUSED(event))
+{
+    // 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