dali-toolkit/internal/controls/text-controls/text-selection-toolbar-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_TOOLBAR_H__
   2 #define __DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_TOOLBAR_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control-impl.h>
  23 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  24 #include <dali-toolkit/public-api/controls/table-view/table-view.h>
  25 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-toolbar.h>
  26
  27 // EXTERNAL INCLUDES
  28 #include <dali/public-api/actors/layer.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  38
  39 namespace
  40 {
  41
  42 } // namespace
  43
  44 class TextSelectionToolbar : public Control
  45 {
  46 public:
  47
  48   /**
  49    * @copydoc Dali::Toollkit::TextSelectionToolbar::New()
  50    */
  51   static Toolkit::TextSelectionToolbar New();
  52
  53   // Properties
  54
  55   /**
  56    * @brief Called when a property of an object of this type is set.
  57    * @param[in] object The object whose property is set.
  58    * @param[in] index The property index.
  59    * @param[in] value The new property value.
  60    */
  61   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  62
  63   /**
  64    * @brief Called to retrieve a property of an object of this type.
  65    *
  66    * @param[in] object The object whose property is to be retrieved.
  67    * @param[in] index The property index.
  68    * @return The current value of the property.
  69    */
  70   static Property::Value GetProperty( BaseObject* object, Property::Index index );
  71
  72   /**
  73    *  @copydoc TextSelectionToolbar::AddOption
  74    */
  75   void AddOption( Actor& option );
  76
  77   /**
  78    *  @copydoc TextSelectionToolbar::AddDivider
  79    */
  80   void AddDivider( Actor& divider );
  81
  82   /**
  83    * @copydoc ResizeDividers
  84    */
  85   void ResizeDividers( Size& size );
  86
  87 private: // From Control
  88
  89   /**
  90    * @copydoc Control::OnInitialize()
  91    */
  92   virtual void OnInitialize();
  93
  94   /**
  95   * @copydoc Control::OnRelayout()
  96   */
  97   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
  98   /**
  99    * @brief Set max size of Popup
 100    * @param[in] maxSize Size (Vector2)
 101    */
 102   void SetPopupMaxSize( const Size& maxSize );
 103
 104   /**
 105    * @brief Get Max size of Popup
 106    * @return Vector2 the max size of the Popup
 107    */
 108   const Dali::Vector2& GetPopupMaxSize() const;
 109
 110   /**
 111    * @brief Set up scrollview to scroll Toolbar horizontally
 112    * @param[out] scrollView scrollview to setup
 113    */
 114   void SetUpScrollView( Toolkit::ScrollView& scrollView );
 115
 116   /**
 117    * @brief Set up the parts that make the Toolbar
 118    */
 119   void SetUp();
 120
 121   /**
 122    * Toolbar has started to scroll
 123    * @param[in] position current scroll view position
 124    */
 125   void OnScrollStarted( const Vector2& position );
 126
 127   /**
 128    * Toolbar has stopped scrolling
 129    * @param[in] position current scroll view position
 130    */
 131   void OnScrollCompleted( const Vector2& position );
 132
 133 private: // Implementation
 134
 135   /**
 136    * Construct a new TextField.
 137    */
 138   TextSelectionToolbar();
 139
 140   /**
 141    * A reference counted object may only be deleted by calling Unreference()
 142    */
 143   virtual ~TextSelectionToolbar();
 144
 145 private:
 146
 147   // Undefined copy constructor and assignment operators
 148   TextSelectionToolbar(const TextSelectionToolbar&);
 149   TextSelectionToolbar& operator=(const TextSelectionToolbar& rhs);
 150
 151 private: // Data
 152
 153   Toolkit::TableView mTableOfButtons;                 // Actor which holds all the buttons, sensitivity can be set on buttons via this actor
 154   Toolkit::ScrollView mScrollView;                    // Provides scrolling of Toolbar when content does not fit.
 155   RulerPtr mRulerX;                                   // Ruler to clamp horizontal scrolling. Updates on Relayout
 156   Size mMaxSize;                                      // Max size of the Toolbar
 157   unsigned int mIndexInTable;                         // Index in table to add option
 158   Dali::Vector< unsigned int > mDividerIndexes;       // Vector of indexes in the Toolbar that contain dividers.
 159
 160 };
 161
 162 } // namespace Internal
 163
 164 // Helpers for public-api forwarding methods
 165
 166 inline Toolkit::Internal::TextSelectionToolbar& GetImpl( Toolkit::TextSelectionToolbar& textSelectionToolbar )
 167 {
 168   DALI_ASSERT_ALWAYS( textSelectionToolbar );
 169
 170   Dali::RefObject& handle = textSelectionToolbar.GetImplementation();
 171
 172   return static_cast<Toolkit::Internal::TextSelectionToolbar&>(handle);
 173 }
 174
 175 inline const Toolkit::Internal::TextSelectionToolbar& GetImpl( const Toolkit::TextSelectionToolbar& textSelectionToolbar )
 176 {
 177   DALI_ASSERT_ALWAYS( textSelectionToolbar );
 178
 179   const Dali::RefObject& handle = textSelectionToolbar.GetImplementation();
 180
 181   return static_cast<const Toolkit::Internal::TextSelectionToolbar&>(handle);
 182 }
 183
 184 } // namespace Toolkit
 185
 186 } // namespace Dali
 187
 188 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_TOOLBAR_H__