Second Life viewer sources 1.13.2.12

1 files changed, 121 insertions, 0 deletions

diff --git a/linden/indra/llui/llfocusmgr.h b/linden/indra/llui/llfocusmgr.h
new file mode 100644
index 0000000..5687b99
--- /dev/null
+++ b/linden/indra/llui/llfocusmgr.h
@@ -0,0 +1,121 @@
+/** 
+ * @file llfocusmgr.h
+ * @brief LLFocusMgr base class
+ *
+ * Copyright (c) 2002-2007, Linden Research, Inc.
+ * 
+ * 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.
+ */
+
+// 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,void (*on_capture_lost)(LLMouseHandler* old_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                    setTopView(LLView* new_top, void (*on_top_lost)(LLView* old_top));
+        LLView*                 getTopView() const                                      { return mTopView; }
+        void                    removeTopViewWithoutCallback( LLView* top_view );
+        BOOL                    childIsTopView( LLView* parent );
+
+        // All Three
+        void                    releaseFocusIfNeeded( LLView* top_view );
+        void                    unlockFocus();
+        BOOL                    focusLocked() { return mLockedView != NULL; }
+
+protected:
+        LLUICtrl*                       mLockedView;
+        FocusLostCallback mKeyboardLockedFocusLostCallback;
+
+        // Mouse Captor
+        LLMouseHandler*         mMouseCaptor;                           // Mouse events are premptively routed to this object
+        void                            (*mMouseCaptureLostCallback)(LLMouseHandler*);  // The object to which mouse events are routed is called before another object takes its place
+
+        // 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
+        LLView*                         mTopView;
+        void                            (*mTopViewLostCallback)(LLView*);
+
+        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                mTopViewName;
+        #endif
+};
+
+extern LLFocusMgr gFocusMgr;
+
+#endif  // LL_LLFOCUSMGR_H
+