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)
74 //Unreference this instance from Registry.
75 Registry.Unregister(this);
77 NDalicManualPINVOKE.delete_FocusManager(swigCPtr);
79 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
87 ///Event arguments that passed via PreFocusChange signal
89 public class PreFocusChangeEventArgs : EventArgs
91 private View _current;
92 private View _proposed;
93 private View.FocusDirection _direction;
95 public View CurrentView
107 public View ProposedView
119 public View.FocusDirection Direction
132 private EventHandlerWithReturnType<object, PreFocusChangeEventArgs, View> _preFocusChangeEventHandler;
133 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
134 internal delegate IntPtr PreFocusChangeEventCallback(IntPtr current, IntPtr proposed, View.FocusDirection direction);
135 private PreFocusChangeEventCallback _preFocusChangeCallback;
138 /// PreFocusChange will be triggered before the focus is going to be changed.<br>
139 /// FocusManager makes the best guess for which view to focus towards the given direction, but applications might want to change that.<br>
140 /// By connecting with this event, they can check the proposed view to focus and return a different view if they wish.<br>
141 /// This event is only triggered when the navigation key is pressed and KeyboardFocusManager tries to move the focus automatically.<br>
142 /// It won't be emitted for focus movement by calling SetCurrentFocusView directly.<br>
144 public event EventHandlerWithReturnType<object, PreFocusChangeEventArgs, View> PreFocusChange
148 if (_preFocusChangeEventHandler == null)
151 Tizen.Log.Debug("NUI", "con1) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
152 Tizen.Log.Debug("NUI", "con2) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
154 _preFocusChangeCallback = OnPreFocusChange;
155 PreFocusChangeSignal().Connect(_preFocusChangeCallback);
157 Tizen.Log.Debug("NUI", "con3) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
158 Tizen.Log.Debug("NUI", "con4) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
161 _preFocusChangeEventHandler += value;
165 _preFocusChangeEventHandler -= value;
166 if (_preFocusChangeEventHandler == null && PreFocusChangeSignal().Empty() == false)
169 Tizen.Log.Debug("NUI", "discon1) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
170 Tizen.Log.Debug("NUI", "discon2) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
172 PreFocusChangeSignal().Disconnect(_preFocusChangeCallback);
174 Tizen.Log.Debug("NUI", "discon3) PreFocusChangeSignal().Empty = " + PreFocusChangeSignal().Empty());
175 Tizen.Log.Debug("NUI", "discon4) PreFocusChangeSignal().GetConnectionCount = " + PreFocusChangeSignal().GetConnectionCount());
181 private IntPtr OnPreFocusChange(IntPtr current, IntPtr proposed, View.FocusDirection direction)
184 PreFocusChangeEventArgs e = new PreFocusChangeEventArgs();
186 if (current != global::System.IntPtr.Zero)
188 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
190 if (proposed != global::System.IntPtr.Zero)
192 e.ProposedView = Registry.GetManagedBaseHandleFromNativePtr(proposed) as View;
194 e.Direction = direction;
196 if (_preFocusChangeEventHandler != null)
198 view = _preFocusChangeEventHandler(this, e);
203 return view.GetPtrfromView();
207 //if (e.ProposedView) return proposed;
208 //else return current;
209 return current; //xb.teng
214 ///Event arguments that passed via FocusChanged signal.
216 public class FocusChangedEventArgs : EventArgs
218 private View _current;
221 public View CurrentView
246 private EventHandler<FocusChangedEventArgs> _focusChangedEventHandler;
247 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
248 internal delegate void FocusChangedEventCallback(IntPtr current, IntPtr next);
249 private FocusChangedEventCallback _focusChangedEventCallback;
252 /// FocusGroupChanged will be triggered after the current focused view has been changed.
254 public event EventHandler<FocusChangedEventArgs> FocusChanged
258 if (_focusChangedEventCallback == null)
260 _focusChangedEventCallback = OnFocusChanged;
261 FocusChangedSignal().Connect(_focusChangedEventCallback);
263 _focusChangedEventHandler += value;
267 _focusChangedEventHandler -= value;
269 if (_focusChangedEventCallback == null && FocusChangedSignal().Empty() == false)
271 FocusChangedSignal().Disconnect(_focusChangedEventCallback);
276 private void OnFocusChanged(IntPtr current, IntPtr next)
278 FocusChangedEventArgs e = new FocusChangedEventArgs();
280 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
281 e.NextView = Registry.GetManagedBaseHandleFromNativePtr(next) as View;
283 if (_focusChangedEventHandler != null)
285 _focusChangedEventHandler(this, e);
290 ///Event arguments that passed via FocusGroupChanged signal.
292 public class FocusGroupChangedEventArgs : EventArgs
294 private View _current;
295 private bool _forwardDirection;
297 public View CurrentView
309 public bool ForwardDirection
313 return _forwardDirection;
317 _forwardDirection = value;
322 private EventHandler<FocusGroupChangedEventArgs> _focusGroupChangedEventHandler;
323 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
324 private delegate void FocusGroupChangedEventCallback(IntPtr current, bool forwardDirection);
325 private FocusGroupChangedEventCallback _focusGroupChangedEventCallback;
328 /// FocusGroupChanged will be triggered when the focus group has been changed.<br>
329 /// 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>
330 /// If not, the application has to set the new focus.<br>
332 public event EventHandler<FocusGroupChangedEventArgs> FocusGroupChanged
336 if (_focusGroupChangedEventCallback == null)
338 _focusGroupChangedEventCallback = OnFocusGroupChanged;
339 FocusGroupChangedSignal().Connect(_focusGroupChangedEventCallback);
341 _focusGroupChangedEventHandler += value;
345 _focusGroupChangedEventHandler -= value;
347 if (_focusGroupChangedEventCallback == null && FocusGroupChangedSignal().Empty() == false)
349 FocusGroupChangedSignal().Disconnect(_focusGroupChangedEventCallback);
354 private void OnFocusGroupChanged(IntPtr current, bool forwardDirection)
356 FocusGroupChangedEventArgs e = new FocusGroupChangedEventArgs();
358 e.CurrentView = Registry.GetManagedBaseHandleFromNativePtr(current) as View;
359 e.ForwardDirection = forwardDirection;
361 if (_focusGroupChangedEventHandler != null)
363 _focusGroupChangedEventHandler(this, e);
368 ///Event arguments that passed via FocusedViewEnterKey signal
370 public class FocusedViewActivatedEventArgs : EventArgs
387 private EventHandler<FocusedViewActivatedEventArgs> _focusedViewEnterKeyEventHandler;
388 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
389 private delegate void FocusedViewEnterKeyEventCallback(IntPtr view);
390 private FocusedViewEnterKeyEventCallback _focusedViewEnterKeyEventCallback;
393 /// FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it.
395 public event EventHandler<FocusedViewActivatedEventArgs> FocusedViewActivated
399 if (_focusedViewEnterKeyEventCallback == null)
401 _focusedViewEnterKeyEventCallback = OnFocusedViewEnterKey;
402 FocusedViewEnterKeySignal().Connect(_focusedViewEnterKeyEventCallback);
404 _focusedViewEnterKeyEventHandler += value;
408 _focusedViewEnterKeyEventHandler -= value;
410 if (_focusedViewEnterKeyEventCallback == null && FocusedViewEnterKeySignal().Empty() == false)
412 FocusedViewEnterKeySignal().Disconnect(_focusedViewEnterKeyEventCallback);
417 private void OnFocusedViewEnterKey(IntPtr view)
419 FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
421 e.View = Registry.GetManagedBaseHandleFromNativePtr(view) as View;
423 if (_focusedViewEnterKeyEventHandler != null)
425 _focusedViewEnterKeyEventHandler(this, e);
430 internal FocusManager() : this(NDalicManualPINVOKE.new_FocusManager(), true)
432 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
435 internal static FocusManager Get()
437 FocusManager ret = new FocusManager(NDalicManualPINVOKE.FocusManager_Get(), true);
438 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
443 /// Moves the keyboard focus to the given View.<br>
444 /// Only one View can be focused at the same time.<br>
445 /// The View must be in the stage already and keyboard focusable.<br>
447 /// <param name="view">The View to be focused</param>
448 /// <returns>Whether the focus is successful or not</returns>
449 public bool SetCurrentFocusView(View view)
451 bool ret = NDalicManualPINVOKE.FocusManager_SetCurrentFocusActor(swigCPtr, View.getCPtr(view));
452 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
457 /// Gets the current focused view.
459 /// <returns>A handle to the current focused View or an empty handle if no View is focused</returns>
460 public View GetCurrentFocusView()
462 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetCurrentFocusActor(swigCPtr);
464 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
469 /// Moves the focus to the next focusable View in the focus chain in the given direction(according to the focus traversal order).
471 /// <param name="direction">The direction of focus movement</param>
472 /// <returns>true if the movement was successful</returns>
473 public bool MoveFocus(View.FocusDirection direction)
475 bool ret = NDalicManualPINVOKE.FocusManager_MoveFocus(swigCPtr, (int)direction);
476 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
481 /// Clears the focus from the current focused view if any, so that no view is focused in the focus chain.<br>
482 /// It will emit FocusChanged event without current focused View.<br>
484 public void ClearFocus()
486 NDalicManualPINVOKE.FocusManager_ClearFocus(swigCPtr);
487 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
491 /// Move the focus to prev focused view.
493 public void MoveFocusBackward()
495 NDalicManualPINVOKE.FocusManager_MoveFocusBackward(swigCPtr);
496 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
500 /// Sets/Gets the status of whether the focus movement should be looped within the same focus group.<br>
501 /// The focus movement is not looped by default.<br>
503 public bool FocusGroupLoop
507 SetFocusGroupLoop(value);
511 return GetFocusGroupLoop();
515 internal void SetFocusGroupLoop(bool enabled)
517 NDalicManualPINVOKE.FocusManager_SetFocusGroupLoop(swigCPtr, enabled);
518 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
521 internal bool GetFocusGroupLoop()
523 bool ret = NDalicManualPINVOKE.FocusManager_GetFocusGroupLoop(swigCPtr);
524 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
529 /// 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>
530 /// Layout controls set themselves as focus groups by default.<br>
532 /// <param name="view">The View to be set as a focus group</param>
533 /// <param name="isFocusGroup">Whether to set the View as a focus group or not</param>
534 public void SetAsFocusGroup(View view, bool isFocusGroup)
536 NDalicManualPINVOKE.FocusManager_SetAsFocusGroup(swigCPtr, View.getCPtr(view), isFocusGroup);
537 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
541 /// Checks whether the view is set as a focus group or not.
543 /// <param name="view">The View to be checked</param>
544 /// <returns>Whether the View is set as a focus group</returns>
545 public bool IsFocusGroup(View view)
547 bool ret = NDalicManualPINVOKE.FocusManager_IsFocusGroup(swigCPtr, View.getCPtr(view));
548 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
553 /// Returns the closest ancestor of the given view that is a focus group.
555 /// <param name="view">The View to be checked for its focus group</param>
556 /// <returns>The focus group the given view belongs to or an empty handle if the given view</returns>
557 public View GetFocusGroup(View view)
559 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetFocusGroup(swigCPtr, View.getCPtr(view));
561 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
564 /*View ret = new View(NDalicManualPINVOKE.FocusManager_GetFocusGroup(swigCPtr, View.getCPtr(view)), true);
565 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
566 if (ret.HasBody() == false)
575 /// Sets/Gets the focus indicator View.<br>
576 /// This will replace the default focus indicator view in FocusManager and will be added to the focused view as a highlight.<br>
578 public View FocusIndicator
582 SetFocusIndicatorView(value);
586 return GetFocusIndicatorView();
590 internal void SetFocusIndicatorView(View indicator)
592 NDalicManualPINVOKE.FocusManager_SetFocusIndicatorActor(swigCPtr, View.getCPtr(indicator));
593 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
596 internal View GetFocusIndicatorView()
598 IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetFocusIndicatorActor(swigCPtr);
600 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
606 /// Provide the implementation of custom Focus algorithm interface to allow the app define the focus logic.<br>
608 /// <param name="arg0">The user's implementation of ICustomFocusAlgorithm</param>
609 public void SetCustomAlgorithm(ICustomFocusAlgorithm arg0)
611 _customAlgorithmInterfaceWrapper = new CustomAlgorithmInterfaceWrapper();
612 _customAlgorithmInterfaceWrapper.SetFocusAlgorithm(arg0);
614 NDalicPINVOKE.SetCustomAlgorithm(swigCPtr, CustomAlgorithmInterface.getCPtr(_customAlgorithmInterfaceWrapper));
615 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
618 internal PreFocusChangeSignal PreFocusChangeSignal()
620 PreFocusChangeSignal ret = new PreFocusChangeSignal(NDalicManualPINVOKE.FocusManager_PreFocusChangeSignal(swigCPtr), false);
621 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
625 internal FocusChangedSignal FocusChangedSignal()
627 FocusChangedSignal ret = new FocusChangedSignal(NDalicManualPINVOKE.FocusManager_FocusChangedSignal(swigCPtr), false);
628 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
632 internal FocusGroupChangedSignal FocusGroupChangedSignal()
634 FocusGroupChangedSignal ret = new FocusGroupChangedSignal(NDalicManualPINVOKE.FocusManager_FocusGroupChangedSignal(swigCPtr), false);
635 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
639 internal ViewSignal FocusedViewEnterKeySignal()
641 ViewSignal ret = new ViewSignal(NDalicManualPINVOKE.FocusManager_FocusedActorEnterKeySignal(swigCPtr), false);
642 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
646 private static readonly FocusManager instance = FocusManager.Get();
649 /// Gets the singleton of FocusManager object.
651 public static FocusManager Instance
660 /// ICustomFocusAlgorithm is used to provide custom keyboard focus algorithm for retrieving the next focusable view.<br>
661 /// The application can implement the interface and override the keyboard focus behaviour.<br>
662 /// If focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.<br>
663 /// If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine next focusable actor.<br>
664 /// If focusable properties are not set, then the Keyboard FocusManager calls the GetNextFocusableView() method of this interface.<br>
666 public interface ICustomFocusAlgorithm
668 View GetNextFocusableView(View current, View proposed, View.FocusDirection direction);
671 private class CustomAlgorithmInterfaceWrapper : CustomAlgorithmInterface
673 private FocusManager.ICustomFocusAlgorithm _customFocusAlgorithm;
675 public CustomAlgorithmInterfaceWrapper()
679 public void SetFocusAlgorithm(FocusManager.ICustomFocusAlgorithm customFocusAlgorithm)
681 _customFocusAlgorithm = customFocusAlgorithm;
684 public override View GetNextFocusableView(View current, View proposed, View.FocusDirection direction)
686 return _customFocusAlgorithm.GetNextFocusableView(current, proposed, direction);
692 [Obsolete("Please do not use! this will be deprecated")]
693 public class FocusedViewEnterKeyEventArgs : EventArgs
710 private EventHandler<FocusedViewEnterKeyEventArgs> _focusedViewEnterKeyEventHandler2;
711 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
712 private delegate void FocusedViewEnterKeyEventCallback2(IntPtr view);
713 private FocusedViewEnterKeyEventCallback2 _focusedViewEnterKeyEventCallback2;
715 [Obsolete("Please do not use! this will be deprecated")]
716 public event EventHandler<FocusedViewEnterKeyEventArgs> FocusedViewEnterKeyPressed
720 if (_focusedViewEnterKeyEventCallback2 == null)
722 _focusedViewEnterKeyEventCallback2 = OnFocusedViewEnterKey2;
723 FocusedViewEnterKeySignal().Connect(_focusedViewEnterKeyEventCallback2);
725 _focusedViewEnterKeyEventHandler2 += value;
729 _focusedViewEnterKeyEventHandler2 -= value;
731 if (_focusedViewEnterKeyEventCallback2 == null && FocusedViewEnterKeySignal().Empty() == false)
733 FocusedViewEnterKeySignal().Disconnect(_focusedViewEnterKeyEventCallback2);
738 [Obsolete("Please do not use! this will be deprecated")]
739 private void OnFocusedViewEnterKey2(IntPtr view)
741 FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
743 e.View = Registry.GetManagedBaseHandleFromNativePtr(view) as View;
745 if (_focusedViewEnterKeyEventHandler != null)
747 _focusedViewEnterKeyEventHandler(this, e);