src/generic/tipwin.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/tipwin.cpp
   3 // Purpose:     implementation of wxTipWindow
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     10.09.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "tipwin.h"
  22 #endif
  23
  24 // For compilers that support precompilatixon, includes "wx/wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/dcclient.h"
  33 #endif // WX_PRECOMP
  34
  35 #include "wx/tipwin.h"
  36 #include "wx/timer.h"
  37
  38 // ----------------------------------------------------------------------------
  39 // constants
  40 // ----------------------------------------------------------------------------
  41
  42 static const wxCoord TEXT_MARGIN_X = 3;
  43 static const wxCoord TEXT_MARGIN_Y = 3;
  44
  45 // ============================================================================
  46 // implementation
  47 // ============================================================================
  48
  49 // ----------------------------------------------------------------------------
  50 // event tables
  51 // ----------------------------------------------------------------------------
  52
  53 BEGIN_EVENT_TABLE(wxTipWindow, wxFrame)
  54     EVT_LEFT_DOWN(wxTipWindow::OnMouseClick)
  55     EVT_RIGHT_DOWN(wxTipWindow::OnMouseClick)
  56     EVT_MIDDLE_DOWN(wxTipWindow::OnMouseClick)
  57     EVT_KILL_FOCUS(wxTipWindow::OnKillFocus)
  58     EVT_ACTIVATE(wxTipWindow::OnActivate)
  59 END_EVENT_TABLE()
  60
  61 // Viewer window to put in the frame
  62 class wxTipWindowView: public wxWindow
  63 {
  64 public:
  65     wxTipWindowView(wxWindow *parent);
  66
  67     // event handlers
  68     void OnPaint(wxPaintEvent& event);
  69     void OnMouseClick(wxMouseEvent& event);
  70     void OnKillFocus(wxFocusEvent& event);
  71
  72     // calculate the client rect we need to display the text
  73     void Adjust(const wxString& text, wxCoord maxLength);
  74
  75     long m_creationTime;
  76
  77   DECLARE_EVENT_TABLE()
  78 };
  79
  80 BEGIN_EVENT_TABLE(wxTipWindowView, wxWindow)
  81     EVT_PAINT(wxTipWindowView::OnPaint)
  82     EVT_LEFT_DOWN(wxTipWindowView::OnMouseClick)
  83     EVT_RIGHT_DOWN(wxTipWindowView::OnMouseClick)
  84     EVT_MIDDLE_DOWN(wxTipWindowView::OnMouseClick)
  85     EVT_KILL_FOCUS(wxTipWindowView::OnKillFocus)
  86 END_EVENT_TABLE()
  87
  88
  89 // ----------------------------------------------------------------------------
  90 // wxTipWindow
  91 // ----------------------------------------------------------------------------
  92
  93 wxTipWindow::wxTipWindow(wxWindow *parent,
  94                          const wxString& text,
  95                          wxCoord maxLength, wxTipWindow** windowPtr)
  96            : wxFrame(parent, -1, _T(""),
  97                      wxDefaultPosition, wxDefaultSize,
  98                      wxNO_BORDER | wxFRAME_FLOAT_ON_PARENT)
  99 {
 100     // set colours
 101     SetForegroundColour(*wxBLACK);
 102 #if !defined(__WXPM__)
 103     SetBackgroundColour(wxColour(0xc3ffff));
 104 #else
 105     // What is 0xc3ffff, try some legable documentation for those of us who don't memorize hex codes??
 106     SetBackgroundColour(wxColour(*wxWHITE));
 107 #endif
 108     // set position and size
 109     int x, y;
 110     wxGetMousePosition(&x, &y);
 111     Move(x, y + 20);
 112
 113     wxTipWindowView* tipWindowView = new wxTipWindowView(this);
 114     tipWindowView->Adjust(text, maxLength);
 115
 116     m_windowPtr = windowPtr;
 117
 118     Show(TRUE);
 119     tipWindowView->SetFocus();
 120 }
 121
 122 wxTipWindow::~wxTipWindow()
 123 {
 124     if (m_windowPtr)
 125     {
 126         *m_windowPtr = NULL;
 127     }
 128 }
 129
 130 void wxTipWindow::OnMouseClick(wxMouseEvent& event)
 131 {
 132     Close();
 133 }
 134
 135 void wxTipWindow::OnActivate(wxActivateEvent& event)
 136 {
 137     if (!event.GetActive())
 138         Close();
 139 }
 140
 141 void wxTipWindow::OnKillFocus(wxFocusEvent& event)
 142 {
 143     Close();
 144 }
 145
 146 // ----------------------------------------------------------------------------
 147 // wxTipWindowView
 148 // ----------------------------------------------------------------------------
 149
 150 wxTipWindowView::wxTipWindowView(wxWindow *parent)
 151            : wxWindow(parent, -1,
 152                      wxDefaultPosition, wxDefaultSize,
 153                      wxNO_BORDER)
 154 {
 155     // set colours
 156     SetForegroundColour(*wxBLACK);
 157 #if !defined(__WXPM__)
 158     SetBackgroundColour(wxColour(0xc3ffff));
 159 #else
 160     // What is 0xc3ffff, try some legable documentation for those of us who don't memorize hex codes??
 161     SetBackgroundColour(wxColour(*wxWHITE));
 162 #endif
 163     m_creationTime = wxGetLocalTime();
 164 }
 165
 166 void wxTipWindowView::Adjust(const wxString& text, wxCoord maxLength)
 167 {
 168     wxTipWindow* parent = (wxTipWindow*) GetParent();
 169     wxClientDC dc(this);
 170     dc.SetFont(GetFont());
 171
 172     // calculate the length: we want each line be no longer than maxLength
 173     // pixels and we only break lines at words boundary
 174     wxString current;
 175     wxCoord height, width,
 176             widthMax = 0;
 177     parent->m_heightLine = 0;
 178
 179     bool breakLine = FALSE;
 180     for ( const wxChar *p = text.c_str(); ; p++ )
 181     {
 182         if ( *p == _T('\n') || *p == _T('\0') )
 183         {
 184             dc.GetTextExtent(current, &width, &height);
 185             if ( width > widthMax )
 186                 widthMax = width;
 187
 188             if ( height > parent->m_heightLine )
 189                 parent->m_heightLine = height;
 190
 191             parent->m_textLines.Add(current);
 192
 193             if ( !*p )
 194             {
 195                 // end of text
 196                 break;
 197             }
 198
 199             current.clear();
 200             breakLine = FALSE;
 201         }
 202         else if ( breakLine && (*p == _T(' ') || *p == _T('\t')) )
 203         {
 204             // word boundary - break the line here
 205             parent->m_textLines.Add(current);
 206             current.clear();
 207             breakLine = FALSE;
 208         }
 209         else // line goes on
 210         {
 211             current += *p;
 212             dc.GetTextExtent(current, &width, &height);
 213             if ( width > maxLength )
 214                 breakLine = TRUE;
 215
 216             if ( width > widthMax )
 217                 widthMax = width;
 218
 219             if ( height > parent->m_heightLine )
 220                 parent->m_heightLine = height;
 221         }
 222     }
 223
 224     // take into account the border size and the margins
 225     GetParent()->SetClientSize(2*(TEXT_MARGIN_X + 1) + widthMax,
 226                   2*(TEXT_MARGIN_Y + 1) + parent->m_textLines.GetCount()*parent->m_heightLine);
 227 }
 228
 229 void wxTipWindowView::OnPaint(wxPaintEvent& event)
 230 {
 231     wxTipWindow* parent = (wxTipWindow*) GetParent();
 232     if (!parent)
 233       return;
 234
 235     wxPaintDC dc(this);
 236
 237     wxRect rect;
 238     wxSize size = GetClientSize();
 239     rect.width = size.x;
 240     rect.height = size.y;
 241
 242     // first filll the background
 243     dc.SetBrush(wxBrush(GetBackgroundColour(), wxSOLID));
 244
 245     // Under Windows, you apparently get a thin black border whether you like it or not :-(
 246 #ifdef __WXMSW__
 247     dc.SetPen( * wxTRANSPARENT_PEN );
 248 #else
 249     dc.SetPen( * wxBLACK_PEN );
 250 #endif
 251     dc.DrawRectangle(rect);
 252
 253     // and then draw the text line by line
 254     dc.SetFont(GetFont());
 255
 256     wxPoint pt;
 257     pt.x = TEXT_MARGIN_X;
 258     pt.y = TEXT_MARGIN_Y;
 259     size_t count = parent->m_textLines.GetCount();
 260     for ( size_t n = 0; n < count; n++ )
 261     {
 262         dc.DrawText(parent->m_textLines[n], pt);
 263
 264         pt.y += parent->m_heightLine;
 265     }
 266 }
 267
 268 void wxTipWindowView::OnMouseClick(wxMouseEvent& event)
 269 {
 270     GetParent()->Close();
 271 }
 272
 273 void wxTipWindowView::OnKillFocus(wxFocusEvent& event)
 274 {
 275     // Workaround the kill focus event happening just after creation in wxGTK
 276     if (wxGetLocalTime() > m_creationTime + 1)
 277         GetParent()->Close();
 278 }