diff options
Diffstat (limited to 'src/kernel/qfocusdata.cpp')
-rw-r--r-- | src/kernel/qfocusdata.cpp | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/src/kernel/qfocusdata.cpp b/src/kernel/qfocusdata.cpp new file mode 100644 index 000000000..6c5c02880 --- /dev/null +++ b/src/kernel/qfocusdata.cpp @@ -0,0 +1,141 @@ +/**************************************************************************** +** +** Implementation of TQFocusData class +** +** Created : 980622 +** +** Copyright (C) 1992-2008 Trolltech ASA. All rights reserved. +** +** This file is part of the kernel module of the TQt GUI Toolkit. +** +** This file may be used under the terms of the GNU General +** Public License versions 2.0 or 3.0 as published by the Free +** Software Foundation and appearing in the files LICENSE.GPL2 +** and LICENSE.GPL3 included in the packaging of this file. +** Alternatively you may (at your option) use any later version +** of the GNU General Public License if such license has been +** publicly approved by Trolltech ASA (or its successors, if any) +** and the KDE Free TQt Foundation. +** +** Please review the following information to ensure GNU General +** Public Licensing retquirements will be met: +** http://trolltech.com/products/qt/licenses/licensing/opensource/. +** If you are unsure which license is appropriate for your use, please +** review the following information: +** http://trolltech.com/products/qt/licenses/licensing/licensingoverview +** or contact the sales department at sales@trolltech.com. +** +** This file may be used under the terms of the Q Public License as +** defined by Trolltech ASA and appearing in the file LICENSE.TQPL +** included in the packaging of this file. Licensees holding valid TQt +** Commercial licenses may use this file in accordance with the TQt +** Commercial License Agreement provided with the Software. +** +** This file is provided "AS IS" with NO WARRANTY OF ANY KIND, +** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted +** herein. +** +**********************************************************************/ + +#include "qfocusdata.h" + +/*! + \class TQFocusData qfocusdata.h + \brief The TQFocusData class maintains the list of widgets in the focus + chain. + + \ingroup misc + + This read-only list always contains at least one widget (i.e. the + top-level widget). It provides a simple cursor which can be reset + to the current focus widget using home(), or moved to its + neighboring widgets using next() and prev(). You can also retrieve + the count() of the number of widgets in the list. The list is a + loop, so if you keep iterating, for example using next(), you will + never come to the end. + + Some widgets in the list may not accept focus. Widgets are added + to the list as necessary, but not removed from it. This lets + widgets change focus policy dynamically without disrupting the + focus chain the user experiences. When a widget disables and + re-enables tab focus, its position in the focus chain does not + change. + + When reimplementing TQWidget::focusNextPrevChild() to provide + special focus flow, you will usually call TQWidget::focusData() to + retrieve the focus data stored at the top-level widget. A + top-level widget's focus data contains the focus list for its + hierarchy of widgets. + + The cursor may change at any time. + + This class is \e not thread-safe. + + \sa TQWidget::focusNextPrevChild() TQWidget::setTabOrder() + TQWidget::setFocusPolicy() +*/ + +/*! + \fn TQWidget* TQFocusData::focusWidget() const + + Returns the widgets in the hierarchy that are in the focus chain. +*/ + +/*! + \fn int TQFocusData::count() const + + Returns the number of widgets in the focus chain. +*/ + +/*! + Moves the cursor to the focusWidget() and returns that widget. You + must call this before next() or prev() to iterate meaningfully. +*/ +TQWidget* TQFocusData::home() +{ + focusWidgets.find(it.current()); + return focusWidgets.current(); +} + +/*! + Moves the cursor to the next widget in the focus chain. There is + \e always a next widget because the list is a loop. +*/ +TQWidget* TQFocusData::next() +{ + TQWidget* r = focusWidgets.next(); + if ( !r ) + r = focusWidgets.first(); + return r; +} + +/*! + Moves the cursor to the previous widget in the focus chain. There + is \e always a previous widget because the list is a loop. +*/ +TQWidget* TQFocusData::prev() +{ + TQWidget* r = focusWidgets.prev(); + if ( !r ) + r = focusWidgets.last(); + return r; +} + +/*! + Returns the last widget in the focus chain. + The cursor is not modified. +*/ +TQWidget *TQFocusData::last() const +{ + return focusWidgets.getLast(); +} + +/*! + Returns the first widget in the focus chain. + The cursor is not modified. +*/ +TQWidget *TQFocusData::first() const +{ + return focusWidgets.getFirst(); +} |