src/common/containr.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/containr.cpp
   3 // Purpose:     implementation of wxControlContainer
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     06.08.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/containr.h"
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/log.h"
  33     #include "wx/event.h"
  34     #include "wx/window.h"
  35     #include "wx/scrolbar.h"
  36     #include "wx/radiobut.h"
  37 #endif //WX_PRECOMP
  38
  39 // trace mask for focus messages
  40 #define TRACE_FOCUS wxT("focus")
  41
  42 // ============================================================================
  43 // implementation
  44 // ============================================================================
  45
  46 // ----------------------------------------------------------------------------
  47 // wxControlContainerBase
  48 // ----------------------------------------------------------------------------
  49
  50 void wxControlContainerBase::SetCanFocus(bool acceptsFocus)
  51 {
  52     if ( acceptsFocus == m_acceptsFocus )
  53         return;
  54
  55     m_acceptsFocus = acceptsFocus;
  56
  57     m_winParent->SetCanFocus(m_acceptsFocus);
  58 }
  59
  60 bool wxControlContainerBase::HasAnyFocusableChildren() const
  61 {
  62     const wxWindowList& children = m_winParent->GetChildren();
  63     for ( wxWindowList::const_iterator i = children.begin(),
  64                                      end = children.end();
  65           i != end;
  66           ++i )
  67     {
  68         const wxWindow * const child = *i;
  69
  70         if ( !m_winParent->IsClientAreaChild(child) )
  71             continue;
  72
  73         if ( child->CanAcceptFocus() )
  74             return true;
  75     }
  76
  77     return false;
  78 }
  79
  80 bool wxControlContainerBase::DoSetFocus()
  81 {
  82     wxLogTrace(TRACE_FOCUS, wxT("SetFocus on wxPanel 0x%p."),
  83                m_winParent->GetHandle());
  84
  85     if (m_inSetFocus)
  86         return true;
  87
  88     // when the panel gets the focus we move the focus to either the last
  89     // window that had the focus or the first one that can get it unless the
  90     // focus had been already set to some other child
  91
  92     wxWindow *win = wxWindow::FindFocus();
  93     while ( win )
  94     {
  95         if ( win == m_winParent )
  96         {
  97             // our child already has focus, don't take it away from it
  98             return true;
  99         }
 100
 101         if ( win->IsTopLevel() )
 102         {
 103             // don't look beyond the first top level parent - useless and
 104             // unnecessary
 105             break;
 106         }
 107
 108         win = win->GetParent();
 109     }
 110
 111     // protect against infinite recursion:
 112     m_inSetFocus = true;
 113
 114     bool ret = SetFocusToChild();
 115
 116     m_inSetFocus = false;
 117
 118     return ret;
 119 }
 120
 121 bool wxControlContainerBase::SetFocusToChild()
 122 {
 123     return wxSetFocusToChild(m_winParent, &m_winLastFocused);
 124 }
 125
 126 #ifndef wxHAS_NATIVE_TAB_TRAVERSAL
 127
 128 // ----------------------------------------------------------------------------
 129 // generic wxControlContainer
 130 // ----------------------------------------------------------------------------
 131
 132 wxControlContainer::wxControlContainer()
 133 {
 134     m_winLastFocused = NULL;
 135 }
 136
 137 void wxControlContainer::SetLastFocus(wxWindow *win)
 138 {
 139     // the panel itself should never get the focus at all but if it does happen
 140     // temporarily (as it seems to do under wxGTK), at the very least don't
 141     // forget our previous m_winLastFocused
 142     if ( win != m_winParent )
 143     {
 144         // if we're setting the focus
 145         if ( win )
 146         {
 147             // find the last _immediate_ child which got focus
 148             wxWindow *winParent = win;
 149             while ( winParent != m_winParent )
 150             {
 151                 win = winParent;
 152                 winParent = win->GetParent();
 153
 154                 // Yes, this can happen, though in a totally pathological case.
 155                 // like when detaching a menubar from a frame with a child
 156                 // which has pushed itself as an event handler for the menubar.
 157                 // (under wxGTK)
 158
 159                 wxASSERT_MSG( winParent,
 160                               wxT("Setting last focus for a window that is not our child?") );
 161             }
 162         }
 163
 164         m_winLastFocused = win;
 165
 166         if ( win )
 167         {
 168             wxLogTrace(TRACE_FOCUS, wxT("Set last focus to %s(%s)"),
 169                        win->GetClassInfo()->GetClassName(),
 170                        win->GetLabel().c_str());
 171         }
 172         else
 173         {
 174             wxLogTrace(TRACE_FOCUS, wxT("No more last focus"));
 175         }
 176     }
 177 }
 178
 179 // --------------------------------------------------------------------
 180 // The following four functions are used to find other radio buttons
 181 // within the same group. Used by wxSetFocusToChild on wxMSW
 182 // --------------------------------------------------------------------
 183
 184 #if defined(__WXMSW__) && wxUSE_RADIOBTN
 185
 186 wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn)
 187 {
 188     if ( btn->HasFlag(wxRB_GROUP) || btn->HasFlag(wxRB_SINGLE) )
 189         return NULL;
 190
 191     const wxWindowList& siblings = btn->GetParent()->GetChildren();
 192     wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn);
 193     wxCHECK_MSG( nodeThis, NULL, wxT("radio button not a child of its parent?") );
 194
 195     // Iterate over all previous siblings until we find the next radio button
 196     wxWindowList::compatibility_iterator nodeBefore = nodeThis->GetPrevious();
 197     wxRadioButton *prevBtn = 0;
 198     while (nodeBefore)
 199     {
 200         prevBtn = wxDynamicCast(nodeBefore->GetData(), wxRadioButton);
 201         if (prevBtn)
 202             break;
 203
 204         nodeBefore = nodeBefore->GetPrevious();
 205     }
 206
 207     if (!prevBtn || prevBtn->HasFlag(wxRB_SINGLE))
 208     {
 209         // no more buttons in group
 210         return NULL;
 211     }
 212
 213     return prevBtn;
 214 }
 215
 216 wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn)
 217 {
 218     if (btn->HasFlag(wxRB_SINGLE))
 219         return NULL;
 220
 221     const wxWindowList& siblings = btn->GetParent()->GetChildren();
 222     wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn);
 223     wxCHECK_MSG( nodeThis, NULL, wxT("radio button not a child of its parent?") );
 224
 225     // Iterate over all previous siblings until we find the next radio button
 226     wxWindowList::compatibility_iterator nodeNext = nodeThis->GetNext();
 227     wxRadioButton *nextBtn = 0;
 228     while (nodeNext)
 229     {
 230         nextBtn = wxDynamicCast(nodeNext->GetData(), wxRadioButton);
 231         if (nextBtn)
 232             break;
 233
 234         nodeNext = nodeNext->GetNext();
 235     }
 236
 237     if ( !nextBtn || nextBtn->HasFlag(wxRB_GROUP) || nextBtn->HasFlag(wxRB_SINGLE) )
 238     {
 239         // no more buttons or the first button of the next group
 240         return NULL;
 241     }
 242
 243     return nextBtn;
 244 }
 245
 246 wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn)
 247 {
 248     while (true)
 249     {
 250         wxRadioButton* prevBtn = wxGetPreviousButtonInGroup(btn);
 251         if (!prevBtn)
 252             return btn;
 253
 254         btn = prevBtn;
 255     }
 256 }
 257
 258 wxRadioButton* wxGetLastButtonInGroup(wxRadioButton *btn)
 259 {
 260     while (true)
 261     {
 262         wxRadioButton* nextBtn = wxGetNextButtonInGroup(btn);
 263         if (!nextBtn)
 264             return btn;
 265
 266         btn = nextBtn;
 267     }
 268 }
 269
 270 wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn)
 271 {
 272     // Find currently selected button
 273     if (btn->GetValue())
 274         return btn;
 275
 276     if (btn->HasFlag(wxRB_SINGLE))
 277         return NULL;
 278
 279     wxRadioButton *selBtn;
 280
 281     // First check all previous buttons
 282     for (selBtn = wxGetPreviousButtonInGroup(btn); selBtn; selBtn = wxGetPreviousButtonInGroup(selBtn))
 283         if (selBtn->GetValue())
 284             return selBtn;
 285
 286     // Now all following buttons
 287     for (selBtn = wxGetNextButtonInGroup(btn); selBtn; selBtn = wxGetNextButtonInGroup(selBtn))
 288         if (selBtn->GetValue())
 289             return selBtn;
 290
 291     return NULL;
 292 }
 293
 294 #endif // __WXMSW__
 295
 296 // ----------------------------------------------------------------------------
 297 // Keyboard handling - this is the place where the TAB traversal logic is
 298 // implemented. As this code is common to all ports, this ensures consistent
 299 // behaviour even if we don't specify how exactly the wxNavigationKeyEvent are
 300 // generated and this is done in platform specific code which also ensures that
 301 // we can follow the given platform standards.
 302 // ----------------------------------------------------------------------------
 303
 304 void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 305 {
 306     // for a TLW we shouldn't involve the parent window, it has nothing to do
 307     // with keyboard navigation inside this TLW
 308     wxWindow *parent = m_winParent->IsTopLevel() ? NULL
 309                                                  : m_winParent->GetParent();
 310
 311     // the event is propagated downwards if the event emitter was our parent
 312     bool goingDown = event.GetEventObject() == parent;
 313
 314     const wxWindowList& children = m_winParent->GetChildren();
 315
 316     // if we have exactly one notebook-like child window (actually it could be
 317     // any window that returns true from its HasMultiplePages()), then
 318     // [Shift-]Ctrl-Tab and Ctrl-PageUp/Down keys should iterate over its pages
 319     // even if the focus is outside of the control because this is how the
 320     // standard MSW properties dialogs behave and we do it under other platforms
 321     // as well because it seems like a good idea -- but we can always put this
 322     // block inside "#ifdef __WXMSW__" if it's not suitable there
 323     if ( event.IsWindowChange() && !goingDown )
 324     {
 325         // check if we have a unique notebook-like child
 326         wxWindow *bookctrl = NULL;
 327         for ( wxWindowList::const_iterator i = children.begin(),
 328                                          end = children.end();
 329               i != end;
 330               ++i )
 331         {
 332             wxWindow * const window = *i;
 333             if ( window->HasMultiplePages() )
 334             {
 335                 if ( bookctrl )
 336                 {
 337                     // this is the second book-like control already so don't do
 338                     // anything as we don't know which one should have its page
 339                     // changed
 340                     bookctrl = NULL;
 341                     break;
 342                 }
 343
 344                 bookctrl = window;
 345             }
 346         }
 347
 348         if ( bookctrl )
 349         {
 350             // make sure that we don't bubble up the event again from the book
 351             // control resulting in infinite recursion
 352             wxNavigationKeyEvent eventCopy(event);
 353             eventCopy.SetEventObject(m_winParent);
 354             if ( bookctrl->GetEventHandler()->ProcessEvent(eventCopy) )
 355                 return;
 356         }
 357     }
 358
 359     // there is not much to do if we don't have children and we're not
 360     // interested in "notebook page change" events here
 361     if ( !children.GetCount() || event.IsWindowChange() )
 362     {
 363         // let the parent process it unless it already comes from our parent
 364         // of we don't have any
 365         if ( goingDown ||
 366              !parent || !parent->GetEventHandler()->ProcessEvent(event) )
 367         {
 368             event.Skip();
 369         }
 370
 371         return;
 372     }
 373
 374     // where are we going?
 375     const bool forward = event.GetDirection();
 376
 377     // the node of the children list from which we should start looking for the
 378     // next acceptable child
 379     wxWindowList::compatibility_iterator node, start_node;
 380
 381     // we should start from the first/last control and not from the one which
 382     // had focus the last time if we're propagating the event downwards because
 383     // for our parent we look like a single control
 384     if ( goingDown )
 385     {
 386         // just to be sure it's not used (normally this is not necessary, but
 387         // doesn't hurt neither)
 388         m_winLastFocused = NULL;
 389
 390         // start from first or last depending on where we're going
 391         node = forward ? children.GetFirst() : children.GetLast();
 392     }
 393     else // going up
 394     {
 395         // try to find the child which has the focus currently
 396
 397         // the event emitter might have done this for us
 398         wxWindow *winFocus = event.GetCurrentFocus();
 399
 400         // but if not, we might know where the focus was ourselves
 401         if (!winFocus)
 402             winFocus = m_winLastFocused;
 403
 404         // if still no luck, do it the hard way
 405         if (!winFocus)
 406             winFocus = wxWindow::FindFocus();
 407
 408         if ( winFocus )
 409         {
 410 #if defined(__WXMSW__) && wxUSE_RADIOBTN
 411             // If we are in a radio button group, start from the first item in the
 412             // group
 413             if ( event.IsFromTab() && wxIsKindOf(winFocus, wxRadioButton ) )
 414                 winFocus = wxGetFirstButtonInGroup((wxRadioButton*)winFocus);
 415 #endif // __WXMSW__
 416             // ok, we found the focus - now is it our child?
 417             start_node = children.Find( winFocus );
 418         }
 419
 420         if ( !start_node && m_winLastFocused )
 421         {
 422             // window which has focus isn't our child, fall back to the one
 423             // which had the focus the last time
 424             start_node = children.Find( m_winLastFocused );
 425         }
 426
 427         // if we still didn't find anything, we should start with the first one
 428         if ( !start_node )
 429         {
 430             start_node = children.GetFirst();
 431         }
 432
 433         // and the first child which we can try setting focus to is the next or
 434         // the previous one
 435         node = forward ? start_node->GetNext() : start_node->GetPrevious();
 436     }
 437
 438     // we want to cycle over all elements passing by NULL
 439     for ( ;; )
 440     {
 441         // don't go into infinite loop
 442         if ( start_node && node && node == start_node )
 443             break;
 444
 445         // Have we come to the last or first item on the panel?
 446         if ( !node )
 447         {
 448             if ( !start_node )
 449             {
 450                 // exit now as otherwise we'd loop forever
 451                 break;
 452             }
 453
 454             if ( !goingDown )
 455             {
 456                 // Check if our (maybe grand) parent is another panel: if this
 457                 // is the case, they will know what to do with this navigation
 458                 // key and so give them the chance to process it instead of
 459                 // looping inside this panel (normally, the focus will go to
 460                 // the next/previous item after this panel in the parent
 461                 // panel).
 462                 wxWindow *focusedParent = m_winParent;
 463                 while ( parent )
 464                 {
 465                     // We don't want to tab into a different dialog or frame or
 466                     // even an MDI child frame, so test for this explicitly
 467                     // (and in particular don't just use IsTopLevel() which
 468                     // would return false in the latter case).
 469                     if ( focusedParent->IsTopNavigationDomain() )
 470                         break;
 471
 472                     event.SetCurrentFocus( focusedParent );
 473                     if ( parent->GetEventHandler()->ProcessEvent( event ) )
 474                         return;
 475
 476                     focusedParent = parent;
 477
 478                     parent = parent->GetParent();
 479                 }
 480             }
 481             //else: as the focus came from our parent, we definitely don't want
 482             //      to send it back to it!
 483
 484             // no, we are not inside another panel so process this ourself
 485             node = forward ? children.GetFirst() : children.GetLast();
 486
 487             continue;
 488         }
 489
 490         wxWindow *child = node->GetData();
 491
 492         // don't TAB to another TLW
 493         if ( child->IsTopLevel() )
 494         {
 495             node = forward ? node->GetNext() : node->GetPrevious();
 496
 497             continue;
 498         }
 499
 500 #if defined(__WXMSW__) && wxUSE_RADIOBTN
 501         if ( event.IsFromTab() )
 502         {
 503             if ( wxIsKindOf(child, wxRadioButton) )
 504             {
 505                 // only radio buttons with either wxRB_GROUP or wxRB_SINGLE
 506                 // can be tabbed to
 507                 if ( child->HasFlag(wxRB_GROUP) )
 508                 {
 509                     // need to tab into the active button within a group
 510                     wxRadioButton *rb = wxGetSelectedButtonInGroup((wxRadioButton*)child);
 511                     if ( rb )
 512                         child = rb;
 513                 }
 514                 else if ( !child->HasFlag(wxRB_SINGLE) )
 515                 {
 516                     node = forward ? node->GetNext() : node->GetPrevious();
 517                     continue;
 518                 }
 519             }
 520         }
 521         else if ( m_winLastFocused &&
 522                   wxIsKindOf(m_winLastFocused, wxRadioButton) &&
 523                   !m_winLastFocused->HasFlag(wxRB_SINGLE) )
 524         {
 525             wxRadioButton * const
 526                 lastBtn = static_cast<wxRadioButton *>(m_winLastFocused);
 527
 528             // cursor keys don't navigate out of a radio button group so
 529             // find the correct radio button to focus
 530             if ( forward )
 531             {
 532                 child = wxGetNextButtonInGroup(lastBtn);
 533                 if ( !child )
 534                 {
 535                     // no next button in group, set it to the first button
 536                     child = wxGetFirstButtonInGroup(lastBtn);
 537                 }
 538             }
 539             else
 540             {
 541                 child = wxGetPreviousButtonInGroup(lastBtn);
 542                 if ( !child )
 543                 {
 544                     // no previous button in group, set it to the last button
 545                     child = wxGetLastButtonInGroup(lastBtn);
 546                 }
 547             }
 548
 549             if ( child == m_winLastFocused )
 550             {
 551                 // must be a group consisting of only one button therefore
 552                 // no need to send a navigation event
 553                 event.Skip(false);
 554                 return;
 555             }
 556         }
 557 #endif // __WXMSW__
 558
 559         if ( child->CanAcceptFocusFromKeyboard() )
 560         {
 561             // if we're setting the focus to a child panel we should prevent it
 562             // from giving it to the child which had the focus the last time
 563             // and instead give it to the first/last child depending from which
 564             // direction we're coming
 565             event.SetEventObject(m_winParent);
 566
 567             // disable propagation for this call as otherwise the event might
 568             // bounce back to us.
 569             wxPropagationDisabler disableProp(event);
 570             if ( !child->GetEventHandler()->ProcessEvent(event) )
 571             {
 572                 // set it first in case SetFocusFromKbd() results in focus
 573                 // change too
 574                 m_winLastFocused = child;
 575
 576                 // everything is simple: just give focus to it
 577                 child->SetFocusFromKbd();
 578             }
 579             //else: the child manages its focus itself
 580
 581             event.Skip( false );
 582
 583             return;
 584         }
 585
 586         node = forward ? node->GetNext() : node->GetPrevious();
 587     }
 588
 589     // we cycled through all of our children and none of them wanted to accept
 590     // focus
 591     event.Skip();
 592 }
 593
 594 void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child)
 595 {
 596     if ( child == m_winLastFocused )
 597         m_winLastFocused = NULL;
 598 }
 599
 600 // ----------------------------------------------------------------------------
 601 // focus handling
 602 // ----------------------------------------------------------------------------
 603
 604 void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
 605 {
 606     wxLogTrace(TRACE_FOCUS, wxT("OnFocus on wxPanel 0x%p, name: %s"),
 607                m_winParent->GetHandle(),
 608                m_winParent->GetName().c_str() );
 609
 610     DoSetFocus();
 611
 612     event.Skip();
 613 }
 614
 615
 616 #else
 617   // wxHAS_NATIVE_TAB_TRAVERSAL
 618
 619 bool wxControlContainer::SetFocusToChild()
 620 {
 621     return wxSetFocusToChild(m_winParent, NULL);
 622 }
 623
 624
 625 #endif // !wxHAS_NATIVE_TAB_TRAVERSAL
 626
 627 // ----------------------------------------------------------------------------
 628 // SetFocusToChild(): this function is used by wxPanel but also by wxFrame in
 629 // wxMSW, this is why it is outside of wxControlContainer class
 630 // ----------------------------------------------------------------------------
 631
 632 bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
 633 {
 634     wxCHECK_MSG( win, false, wxT("wxSetFocusToChild(): invalid window") );
 635     //    wxCHECK_MSG( childLastFocused, false,
 636     //             wxT("wxSetFocusToChild(): NULL child poonter") );
 637
 638     if ( childLastFocused && *childLastFocused )
 639     {
 640         // It might happen that the window got reparented
 641         if ( (*childLastFocused)->GetParent() == win )
 642         {
 643             // And it also could have become hidden in the meanwhile
 644             // We want to focus on the deepest widget visible
 645             wxWindow *deepestVisibleWindow = NULL;
 646
 647             while ( *childLastFocused )
 648             {
 649                 if ( (*childLastFocused)->IsShown() )
 650                 {
 651                     if ( !deepestVisibleWindow )
 652                         deepestVisibleWindow = *childLastFocused;
 653                 }
 654                 else
 655                     deepestVisibleWindow = NULL;
 656
 657                 *childLastFocused = (*childLastFocused)->GetParent();
 658             }
 659
 660             if ( deepestVisibleWindow )
 661             {
 662                 *childLastFocused = deepestVisibleWindow;
 663
 664                 wxLogTrace(TRACE_FOCUS,
 665                            wxT("SetFocusToChild() => last child (0x%p)."),
 666                            (*childLastFocused)->GetHandle());
 667
 668                 // not SetFocusFromKbd(): we're restoring focus back to the old
 669                 // window and not setting it as the result of a kbd action
 670                 (*childLastFocused)->SetFocus();
 671                 return true;
 672             }
 673         }
 674         else
 675         {
 676             // it doesn't count as such any more
 677             *childLastFocused = NULL;
 678         }
 679     }
 680
 681     // set the focus to the first child who wants it
 682     wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
 683     while ( node )
 684     {
 685         wxWindow *child = node->GetData();
 686         node = node->GetNext();
 687
 688         // skip special windows:
 689         if ( !win->IsClientAreaChild(child) )
 690             continue;
 691
 692         if ( child->CanAcceptFocusFromKeyboard() && !child->IsTopLevel() )
 693         {
 694 #if defined(__WXMSW__) && wxUSE_RADIOBTN
 695             // If a radiobutton is the first focusable child, search for the
 696             // selected radiobutton in the same group
 697             wxRadioButton* btn = wxDynamicCast(child, wxRadioButton);
 698             if (btn)
 699             {
 700                 wxRadioButton* selected = wxGetSelectedButtonInGroup(btn);
 701                 if (selected)
 702                     child = selected;
 703             }
 704 #endif // __WXMSW__
 705
 706             wxLogTrace(TRACE_FOCUS,
 707                        wxT("SetFocusToChild() => first child (0x%p)."),
 708                        child->GetHandle());
 709
 710             if (childLastFocused)
 711                 *childLastFocused = child;
 712             child->SetFocusFromKbd();
 713             return true;
 714         }
 715     }
 716
 717     return false;
 718 }
 719