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/dali.h>
26 #include <dali-toolkit/public-api/controls/alignment/alignment.h>
28 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
36 // Forward declarations
41 * Provides a tool bar where other controls (Dali::Actor) could be placed.
42 * controls could be added into three different groups: on the left, center or right.
43 * AddControl() and RemoveControl() methods should be used to add and remove controls. The use of Actor's Dali::Actor::Add() method
44 * is not forbidden, it adds controls on the left group with a size of 10% of the total tool bar size.
45 * Dali::Actor::Remove() method does nothing.
47 class ToolBar : public Control
50 static const Toolkit::Alignment::Padding DEFAULT_PADDING; ///< Default padding space between controls. By default all values are set to 0.
54 * Create a ToolBar handle; this can be initialised with ToolBar::New()
55 * Calling member functions with an uninitialised handle is not allowed.
60 * Copy constructor. Creates another handle that points to the same real object
61 * @param handle to copy from
63 ToolBar( const ToolBar& handle );
66 * Assignment operator. Changes this handle to point to another real object
68 ToolBar& operator=( const ToolBar& handle );
76 * Create an initialized ToolBar.
77 * @return A handle to a newly allocated Dali resource.
82 * Downcast an Object handle to ToolBar. If handle points to a ToolBar the
83 * downcast produces valid handle. If not the returned handle is left uninitialized.
84 * @param[in] handle Handle to an object
85 * @return handle to a ToolBar or an uninitialized handle
87 static ToolBar DownCast( BaseHandle handle );
90 * Sets a background image.
91 * @param background Actor with the tool bar background.
93 void SetBackground( Actor background );
96 * Adds an additional control to the tool bar.
97 * @pre The tool bar needs to be initialized.
98 * @pre The alignment needs to be horizontal.
99 * @param control An Actor with the additional control.
100 * @param relativeSize Control's size as a percentage of the tool bar width.
101 * @param alignment Where to insert controls. Possible values are Toolkit::Alignment::Left, Toolkit::Alignment::Center or Toolkit::Alignment::Right.
102 * @param padding Padding values used for the added control (left, right, top, bottom). By default, no padding is added.
104 void AddControl( Actor control, float relativeSize, Toolkit::Alignment::Type alignment, const Toolkit::Alignment::Padding& padding = DEFAULT_PADDING );
107 * Removes a control from the tool bar.
108 * @pre control must have been added before to this tool bar.
109 * @param control The control to be removed.
111 void RemoveControl( Actor control );
113 public: // Not intended for application developers
116 * Creates a handle using the Toolkit::Internal implementation.
117 * @param[in] implementation The Control implementation.
119 ToolBar( Internal::ToolBar& implementation );
122 * Allows the creation of this Control from an Internal::CustomActor pointer.
123 * @param[in] internal A pointer to the internal CustomActor.
125 ToolBar( Dali::Internal::CustomActor* internal );
128 } // namespace Toolkit
132 #endif // __DALI_TOOLKIT_TOOL_BAR_H__