base/dali-toolkit/internal/controls/popup/popup-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_POPUP_H__
   2 #define __DALI_TOOLKIT_INTERNAL_POPUP_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/actors/image-actor.h>
  23 #include <dali/public-api/actors/layer.h>
  24 #include <dali/public-api/animation/animation.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/control-impl.h>
  28 #include <dali-toolkit/public-api/controls/popup/popup.h>
  29 #include <dali-toolkit/internal/controls/popup/popup-style-impl.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 class Button;
  38
  39 namespace Internal
  40 {
  41
  42 class Popup;
  43 class PopupStyle;
  44
  45 typedef IntrusivePtr<Popup>    PopupPtr;
  46 typedef IntrusivePtr<PopupStyle> PopupStylePtr;
  47
  48 /**
  49  * @copydoc Toolkit::Popup
  50  */
  51 class Popup : public Control
  52 {
  53 public:
  54
  55   /**
  56    * Create a new Popup.
  57    * @return A public handle to the newly allocated Popup.
  58    */
  59   static Dali::Toolkit::Popup New();
  60
  61 public:
  62
  63   /**
  64    * Returns number of buttons added to Popup
  65    *
  66    * @return Number of buttons
  67    */
  68   size_t GetButtonCount() const;
  69
  70   /**
  71    * @copydoc Toolkit::Popup::SetBackgroundImage
  72    */
  73   void SetBackgroundImage( Actor image );
  74
  75   /**
  76    * @copydoc Toolkit::Popup::SetButtonAreaImage
  77    */
  78   void SetButtonAreaImage( Actor image );
  79
  80   /**
  81    * @copydoc Toolkit::Popup::SetTitle( const std::string& text );
  82    */
  83   void SetTitle( const std::string& text );
  84
  85   /**
  86    * @copydoc Toolkit::Popup::SetTitle( TextView titleActor )
  87    */
  88   void SetTitle( Toolkit::TextView titleActor );
  89
  90   /**
  91    * @copydoc Toolkit::Popup::GetTitle
  92    */
  93   Toolkit::TextView GetTitle() const;
  94
  95   /**
  96    * @copydoc Toolkit::Popup::AddButton
  97    */
  98   void AddButton( Toolkit::Button button );
  99
 100   /**
 101    * @copydoc Toolkit::Popup::SetState( PopupState state )
 102    */
 103   void SetState( Toolkit::Popup::PopupState state );
 104
 105   /**
 106    * @copydoc Toolkit::Popup::SetState( PopupState state, float duration )
 107    */
 108   void SetState( Toolkit::Popup::PopupState state, float duration );
 109
 110   /**
 111    * @copydoc Toolkit::Popup::GetState( )
 112    */
 113   Toolkit::Popup::PopupState GetState() const;
 114
 115   /**
 116    * @copydoc Toolkit::Popup::ShowTail
 117    */
 118   void ShowTail(const Vector3& position);
 119
 120   /**
 121    * @copydoc Toolkit::Popup::HideTail
 122    */
 123   void HideTail();
 124
 125
 126   /**
 127    * Sets the style of the popup
 128    * @param[in] style The style of the popup
 129    */
 130   void SetStyle(PopupStyle& style);
 131
 132   /**
 133    * Gets the style of the popup
 134    * @return style of the popup
 135    */
 136   PopupStylePtr GetStyle() const;
 137
 138 protected:
 139
 140   /**
 141    * Construct a new Popup.
 142    * @param[in] style of the popup
 143    */
 144   Popup(PopupStyle& style);
 145
 146   /**
 147    * A reference counted object may only be deleted by calling Unreference()
 148    */
 149   virtual ~Popup();
 150
 151 private:
 152
 153   /**
 154    * Creates and applies the default background image.
 155    */
 156   void SetDefaultBackgroundImage();
 157
 158   /**
 159    * Create Dim Backing
 160    * (covers all content behind the dialog)
 161    */
 162   void CreateBacking();
 163
 164   /**
 165    * Create Dialog
 166    * (dialog content resides inside this - buttons, title etc.)
 167    */
 168   void CreateDialog();
 169
 170   /**
 171    * Animate Popup by scaling uniformally from 0 to 100% and vice versa (default behaviour)
 172    * @param[in] state The desired state to change into.
 173    * @param[in] duration The time for this animation to take.
 174    */
 175   void HandleStateChange( Toolkit::Popup::PopupState state, float duration );
 176
 177   /**
 178    * Invoked once StateChange has completed.
 179    */
 180   void HandleStateChangeComplete();
 181
 182 public: // Signals
 183
 184   /**
 185    * @copydoc Dali::Toolkit::Popup::OutsideTouchedSignal()
 186    */
 187   Toolkit::Popup::TouchedOutsideSignalType& OutsideTouchedSignal();
 188
 189   /**
 190    * @copydoc Dali::Toolkit::Popup::HiddenSignal()
 191    */
 192   Toolkit::Popup::HiddenSignalType& HiddenSignal();
 193
 194   /**
 195    * Connects a callback function with the object's signals.
 196    * @param[in] object The object providing the signal.
 197    * @param[in] tracker Used to disconnect the signal.
 198    * @param[in] signalName The signal to connect to.
 199    * @param[in] functor A newly allocated FunctorDelegate.
 200    * @return True if the signal was connected.
 201    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 202    */
 203   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 204
 205 private:
 206
 207   /**
 208    * Signal occurs when the State animation (transition from hide<->show) finishes
 209    * @param[in] source The animation that just finished.
 210    */
 211   void OnStateAnimationFinished( Animation& source );
 212
 213   /**
 214    * Signal occurs when the dimmed backing for the Popup is touched.
 215    * @param[in] actor The Actor Touched
 216    * @param[in] event The Touch Event.
 217    * @return Whether to consume event or not.
 218    */
 219   bool OnBackingTouched(Actor actor, const TouchEvent& event);
 220
 221   /**
 222    * Signal occurs when the mouse wheel event is occured on dimmed backing for the Popup.
 223    * @param[in] actor The Actor got mouse wheel
 224    * @param[in] event The Mouse Wheel Event.
 225    * @return Whether to consume event or not.
 226    */
 227   bool OnBackingMouseWheelEvent(Actor actor, const MouseWheelEvent& event);
 228
 229   /**
 230    * Signal occurs when the dialog has been touched.
 231    * @param[in] actor The Actor Touched
 232    * @param[in] event The Touch Event.
 233    * @return Whether to consume event or not.
 234    */
 235   bool OnDialogTouched(Actor actor, const TouchEvent& event);
 236
 237   /**
 238    * @copydoc Toolkit::Control::OnInitialize()
 239    */
 240   virtual void OnInitialize();
 241
 242   /**
 243    * @copydoc Dali::CustomActorImpl::OnPropertySet()
 244    */
 245   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
 246
 247   /**
 248    * From Control; called after a child has been added to the owning actor.
 249    * @param[in] child The child which has been added.
 250    */
 251   virtual void OnControlChildAdd( Actor& child );
 252
 253   /**
 254    * @copydoc Control::OnRelayout()
 255    */
 256   virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container );
 257
 258   /**
 259    * @copydoc Control::OnKeyEvent()
 260    */
 261   virtual bool OnKeyEvent(const KeyEvent& event);
 262
 263   /**
 264    * @copydoc Control::GetNaturalSize()
 265    */
 266   virtual Vector3 GetNaturalSize();
 267
 268   /**
 269    * @copydoc Control::GetHeightForWidth()
 270    */
 271   float GetHeightForWidth( float width );
 272
 273   /**
 274    * @copydoc Control::GetWidthForHeight()
 275    */
 276   float GetWidthForHeight( float height );
 277
 278   /**
 279    * @copydoc Control::GetNextKeyboardFocusableActor()
 280    */
 281   Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
 282
 283 private:
 284
 285   // Undefined
 286   Popup(const Popup&);
 287
 288   // Undefined
 289   Popup& operator=(const Popup& rhs);
 290
 291 private:
 292
 293   struct LayoutInfo
 294   {
 295     Vector3 mTitleSize;
 296     Vector3 mContentSize;
 297     Vector3 mButtonBgSize;
 298     std::vector<Vector3> mButtonSize;
 299   };
 300
 301 private:
 302
 303   bool mShowing;                          ///< Popup is showing or not
 304
 305   Layer mLayer;                           ///< Popup Layer (i.e. Dim backing and PopupBg reside in this)
 306   Actor mPopupBg;                         ///< Popup Background (i.e. dialog reside in this)
 307   ImageActor mBacking;                    ///< Backing actor (dim effect)
 308
 309   Actor mPreviousFocusedActor;            ///< Store the previous focused actor to restore the focus when popup hide
 310
 311   Actor mBackgroundImage;                 ///< Stores the background image.
 312   Actor mButtonAreaImage;                 ///< Stores the button background image.
 313   Toolkit::TextView mTitle;               ///< Stores the text title.
 314   Actor mContent;                         ///< Stores popup's content.
 315   Actor mBottomBg;                        ///< bottom button bar background. ImageActor is replaced with Actor due to hidden image.
 316   Actor mTailImage;                       ///< Stores the tail image
 317
 318   ActorContainer mButtons;                ///< Keeps track of the buttons added to this popup.
 319   Toolkit::Popup::PopupState mState;      ///< Popup current state.
 320   Animation mAnimation;                   ///< The animation instance managing state changing.
 321   bool mAlterAddedChild;                  ///< Flag used to control whether children are reparented or not.
 322   PopupStylePtr mPopupStyle;              ///< The style to be used for this popup.
 323
 324   LayoutInfo mLayoutInfo;                 ///< Stores sizes of all popup components.
 325
 326   Toolkit::Popup::TouchedOutsideSignalType mTouchedOutsideSignal;
 327   Toolkit::Popup::HiddenSignalType mHiddenSignal;
 328
 329   Property::Index mPropertyTitle;         ///< Property index for Title.
 330   Property::Index mPropertyState;         ///< Property index for popup state.
 331 };
 332
 333 } // namespace Internal
 334
 335 // Helpers for public-api forwarding methods
 336
 337 inline Toolkit::Internal::Popup& GetImpl(Toolkit::Popup& pub)
 338 {
 339   DALI_ASSERT_ALWAYS(pub);
 340
 341   Dali::RefObject& handle = pub.GetImplementation();
 342
 343   return static_cast<Toolkit::Internal::Popup&>(handle);
 344 }
 345
 346 inline const Toolkit::Internal::Popup& GetImpl(const Toolkit::Popup& pub)
 347 {
 348   DALI_ASSERT_ALWAYS(pub);
 349
 350   const Dali::RefObject& handle = pub.GetImplementation();
 351
 352   return static_cast<const Toolkit::Internal::Popup&>(handle);
 353 }
 354
 355 } // namespace Toolkit
 356
 357 } // namespace Dali
 358
 359 #endif // __DALI_TOOLKIT_INTERNAL_POPUP_H__