1 #ifndef DALI_TOOLKIT_FOCUS_FINDER_H
\r
2 #define DALI_TOOLKIT_FOCUS_FINDER_H
\r
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
\r
7 * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * you may not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
21 // INTERNAL INCLUDES
\r
22 #include <dali-toolkit/public-api/controls/control.h>
\r
28 namespace Internal DALI_INTERNAL
\r
35 * This class used for finding the next focusable actor in a given direction
\r
36 * from a actor that currently has focus.
\r
38 class DALI_TOOLKIT_API FocusFinder : public BaseHandle
\r
42 * Create a FocusFinder handle; this can be initialised with FocusFinder::Get()
\r
43 * Calling member functions with an uninitialised handle is not allowed.
\r
50 * This is non-virtual since derived Handle types must not contain data or virtual methods.
\r
55 * @brief Get the singleton of FocusFinder object.
\r
56 * @return A handle to the FocusFinder control.
\r
58 static FocusFinder Get();
\r
61 * Get the nearest focusable actor.
\r
62 * @param [in] focusedActor The current focused actor.
\r
63 * @param [in] direction The direction.
\r
64 * @return The nearest focusable actor, or null if none exists.
\r
66 Actor GetNearestFocusableActor(Actor focusedActor, Toolkit::Control::KeyboardFocus::Direction direction);
\r
69 explicit DALI_INTERNAL FocusFinder(Internal::FocusFinder* impl);
\r
71 }; // class FocusFinder
\r
73 } // namespace Toolkit
\r
77 #endif // DALI_TOOLKIT_FOCUS_FINDER_H
\r