1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/**
* @file llfocusmgr.h
* @brief LLFocusMgr base class
*
* $LicenseInfo:firstyear=2002&license=viewergpl$
*
* Copyright (c) 2002-2007, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlife.com/developers/opensource/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlife.com/developers/opensource/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
* $/LicenseInfo$
*/
// Singleton that manages keyboard and mouse focus
#ifndef LL_LLFOCUSMGR_H
#define LL_LLFOCUSMGR_H
#include "llstring.h"
#include "llframetimer.h"
#include "llview.h"
class LLUICtrl;
class LLMouseHandler;
class LLFocusMgr
{
public:
typedef void (*FocusLostCallback)(LLUICtrl*);
LLFocusMgr();
~LLFocusMgr();
// Mouse Captor
void setMouseCapture(LLMouseHandler* new_captor); // new_captor = NULL to release the mouse.
LLMouseHandler* getMouseCapture() { return mMouseCaptor; }
void removeMouseCaptureWithoutCallback( LLMouseHandler* captor );
BOOL childHasMouseCapture( LLView* parent );
// Keyboard Focus
void setKeyboardFocus(LLUICtrl* new_focus, FocusLostCallback on_focus_lost, BOOL lock = FALSE); // new_focus = NULL to release the focus.
LLUICtrl* getKeyboardFocus() const { return mKeyboardFocus; }
BOOL childHasKeyboardFocus( const LLView* parent ) const;
void removeKeyboardFocusWithoutCallback( LLView* focus );
FocusLostCallback getFocusCallback() { return mKeyboardFocusLostCallback; }
F32 getFocusTime() const { return mFocusTimer.getElapsedTimeF32(); }
F32 getFocusFlashAmt();
LLColor4 getFocusColor();
void triggerFocusFlash();
BOOL getAppHasFocus() { return mAppHasFocus; }
void setAppHasFocus(BOOL focus);
LLUICtrl* getLastFocusForGroup(LLView* subtree_root);
void clearLastFocusForGroup(LLView* subtree_root);
// If setKeyboardFocus(NULL) is called, and there is a non-NULL default
// keyboard focus view, focus goes there. JC
void setDefaultKeyboardFocus(LLUICtrl* default_focus);
LLUICtrl* getDefaultKeyboardFocus() const { return mDefaultKeyboardFocus; }
// Top View
void setTopCtrl(LLUICtrl* new_top);
LLUICtrl* getTopCtrl() const { return mTopCtrl; }
void removeTopCtrlWithoutCallback( LLUICtrl* top_view );
BOOL childIsTopCtrl( LLView* parent );
// All Three
void releaseFocusIfNeeded( LLView* top_view );
void lockFocus();
void unlockFocus();
BOOL focusLocked() { return mLockedView != NULL; }
protected:
LLUICtrl* mLockedView;
FocusLostCallback mKeyboardLockedFocusLostCallback;
// Mouse Captor
LLMouseHandler* mMouseCaptor; // Mouse events are premptively routed to this object
// Keyboard Focus
LLUICtrl* mKeyboardFocus; // Keyboard events are preemptively routed to this object
LLUICtrl* mDefaultKeyboardFocus;
FocusLostCallback mKeyboardFocusLostCallback; // The object to which keyboard events are routed is called before another object takes its place
// Top View
LLUICtrl* mTopCtrl;
LLFrameTimer mFocusTimer;
F32 mFocusWeight;
BOOL mAppHasFocus;
typedef std::map<LLViewHandle, LLViewHandle> focus_history_map_t;
focus_history_map_t mFocusHistory;
#ifdef _DEBUG
LLString mMouseCaptorName;
LLString mKeyboardFocusName;
LLString mTopCtrlName;
#endif
};
extern LLFocusMgr gFocusMgr;
#endif // LL_LLFOCUSMGR_H
|
