1 #ifndef DALI_TOOLKIT_INTERNAL_TOOL_BAR_H
2 #define DALI_TOOLKIT_INTERNAL_TOOL_BAR_H
5 * Copyright (c) 2021 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/devel-api/common/map-wrapper.h>
25 #include <dali-toolkit/devel-api/controls/table-view/table-view.h>
26 #include <dali-toolkit/devel-api/controls/tool-bar/tool-bar.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
38 * ToolBar is a control to create a tool bar.
39 * @see Dali::Toolkit::ToolBar for more details.
41 class ToolBar : public Control
45 * Create an initialized ToolBar.
46 * @return A handle to a newly allocated Dali resource.
48 static Toolkit::ToolBar New();
51 * @copydoc Dali::Toolkit::ToolBar::AddControl()
53 void AddControl(Dali::Actor control, float relativeSize, Toolkit::Alignment::Type alignment, const Toolkit::Alignment::Padding& padding);
56 * @copydoc Dali::Toolkit::ToolBar::RemoveControl()
58 void RemoveControl(Dali::Actor control);
60 private: // From Control
62 * @copydoc Toolkit::Control::OnInitialize()
64 void OnInitialize() override;
67 * Adds a control using some default values (the control uses 10% of the tool bar space and is placed on the left group).
68 * @param child The control to be added.
70 * @see Control::OnChildAdd()
72 void OnChildAdd(Actor& child) override;
81 * Constructor, sets the lock boolean
90 * Destructor, releases lock boolean
103 * It initializes ToolBar members.
108 * A reference counted object may only be deleted by calling Unreference()
113 Toolkit::TableView mLayout; ///< TableView used to place controls.
114 unsigned int mLeftOffset; ///< Offset index where the next control is going to be added in the left group.
115 unsigned int mCenterBase; ///< Base index where the first control of the center group is placed.
116 unsigned int mCenterOffset; ///< Offset index where the next control is going to be added in the center group.
117 unsigned int mRightBase; ///< Base index where the first control of the right group is placed.
118 unsigned int mRightOffset; ///< Offset index where the next control is going to be added in the right group.
119 float mLeftRelativeSpace; ///< Relative space between left and center groups of controls.
120 float mRightRelativeSpace; ///< Relative space between center and right groups of controls.
121 float mAccumulatedRelativeSpace; ///< Stores the total percentage space used by controls.
122 bool mInitializing; ///< Allows the use of Actor's API to add controls.
124 std::map<Actor /*control*/, Toolkit::Alignment> mControls; ///< Stores a relationship between controls and their alignments used to place them inside the table view.
127 } // namespace Internal
129 // Helpers for public-api forwarding methods
131 inline Toolkit::Internal::ToolBar& GetImpl(Toolkit::ToolBar& toolBar)
133 DALI_ASSERT_ALWAYS(toolBar);
135 Dali::RefObject& handle = toolBar.GetImplementation();
137 return static_cast<Toolkit::Internal::ToolBar&>(handle);
140 inline const Toolkit::Internal::ToolBar& GetImpl(const Toolkit::ToolBar& toolBar)
142 DALI_ASSERT_ALWAYS(toolBar);
144 const Dali::RefObject& handle = toolBar.GetImplementation();
146 return static_cast<const Toolkit::Internal::ToolBar&>(handle);
149 } // namespace Toolkit
153 #endif // DALI_TOOLKIT_INTERNAL_TOOL_BAR_H