optional/dali-toolkit/internal/controls/tool-bar/tool-bar-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_TOOL_BAR_H__
   2 #define __DALI_TOOLKIT_INTERNAL_TOOL_BAR_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/map-wrapper.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/control-impl.h>
  26 #include <dali-toolkit/public-api/controls/tool-bar/tool-bar.h>
  27 #include <dali-toolkit/public-api/controls/table-view/table-view.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 class ToolBar;
  36
  37 namespace Internal
  38 {
  39
  40 /**
  41  * ToolBar is a control to create a tool bar.
  42  * @see Dali::Toolkit::ToolBar for more details.
  43  */
  44 class ToolBar : public Control
  45 {
  46 public:
  47
  48   /**
  49    * Create an initialized ToolBar.
  50    * @return A handle to a newly allocated Dali resource.
  51    */
  52   static Toolkit::ToolBar New();
  53
  54   /**
  55    * @copydoc Dali::Toolkit::View::SetBackground()
  56    */
  57   void SetBackground( Actor background );
  58
  59   /**
  60    * @copydoc Dali::Toolkit::View::AddControl()
  61    */
  62   void AddControl( Dali::Actor control, float relativeSize, Toolkit::Alignment::Type alignment, const Toolkit::Alignment::Padding& padding );
  63
  64   /**
  65    * @copydoc Dali::Toolkit::View::RemoveControl()
  66    */
  67   void RemoveControl( Dali::Actor control );
  68
  69 private: // From Control
  70
  71   /**
  72    * @copydoc Toolkit::Control::OnInitialize()
  73    */
  74   virtual void OnInitialize();
  75
  76   /**
  77    * Adds a control using some default values (the control uses 10% of the tool bar space and is placed on the left group).
  78    * @param child The control to be added.
  79    *
  80    * @see Control::OnControlChildAdd()
  81    */
  82   virtual void OnControlChildAdd(Actor& child);
  83
  84   /**
  85    * Called when the tool-bar is relaid out.
  86    * @param[in] size The size allocated.
  87    * @param[in/out] container the container to put actors not handled.
  88    */
  89   virtual void OnRelaidOut( Vector2 size, ActorSizeContainer& container );
  90
  91   /**
  92    *
  93    * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& targetSize )
  94    */
  95   virtual void OnControlSizeSet( const Vector3& targetSize );
  96
  97 private:
  98   /**
  99    */
 100   class Lock
 101   {
 102   public:
 103     /**
 104      * Constructor, sets the lock boolean
 105      */
 106     Lock( bool& lock )
 107     : mLock( lock )
 108     {
 109       mLock = true;
 110     }
 111
 112     /**
 113      * Destructor, releases lock boolean
 114      */
 115     ~Lock()
 116     {
 117       mLock = false;
 118     }
 119   private:
 120     bool& mLock;
 121   };
 122
 123   /**
 124    * Constructor.
 125    * It initializes ToolBar members.
 126    */
 127   ToolBar();
 128
 129   /**
 130    * A reference counted object may only be deleted by calling Unreference()
 131    */
 132   virtual ~ToolBar();
 133
 134 private:
 135   Toolkit::TableView mLayout;                   ///< TableView used to place controls.
 136   unsigned int       mLeftOffset;               ///< Offset index where the next control is going to be added in the left group.
 137   unsigned int       mCenterBase;               ///< Base index where the first control of the center group is placed.
 138   unsigned int       mCenterOffset;             ///< Offset index where the next control is going to be added in the center group.
 139   unsigned int       mRightBase;                ///< Base index where the first control of the right group is placed.
 140   unsigned int       mRightOffset;              ///< Offset index where the next control is going to be added in the right group.
 141   float              mLeftRelativeSpace;        ///< Relative space between left and center groups of controls.
 142   float              mRightRelativeSpace;       ///< Relative space between center and right groups of controls.
 143   float              mAccumulatedRelativeSpace; ///< Stores the total percentage space used by controls.
 144   bool               mInitializing;             ///< Allows the use of Actor's API to add controls.
 145   Vector3            mToolBarSize;              ///< The size of tool bar
 146   Actor              mBackground;               ///< The background of the tool bar
 147
 148   std::map<Actor/*control*/,Toolkit::Alignment> mControls; ///< Stores a relationship between controls and their alignments used to place them inside the table view.
 149 };
 150
 151 } // namespace Internal
 152
 153
 154 // Helpers for public-api forwarding methods
 155
 156 inline Toolkit::Internal::ToolBar& GetImpl( Toolkit::ToolBar& toolBar )
 157 {
 158   DALI_ASSERT_ALWAYS( toolBar );
 159
 160   Dali::RefObject& handle = toolBar.GetImplementation();
 161
 162   return static_cast<Toolkit::Internal::ToolBar&>( handle );
 163 }
 164
 165 inline const Toolkit::Internal::ToolBar& GetImpl( const Toolkit::ToolBar& toolBar )
 166 {
 167   DALI_ASSERT_ALWAYS( toolBar );
 168
 169   const Dali::RefObject& handle = toolBar.GetImplementation();
 170
 171   return static_cast<const Toolkit::Internal::ToolBar&>( handle );
 172 }
 173
 174 } // namespace Toolkit
 175
 176 } // namespace Dali
 177
 178 #endif // __DALI_TOOLKIT_INTERNAL_TOOL_BAR_H__