1 #ifndef DALI_TOOLKIT_NAVIGATION_VIEW_H
2 #define DALI_TOOLKIT_NAVIGATION_VIEW_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-toolkit/public-api/controls/control.h>
23 #include <dali/public-api/animation/alpha-function.h>
29 namespace Internal DALI_INTERNAL
31 // Forward declarations
33 } // namespace DALI_INTERNAL
36 * @brief NavigationView implements a view that manages the navigation of hierarchical contents.
38 * An Actor is pushed onto the NavigationView, itself and its children are added to the stage.
39 * The actors currently shown are replaced.
40 * When pop is called on the NavigationView, the current tree of Actors are removed and the previous set added back.
41 * If pop is called on the last set of Actors then they remain, nothing is popped.
43 class DALI_TOOLKIT_API NavigationView : public Control
47 * @brief Create a NavigationView handle; this can be initialize with NavigationView::New().
49 * @note Calling member function with an uninitialized handle is not allowed.
54 * @brief Copy Constructor.
55 * @param[in] handle Handle to copy.
57 NavigationView(const NavigationView& handle);
60 * @brief Assignment operator.
61 * @param[in] handle The handle to copy from.
62 * @return reference to this
64 NavigationView& operator=(const NavigationView& handle);
67 * @brief Move Constructor.
68 * @param[in] handle Handle to move.
70 NavigationView(NavigationView&& handle);
73 * @brief Move assignment operator.
74 * @param[in] handle The handle to move from.
75 * @return reference to this
77 NavigationView& operator=(NavigationView&& handle);
82 * This is non-virtual since derived Handle types must not contain data or virtual methods.
87 * @brief Create an initialized NavigationView.
89 * @return A handle to a newly allocated Dali resource.
91 static NavigationView New();
94 * @brief Downcast an object handle to NavigationView.
96 * @details If handle points to a NavigationView, the downcast produces a valid handle.
97 * If not, the returned handle is left uninitialized.
98 * @param[in] handle Handle to an object.
99 * @return handle to a NavigationView of an uninitialized handle.
101 static NavigationView DownCast(BaseHandle handle);
104 * @brief Push a new actor tree to the top of the NavigationView stack and show it.
105 * @param[in] item An actor tree.
107 void Push(Actor item);
110 * @brief Pop the actor tree that is on the top of the NavigationView stack and make it disappear.
112 * @return The Actor tree popped out.
114 * @note It does not pop out the last item in the stack.
115 * It returns an uninitialized item handle if there is no item or only one item in the stack.
119 public: // Not intended for application developers
122 * Creates a handle using the Toolkit::Internal implementation.
123 * @param[in] implementation The Control implementation.
125 DALI_INTERNAL NavigationView(Internal::NavigationView& implementation);
128 * Allows the creation of this Control from an Internal::CustomActor pointer.
129 * @param[in] internal A pointer to the internal CustomActor.
131 explicit DALI_INTERNAL NavigationView(Dali::Internal::CustomActor* internal);
133 }; // class NavigationView
135 } // namespace Toolkit
139 #endif // DALI_TOOLKIT_NAVIGATION_VIEW_H