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 a902a891c78b657bb5102ccaa492bcb246d1a4e9..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,8 +31,13 @@
 #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"
 #include "wx/tipwin.h"

+
+#if wxUSE_TIPWINDOW
+

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


@@ -43,25 +48,12 @@
 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;
 

-// ============================================================================
-// implementation
-// ============================================================================
-

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

-// event tables
+// wxTipWindowView

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

-BEGIN_EVENT_TABLE(wxTipWindow, wxPopupTransientWindow)
-    EVT_LEFT_DOWN(wxTipWindow::OnMouseClick)
-    EVT_RIGHT_DOWN(wxTipWindow::OnMouseClick)
-    EVT_MIDDLE_DOWN(wxTipWindow::OnMouseClick)
-    EVT_PAINT(wxTipWindow::OnPaint)
-END_EVENT_TABLE()
-
-
-#if 0

 // Viewer window to put in the frame
 // Viewer window to put in the frame

-class wxTipWindowView: public wxWindow
+class WXDLLEXPORT wxTipWindowView : public wxWindow

 {
 public:
     wxTipWindowView(wxWindow *parent);
 {
 public:
     wxTipWindowView(wxWindow *parent);


@@ -69,24 +61,58 @@ public:
     // event handlers
     void OnPaint(wxPaintEvent& event);
     void OnMouseClick(wxMouseEvent& event);
     // event handlers
     void OnPaint(wxPaintEvent& event);
     void OnMouseClick(wxMouseEvent& event);

+    void OnMouseMove(wxMouseEvent& event);
+
+#if !wxUSE_POPUPWIN

     void OnKillFocus(wxFocusEvent& event);
     void OnKillFocus(wxFocusEvent& event);

+#endif // wxUSE_POPUPWIN

 
     // calculate the client rect we need to display the text
     void Adjust(const wxString& text, wxCoord maxLength);
 
 
     // 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;
     long m_creationTime;

+#endif // !wxUSE_POPUPWIN

 
 

-  DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxTipWindowView)

 };
 
 };
 

+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// event tables
+// ----------------------------------------------------------------------------
+
+BEGIN_EVENT_TABLE(wxTipWindow, wxTipWindowBase)
+    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)
+#endif // !wxUSE_POPUPWIN
+END_EVENT_TABLE()
+

 BEGIN_EVENT_TABLE(wxTipWindowView, wxWindow)
     EVT_PAINT(wxTipWindowView::OnPaint)
 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_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)
     EVT_KILL_FOCUS(wxTipWindowView::OnKillFocus)

+#endif // !wxUSE_POPUPWIN

 END_EVENT_TABLE()
 END_EVENT_TABLE()

-#endif

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


@@ -94,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))


@@ -133,131 +188,80 @@ void wxTipWindow::OnMouseClick(wxMouseEvent& WXUNUSED(event))
     Close();
 }
 
     Close();
 }
 

+#if wxUSE_POPUPWIN

 
 

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

 {
 {

-    wxPaintDC dc(this);
-
-    wxRect rect;
-    wxSize size = GetClientSize();
-    rect.width = size.x;
-    rect.height = size.y;
-
-    // first filll the background
-    dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
-
-    dc.SetPen( * wxBLACK_PEN );
-    dc.DrawRectangle(rect);
-
-    // and then draw the text line by line
-    dc.SetFont(GetFont());
-
-    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);
-
-        pt.y += m_heightLine;
-    }
+    Close();

 }
 
 }
 

+#else // !wxUSE_POPUPWIN

 
 

-void wxTipWindow::Adjust(const wxString& text, wxCoord maxLength)
+void wxTipWindow::OnActivate(wxActivateEvent& event)

 {
 {

-    wxClientDC dc(this);
-    dc.SetFont(GetFont());
-
-    // calculate the length: we want each line be no longer than maxLength
-    // pixels and we only break lines at words boundary
-    wxString current;
-    wxCoord height, width,
-            widthMax = 0;
-    m_heightLine = 0;
-
-    bool breakLine = FALSE;
-    for ( const wxChar *p = text.c_str(); ; p++ )
-    {
-        if ( *p == _T('\n') || *p == _T('\0') )
-        {
-            dc.GetTextExtent(current, &width, &height);
-            if ( width > widthMax )
-                widthMax = width;
-
-            if ( height > m_heightLine )
-                m_heightLine = height;
-
-            m_textLines.Add(current);
-
-            if ( !*p )
-            {
-                // end of text
-                break;
-            }
-
-            current.clear();
-            breakLine = FALSE;
-        }
-        else if ( breakLine && (*p == _T(' ') || *p == _T('\t')) )
-        {
-            // word boundary - break the line here
-            m_textLines.Add(current);
-            current.clear();
-            breakLine = FALSE;
-        }
-        else // line goes on
-        {
-            current += *p;
-            dc.GetTextExtent(current, &width, &height);
-            if ( width > maxLength )
-                breakLine = TRUE;
+    if (!event.GetActive())
+        Close();
+}

 
 

-            if ( width > widthMax )
-                widthMax = width;
+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
+}

 
 

-            if ( height > m_heightLine )
-                m_heightLine = height;
-        }
-    }
+#endif // wxUSE_POPUPWIN // !wxUSE_POPUPWIN

 
 

-    // 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);
+void wxTipWindow::SetBoundingRect(const wxRect& rectBound)
+{
+    m_rectBound = rectBound;

 }
 
 }
 

-

 void wxTipWindow::Close()
 {
 void wxTipWindow::Close()
 {

+    if ( m_windowPtr )
+    {
+        *m_windowPtr = NULL;
+        m_windowPtr = NULL;
+    }
+
+#if wxUSE_POPUPWIN

     Show(FALSE);
     Show(FALSE);

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

     Destroy();
     Destroy();

+#else
+    wxFrame::Close();
+#endif

 }
 
 }
 

-

 // ----------------------------------------------------------------------------
 // wxTipWindowView
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTipWindowView
 // ----------------------------------------------------------------------------

-#if 0
+

 wxTipWindowView::wxTipWindowView(wxWindow *parent)
 wxTipWindowView::wxTipWindowView(wxWindow *parent)

-           : wxWindow(parent, -1,
-                     wxDefaultPosition, wxDefaultSize,
-                     wxNO_BORDER)
+               : wxWindow(parent, -1,
+                          wxDefaultPosition, wxDefaultSize,
+                          wxNO_BORDER)

 {
     // set colours
 {
     // set colours

-    SetForegroundColour(*wxBLACK);
-#ifdef __WXMSW__
-    wxColour bkCol(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_INFOBK));
-#else
-    wxColour bkCol(wxColour(255, 255, 225));
-#endif
-    SetBackgroundColour(bkCol);
+    SetForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));
+
+#if !wxUSE_POPUPWIN

     m_creationTime = wxGetLocalTime();
     m_creationTime = wxGetLocalTime();

+#endif // !wxUSE_POPUPWIN
+
+    m_parent = (wxTipWindow*)parent;

 }
 
 void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
 {
 }
 
 void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
 {

-    wxTipWindow* parent = (wxTipWindow*) GetParent();

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


@@ -266,7 +270,7 @@ void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
     wxString current;
     wxCoord height, width,
             widthMax = 0;
     wxString current;
     wxCoord height, width,
             widthMax = 0;

-    parent->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++ )


@@ -277,10 +281,10 @@ void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
             if ( width > widthMax )
                 widthMax = width;
 
             if ( width > widthMax )
                 widthMax = width;
 

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

 
 

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

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


@@ -294,7 +298,7 @@ void wxTipWindowView::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

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

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


@@ -308,22 +312,20 @@ void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
             if ( width > widthMax )
                 widthMax = width;
 
             if ( width > widthMax )
                 widthMax = width;
 

-            if ( height > parent->m_heightLine )
-                parent->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

-    GetParent()->SetClientSize(2*(TEXT_MARGIN_X + 1) + widthMax,
-                  2*(TEXT_MARGIN_Y + 1) + parent->m_textLines.GetCount()*parent->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))
 {
 }
 
 void wxTipWindowView::OnPaint(wxPaintEvent& WXUNUSED(event))
 {

-    wxTipWindow* parent = (wxTipWindow*) GetParent();
-    if (!parent)
-      return;
-

     wxPaintDC dc(this);
 
     wxRect rect;
     wxPaintDC dc(this);
 
     wxRect rect;


@@ -333,35 +335,54 @@ void wxTipWindowView::OnPaint(wxPaintEvent& WXUNUSED(event))
 
     // first filll the background
     dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
 
     // first filll the background
     dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));

-
-    dc.SetPen( * wxBLACK_PEN );
+    dc.SetPen( wxPen(GetForegroundColour(), 1, wxSOLID) );

     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 = parent->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(parent->m_textLines[n], pt);
+        dc.DrawText(m_parent->m_textLines[n], pt);

 
 

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

     }
 }
 
 void wxTipWindowView::OnMouseClick(wxMouseEvent& WXUNUSED(event))
 {
     }
 }
 
 void wxTipWindowView::OnMouseClick(wxMouseEvent& WXUNUSED(event))
 {

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

 }
 
 }
 

+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)
 void wxTipWindowView::OnKillFocus(wxFocusEvent& WXUNUSED(event))
 {
     // Workaround the kill focus event happening just after creation in wxGTK
     if (wxGetLocalTime() > m_creationTime + 1)

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

 }
 }

+#endif // !wxUSE_POPUPWIN

 
 

-#endif
+#endif // wxUSE_TIPWINDOW