1 // Copyright (c) 2017 Samsung Electronics Co., Ltd.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
16 // This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
17 // Some have been manually changed
24 using System.Runtime.InteropServices;
25 using Tizen.NUI.BaseComponents;
28 /// Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain.<br>
29 /// It provides functionality of setting the focus and moving the focus in four directions(i.e.Left, Right, Up and Down).<br>
30 /// It also draws a highlight for the focused View and sends a event when the focus is changed.<br>
32 public class FocusManager : BaseHandle
34 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
35 private CustomAlgorithmInterfaceWrapper _customAlgorithmInterfaceWrapper;
37 internal FocusManager(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicManualPINVOKE.FocusManager_SWIGUpcast(cPtr), cMemoryOwn)
39 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
42 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(FocusManager obj)
44 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
48 /// To make FocusManager instance be disposed.
50 protected override void Dispose(DisposeTypes type)
57 if(type == DisposeTypes.Explicit)
60 //Release your own managed resources here.
61 //You should release all of your own disposable objects here.
64 //Release your own unmanaged resources here.
65 //You should not access any managed member here except static instance.
66 //because the execution order of Finalizes is non-deterministic.
68 if (swigCPtr.Handle != global::System.IntPtr.Zero)
73 NDalicManualPINVOKE.delete_FocusManager(swigCPtr);
75 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
83 ///Event arguments that passed via PreFocusChange signal
85 public class PreFocusChangeEventArgs : EventArgs
87 private View _current;
88 private View _proposed;
89 private View.FocusDirection _direction;
91 public View CurrentView
103 public View ProposedView
115 public View.FocusDirection Direction
128 private EventHandlerWithReturnType<object, PreFocusChangeEventArgs, View> _preFocusChangeEventHandler;
129 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
130 internal delegate IntPtr PreFocusChangeEventCallback(IntPtr current, IntPtr proposed, View.FocusDirection direction);
131 private PreFocusChangeEventCallback _preFocusChangeCallback;
134 /// PreFocusChange will be triggered before the focus is going to be changed.<br>
135 /// FocusManager makes the best guess for which view to focus towards the given direction, but applications might want to change that.<br>
136 /// By connecting with this event, they can check the proposed view to focus and return a different view if they wish.<br>
137 /// This event is only triggered when the navigation key is pressed and KeyboardFocusManager tries to move the focus automatically.<br>
138 /// It won't be emitted for focus movement by calling SetCurrentFocusView directly.<br>
140 public event EventHandlerWithReturnType<object, PreFocusChangeEventArgs, View> PreFocusChange
144 if (_preFocusChangeEventHandler == null)
147 Tizen.Log.Debug("NUI", "con1) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
148 Tizen.Log.Debug("NUI", "con2) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
150 _preFocusChangeCallback = OnPreFocusChange;
151 PreFocusChangeSignal().Connect(_preFocusChangeCallback);
153 Tizen.Log.Debug("NUI", "con3) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
154 Tizen.Log.Debug("NUI", "con4) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
157 _preFocusChangeEventHandler += value;
161 _preFocusChangeEventHandler -= value;
162 if (_preFocusChangeEventHandler == null && PreFocusChangeSignal().Empty() == false)
165 Tizen.Log.Debug("NUI", "discon1) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
166 Tizen.Log.Debug("NUI", "discon2) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
168 PreFocusChangeSignal().Disconnect(_preFocusChangeCallback);
170 Tizen.Log.Debug("NUI", "discon3) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
171 Tizen.Log.Debug("NUI", "discon4) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
177 private IntPtr OnPreFocusChange(IntPtr current, IntPtr proposed, View.FocusDirection direction)
180 PreFocusChangeEventArgs e = new PreFocusChangeEventArgs();
182 if (current != global::System.IntPtr.Zero)
184 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
186 if (proposed != global::System.IntPtr.Zero)
188 e.ProposedView = Registry.GetManagedBaseHandleFromNativePtr(proposed) as View;
190 e.Direction = direction;
192 if (_preFocusChangeEventHandler != null)
194 view = _preFocusChangeEventHandler(this, e);
199 return view.GetPtrfromView();
203 //if (e.ProposedView) return proposed;
204 //else return current;
205 return current; //xb.teng
210 ///Event arguments that passed via FocusChanged signal.
212 public class FocusChangedEventArgs : EventArgs
214 private View _current;
217 public View CurrentView
242 private EventHandler<FocusChangedEventArgs> _focusChangedEventHandler;
243 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
244 internal delegate void FocusChangedEventCallback(IntPtr current, IntPtr next);
245 private FocusChangedEventCallback _focusChangedEventCallback;
248 /// FocusGroupChanged will be triggered after the current focused view has been changed.
250 public event EventHandler<FocusChangedEventArgs> FocusChanged
254 if (_focusChangedEventCallback == null)
256 _focusChangedEventCallback = OnFocusChanged;
257 FocusChangedSignal().Connect(_focusChangedEventCallback);
259 _focusChangedEventHandler += value;
263 _focusChangedEventHandler -= value;
265 if (_focusChangedEventCallback == null && FocusChangedSignal().Empty() == false)
267 FocusChangedSignal().Disconnect(_focusChangedEventCallback);
272 private void OnFocusChanged(IntPtr current, IntPtr next)
274 FocusChangedEventArgs e = new FocusChangedEventArgs();
276 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
277 e.NextView = Registry.GetManagedBaseHandleFromNativePtr(next) as View;
279 if (_focusChangedEventHandler != null)
281 _focusChangedEventHandler(this, e);
286 ///Event arguments that passed via FocusGroupChanged signal.
288 public class FocusGroupChangedEventArgs : EventArgs
290 private View _current;
291 private bool _forwardDirection;
293 public View CurrentView
305 public bool ForwardDirection
309 return _forwardDirection;
313 _forwardDirection = value;
318 private EventHandler<FocusGroupChangedEventArgs> _focusGroupChangedEventHandler;
319 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
320 private delegate void FocusGroupChangedEventCallback(IntPtr current, bool forwardDirection);
321 private FocusGroupChangedEventCallback _focusGroupChangedEventCallback;
324 /// FocusGroupChanged will be triggered when the focus group has been changed.<br>
325 /// If the current focus group has a parent layout control, FocusManager will make the best guess for the next focus group to move the focus to in the given direction (forward or backward).<br>
326 /// If not, the application has to set the new focus.<br>
328 public event EventHandler<FocusGroupChangedEventArgs> FocusGroupChanged
332 if (_focusGroupChangedEventCallback == null)
334 _focusGroupChangedEventCallback = OnFocusGroupChanged;
335 FocusGroupChangedSignal().Connect(_focusGroupChangedEventCallback);
337 _focusGroupChangedEventHandler += value;
341 _focusGroupChangedEventHandler -= value;
343 if (_focusGroupChangedEventCallback == null && FocusGroupChangedSignal().Empty() == false)
345 FocusGroupChangedSignal().Disconnect(_focusGroupChangedEventCallback);
350 private void OnFocusGroupChanged(IntPtr current, bool forwardDirection)
352 FocusGroupChangedEventArgs e = new FocusGroupChangedEventArgs();
354 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
355 e.ForwardDirection = forwardDirection;
357 if (_focusGroupChangedEventHandler != null)
359 _focusGroupChangedEventHandler(this, e);
364 ///Event arguments that passed via FocusedViewEnterKey signal
366 public class FocusedViewActivatedEventArgs : EventArgs
383 private EventHandler<FocusedViewActivatedEventArgs> _focusedViewEnterKeyEventHandler;
384 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
385 private delegate void FocusedViewEnterKeyEventCallback(IntPtr view);
386 private FocusedViewEnterKeyEventCallback _focusedViewEnterKeyEventCallback;
389 /// FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it.
391 public event EventHandler<FocusedViewActivatedEventArgs> FocusedViewActivated
395 if (_focusedViewEnterKeyEventCallback == null)
397 _focusedViewEnterKeyEventCallback = OnFocusedViewEnterKey;
398 FocusedViewEnterKeySignal().Connect(_focusedViewEnterKeyEventCallback);
400 _focusedViewEnterKeyEventHandler += value;
404 _focusedViewEnterKeyEventHandler -= value;
406 if (_focusedViewEnterKeyEventCallback == null && FocusedViewEnterKeySignal().Empty() == false)
408 FocusedViewEnterKeySignal().Disconnect(_focusedViewEnterKeyEventCallback);
413 private void OnFocusedViewEnterKey(IntPtr view)
415 FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
417 e.View = Registry.GetManagedBaseHandleFromNativePtr(view) as View;
419 if (_focusedViewEnterKeyEventHandler != null)
421 _focusedViewEnterKeyEventHandler(this, e);
426 internal FocusManager() : this(NDalicManualPINVOKE.new_FocusManager(), true)
428 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
431 internal static FocusManager Get()
433 FocusManager ret = new FocusManager(NDalicManualPINVOKE.FocusManager_Get(), true);
434 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
439 /// Moves the keyboard focus to the given View.<br>
440 /// Only one View can be focused at the same time.<br>
441 /// The View must be in the stage already and keyboard focusable.<br>
443 /// <param name="view">The View to be focused</param>
444 /// <returns>Whether the focus is successful or not</returns>
445 public bool SetCurrentFocusView(View view)
447 bool ret = NDalicManualPINVOKE.FocusManager_SetCurrentFocusActor(swigCPtr, View.getCPtr(view));
448 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
453 /// Gets the current focused view.
455 /// <returns>A handle to the current focused View or an empty handle if no View is focused</returns>
456 public View GetCurrentFocusView()
458 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetCurrentFocusActor(swigCPtr);
460 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
465 /// Moves the focus to the next focusable View in the focus chain in the given direction(according to the focus traversal order).
467 /// <param name="direction">The direction of focus movement</param>
468 /// <returns>true if the movement was successful</returns>
469 public bool MoveFocus(View.FocusDirection direction)
471 bool ret = NDalicManualPINVOKE.FocusManager_MoveFocus(swigCPtr, (int)direction);
472 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
477 /// Clears the focus from the current focused view if any, so that no view is focused in the focus chain.<br>
478 /// It will emit FocusChanged event without current focused View.<br>
480 public void ClearFocus()
482 NDalicManualPINVOKE.FocusManager_ClearFocus(swigCPtr);
483 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
487 /// Move the focus to prev focused view.
489 public void MoveFocusBackward()
491 NDalicManualPINVOKE.FocusManager_MoveFocusBackward(swigCPtr);
492 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
496 /// Sets/Gets the status of whether the focus movement should be looped within the same focus group.<br>
497 /// The focus movement is not looped by default.<br>
499 public bool FocusGroupLoop
503 SetFocusGroupLoop(value);
507 return GetFocusGroupLoop();
511 internal void SetFocusGroupLoop(bool enabled)
513 NDalicManualPINVOKE.FocusManager_SetFocusGroupLoop(swigCPtr, enabled);
514 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
517 internal bool GetFocusGroupLoop()
519 bool ret = NDalicManualPINVOKE.FocusManager_GetFocusGroupLoop(swigCPtr);
520 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
525 /// Sets whether an View is a focus group that can limit the scope of focus movement to its child views in the focus chain.<br>
526 /// Layout controls set themselves as focus groups by default.<br>
528 /// <param name="view">The View to be set as a focus group</param>
529 /// <param name="isFocusGroup">Whether to set the View as a focus group or not</param>
530 public void SetAsFocusGroup(View view, bool isFocusGroup)
532 NDalicManualPINVOKE.FocusManager_SetAsFocusGroup(swigCPtr, View.getCPtr(view), isFocusGroup);
533 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
537 /// Checks whether the view is set as a focus group or not.
539 /// <param name="view">The View to be checked</param>
540 /// <returns>Whether the View is set as a focus group</returns>
541 public bool IsFocusGroup(View view)
543 bool ret = NDalicManualPINVOKE.FocusManager_IsFocusGroup(swigCPtr, View.getCPtr(view));
544 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
549 /// Returns the closest ancestor of the given view that is a focus group.
551 /// <param name="view">The View to be checked for its focus group</param>
552 /// <returns>The focus group the given view belongs to or an empty handle if the given view</returns>
553 public View GetFocusGroup(View view)
555 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetFocusGroup(swigCPtr, View.getCPtr(view));
557 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
560 /*View ret = new View(NDalicManualPINVOKE.FocusManager_GetFocusGroup(swigCPtr, View.getCPtr(view)), true);
561 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
562 if (ret.HasBody() == false)
571 /// Sets/Gets the focus indicator View.<br>
572 /// This will replace the default focus indicator view in FocusManager and will be added to the focused view as a highlight.<br>
574 public View FocusIndicator
578 SetFocusIndicatorView(value);
582 return GetFocusIndicatorView();
586 internal void SetFocusIndicatorView(View indicator)
588 NDalicManualPINVOKE.FocusManager_SetFocusIndicatorActor(swigCPtr, View.getCPtr(indicator));
589 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
592 internal View GetFocusIndicatorView()
594 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetFocusIndicatorActor(swigCPtr);
596 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
602 /// Provide the implementation of custom Focus algorithm interface to allow the app define the focus logic.<br>
604 /// <param name="arg0">The user's implementation of ICustomFocusAlgorithm</param>
605 public void SetCustomAlgorithm(ICustomFocusAlgorithm arg0)
607 _customAlgorithmInterfaceWrapper = new CustomAlgorithmInterfaceWrapper();
608 _customAlgorithmInterfaceWrapper.SetFocusAlgorithm(arg0);
610 NDalicPINVOKE.SetCustomAlgorithm(swigCPtr, CustomAlgorithmInterface.getCPtr(_customAlgorithmInterfaceWrapper));
611 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
614 internal PreFocusChangeSignal PreFocusChangeSignal()
616 PreFocusChangeSignal ret = new PreFocusChangeSignal(NDalicManualPINVOKE.FocusManager_PreFocusChangeSignal(swigCPtr), false);
617 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
621 internal FocusChangedSignal FocusChangedSignal()
623 FocusChangedSignal ret = new FocusChangedSignal(NDalicManualPINVOKE.FocusManager_FocusChangedSignal(swigCPtr), false);
624 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
628 internal FocusGroupChangedSignal FocusGroupChangedSignal()
630 FocusGroupChangedSignal ret = new FocusGroupChangedSignal(NDalicManualPINVOKE.FocusManager_FocusGroupChangedSignal(swigCPtr), false);
631 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
635 internal ViewSignal FocusedViewEnterKeySignal()
637 ViewSignal ret = new ViewSignal(NDalicManualPINVOKE.FocusManager_FocusedActorEnterKeySignal(swigCPtr), false);
638 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
642 private static readonly FocusManager instance = FocusManager.Get();
645 /// Gets the singleton of FocusManager object.
647 public static FocusManager Instance
656 /// ICustomFocusAlgorithm is used to provide custom keyboard focus algorithm for retrieving the next focusable view.<br>
657 /// The application can implement the interface and override the keyboard focus behaviour.<br>
658 /// If focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.<br>
659 /// If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine next focusable actor.<br>
660 /// If focusable properties are not set, then the Keyboard FocusManager calls the GetNextFocusableView() method of this interface.<br>
662 public interface ICustomFocusAlgorithm
664 View GetNextFocusableView(View current, View proposed, View.FocusDirection direction);
667 private class CustomAlgorithmInterfaceWrapper : CustomAlgorithmInterface
669 private FocusManager.ICustomFocusAlgorithm _customFocusAlgorithm;
671 public CustomAlgorithmInterfaceWrapper()
675 public void SetFocusAlgorithm(FocusManager.ICustomFocusAlgorithm customFocusAlgorithm)
677 _customFocusAlgorithm = customFocusAlgorithm;
680 public override View GetNextFocusableView(View current, View proposed, View.FocusDirection direction)
682 return _customFocusAlgorithm.GetNextFocusableView(current, proposed, direction);
688 [Obsolete("Please do not use! this will be deprecated")]
689 public class FocusedViewEnterKeyEventArgs : EventArgs
706 private EventHandler<FocusedViewEnterKeyEventArgs> _focusedViewEnterKeyEventHandler2;
707 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
708 private delegate void FocusedViewEnterKeyEventCallback2(IntPtr view);
709 private FocusedViewEnterKeyEventCallback2 _focusedViewEnterKeyEventCallback2;
711 [Obsolete("Please do not use! this will be deprecated")]
712 public event EventHandler<FocusedViewEnterKeyEventArgs> FocusedViewEnterKeyPressed
716 if (_focusedViewEnterKeyEventCallback2 == null)
718 _focusedViewEnterKeyEventCallback2 = OnFocusedViewEnterKey2;
719 FocusedViewEnterKeySignal().Connect(_focusedViewEnterKeyEventCallback2);
721 _focusedViewEnterKeyEventHandler2 += value;
725 _focusedViewEnterKeyEventHandler2 -= value;
727 if (_focusedViewEnterKeyEventCallback2 == null && FocusedViewEnterKeySignal().Empty() == false)
729 FocusedViewEnterKeySignal().Disconnect(_focusedViewEnterKeyEventCallback2);
734 [Obsolete("Please do not use! this will be deprecated")]
735 private void OnFocusedViewEnterKey2(IntPtr view)
737 FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
739 e.View = Registry.GetManagedBaseHandleFromNativePtr(view) as View;
741 if (_focusedViewEnterKeyEventHandler != null)
743 _focusedViewEnterKeyEventHandler(this, e);