gcn::FocusHandler Class Reference
#include <focushandler.h>
List of all members.
Detailed Description
Used to keep track of widget focus. You will probably not have to use the
FocusHandler directly to handle focus.
Widget has functions for handling focus which uses a
FocusHandler. Use them instead.
- See also:
- Widget::hasFocus
Widget::requestFocus
Widget::setFocusable
Widget::isFocusable
Widget::gotFocus
Widget::lostFocus
Member Typedef Documentation
Constructor & Destructor Documentation
gcn::FocusHandler::FocusHandler |
( |
|
) |
|
virtual gcn::FocusHandler::~FocusHandler |
( |
|
) |
[inline, virtual] |
Member Function Documentation
void gcn::FocusHandler::requestFocus |
( |
Widget * |
widget |
) |
[virtual] |
void gcn::FocusHandler::setFocus |
( |
Widget * |
widget |
) |
[virtual] |
void gcn::FocusHandler::requestDrag |
( |
Widget * |
widget |
) |
[virtual] |
Sets drag to a Widget.
- Parameters:
-
void gcn::FocusHandler::requestModalFocus |
( |
Widget * |
widget |
) |
[virtual] |
Sets modal focus to a Widget. If another Widget already has modal focus will an exception be thrown.
- Parameters:
-
| widget | the Widget to focus modal. |
- Exceptions:
-
| Exception | when another widget already has modal focus. |
void gcn::FocusHandler::releaseModalFocus |
( |
Widget * |
widget |
) |
[virtual] |
Releases modal focus if the Widget has modal focus. Otherwise nothing will be done.
- Parameters:
-
| widget | the Widget to release modal focus for. |
Widget * gcn::FocusHandler::getFocused |
( |
|
) |
const [virtual] |
Gets the Widget with focus.
- Returns:
- the Widget with focus. NULL will be returned if no Widget has focus.
Widget * gcn::FocusHandler::getDragged |
( |
|
) |
const [virtual] |
Gets the widget that is dragged.
- Returns:
- the widget that is dragged. NULL will be returned if no Widget is dragged.
Widget * gcn::FocusHandler::getModalFocused |
( |
|
) |
const [virtual] |
Gets the Widget with modal focus.
- Returns:
- the Widget with modal focus. NULL will be returned if no Widget has modal focus.
void gcn::FocusHandler::focusNext |
( |
|
) |
[virtual] |
Focuses the next Widget. If no Widget has focus the first Widget gets focus. The order in which the Widgets are focused depends on the order you add them to the GUI.
void gcn::FocusHandler::focusPrevious |
( |
|
) |
[virtual] |
Focuses the previous Widget. If no Widget has focus the first Widget gets focus. The order in which the widgets are focused depends on the order you add them to the GUI.
bool gcn::FocusHandler::hasFocus |
( |
const Widget * |
widget |
) |
const [virtual] |
Checks if a Widget has focus.
- Parameters:
-
| widget | widget to check if it has focus.. |
- Returns:
- true if the widget has focus.
bool gcn::FocusHandler::isDragged |
( |
const Widget * |
widget |
) |
const [virtual] |
Checks if a widget is being dragged
- Parameters:
-
| widget | the Widget to check if it is being dragged. |
- Returns:
- true if the widget is being dragged.
void gcn::FocusHandler::add |
( |
Widget * |
widget |
) |
[virtual] |
Adds a widget to the FocusHandler.
- Parameters:
-
| widget | the widget to add. |
void gcn::FocusHandler::remove |
( |
Widget * |
widget |
) |
[virtual] |
Removes a widget from the FocusHandler.
- Parameters:
-
| widget | the widget to remove. |
void gcn::FocusHandler::focusNone |
( |
|
) |
[virtual] |
void gcn::FocusHandler::tabNext |
( |
|
) |
[virtual] |
Focuses the next Widget which allows tab in unless current focused Widget disallows tab out.
void gcn::FocusHandler::tabPrevious |
( |
|
) |
[virtual] |
Focuses the previous Widget which allows tab in unless current focused Widget disallows tab out.
void gcn::FocusHandler::applyChanges |
( |
|
) |
[virtual] |
void gcn::FocusHandler::dragNone |
( |
|
) |
[virtual] |
void gcn::FocusHandler::checkHotKey |
( |
const KeyInput & |
keyInput |
) |
[virtual] |
Check if a hot key was pressed.
Member Data Documentation
The documentation for this class was generated from the following files: