1 #ifndef __DALI_TOOLKIT_TOOL_BAR_H__
2 #define __DALI_TOOLKIT_TOOL_BAR_H__
5 * Copyright (c) 2014 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.
25 #include <dali-toolkit/public-api/controls/alignment/alignment.h>
33 namespace Internal DALI_INTERNAL
35 // Forward declarations
40 * Provides a tool bar where other controls (Dali::Actor) could be placed.
41 * controls could be added into three different groups: on the left, center or right.
42 * AddControl() and RemoveControl() methods should be used to add and remove controls. The use of Actor's Dali::Actor::Add() method
43 * is not forbidden, it adds controls on the left group with a size of 10% of the total tool bar size.
44 * Dali::Actor::Remove() method does nothing.
46 class DALI_IMPORT_API ToolBar : public Control
49 static const Toolkit::Alignment::Padding DEFAULT_PADDING; ///< Default padding space between controls. By default all values are set to 0.
53 * Create a ToolBar handle; this can be initialised with ToolBar::New()
54 * Calling member functions with an uninitialised handle is not allowed.
59 * Copy constructor. Creates another handle that points to the same real object
60 * @param handle to copy from
62 ToolBar( const ToolBar& handle );
65 * Assignment operator. Changes this handle to point to another real object
67 ToolBar& operator=( const ToolBar& handle );
72 * This is non-virtual since derived Handle types must not contain data or virtual methods.
77 * Create an initialized ToolBar.
78 * @return A handle to a newly allocated Dali resource.
83 * Downcast an Object handle to ToolBar. If handle points to a ToolBar the
84 * downcast produces valid handle. If not the returned handle is left uninitialized.
85 * @param[in] handle Handle to an object
86 * @return handle to a ToolBar or an uninitialized handle
88 static ToolBar DownCast( BaseHandle handle );
91 * Sets a background image.
92 * @param background Actor with the tool bar background.
94 void SetBackground( Actor background );
97 * Adds an additional control to the tool bar.
98 * @pre The tool bar needs to be initialized.
99 * @pre The alignment needs to be horizontal.
100 * @param control An Actor with the additional control.
101 * @param relativeSize Control's size as a percentage of the tool bar width.
102 * @param alignment Where to insert controls. Possible values are Toolkit::Alignment::Left, Toolkit::Alignment::Center or Toolkit::Alignment::Right.
103 * @param padding Padding values used for the added control (left, right, top, bottom). By default, no padding is added.
105 void AddControl( Actor control, float relativeSize, Toolkit::Alignment::Type alignment, const Toolkit::Alignment::Padding& padding = DEFAULT_PADDING );
108 * Removes a control from the tool bar.
109 * @pre control must have been added before to this tool bar.
110 * @param control The control to be removed.
112 void RemoveControl( Actor control );
114 public: // Not intended for application developers
117 * Creates a handle using the Toolkit::Internal implementation.
118 * @param[in] implementation The Control implementation.
120 DALI_INTERNAL ToolBar( Internal::ToolBar& implementation );
123 * Allows the creation of this Control from an Internal::CustomActor pointer.
124 * @param[in] internal A pointer to the internal CustomActor.
126 explicit DALI_INTERNAL ToolBar( Dali::Internal::CustomActor* internal );
129 } // namespace Toolkit
133 #endif // __DALI_TOOLKIT_TOOL_BAR_H__