dali-toolkit/devel-api/controls/text-controls/text-selection-toolbar.h

   1 #ifndef __DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H__
   2 #define __DALI_TOOLKIT_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.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextSelectionToolbar;
  33 }
  34
  35 /**
  36  * @brief A control which provides a Popup with a number of buttons
  37  *
  38  * The style of the pop can be set through style sheets, this includes the images for the buttons
  39  * A Show and Hide API is provided.
  40  *
  41  * If the buttons exceed the size constraints of the popup then it will offer scrolling.
  42  *
  43  *
  44  */
  45 class DALI_IMPORT_API TextSelectionToolbar : public Control
  46 {
  47 public:
  48
  49   /**
  50    * @brief The start and end property ranges for this control.
  51    */
  52   enum PropertyRange
  53   {
  54     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  55     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  56   };
  57
  58   /**
  59    * @brief An enumeration of properties belonging to the TextSelectionToolbar class.
  60    */
  61   struct Property
  62   {
  63     enum
  64     {
  65       MAX_SIZE =  PROPERTY_START_INDEX, ///< name "maxSize",                 The maximum size the Popup can be,              type VECTOR2
  66       ENABLE_OVERSHOOT,                 ///< name "enableOvershoot",         Whether the overshoot image is enabled,         type BOOLEAN
  67       ENABLE_SCROLL_BAR,                ///< name "enableScrollBar",         Whether the scroll-bar is enabled,              type BOOLEAN
  68       SCROLL_BAR_PADDING,               ///< name "scrollBarPadding",        The padding used to position the scroll bar,    type VECTOR2
  69       SCROLL_VIEW,                      ///< name "scrollView",              Properties to set on scroll view                type Property::Map
  70     };
  71   };
  72
  73   /**
  74    * Create the TextSelectionToolbar control.
  75    * @return A handle to the TextSelectionToolbar control.
  76    */
  77   static TextSelectionToolbar New();
  78
  79   /**
  80    * @brief Creates an empty handle.
  81    */
  82   TextSelectionToolbar();
  83
  84   /**
  85    * @brief Copy constructor.
  86    *
  87    * @param[in] handle The handle to copy from.
  88    */
  89   TextSelectionToolbar( const TextSelectionToolbar& handle );
  90
  91   /**
  92    * @brief Assignment operator.
  93    *
  94    * @param[in] handle The handle to copy from.
  95    * @return A reference to this.
  96    */
  97   TextSelectionToolbar& operator=( const TextSelectionToolbar& handle );
  98
  99   /**
 100    * @brief Destructor
 101    *
 102    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 103    */
 104   ~TextSelectionToolbar();
 105
 106
 107   /**
 108    * @brief Add a option to the the Tool bar
 109    * @param[in] option Option actor to add
 110    */
 111   void AddOption( Actor& option );
 112
 113   /**
 114    * @brief Add a divider to the the Tool bar
 115    * @param[in] divider Actor to be used as divider
 116    */
 117   void AddDivider( Actor& divider );
 118
 119   /**
 120    *  @brief ResizeDividers
 121    *  @param[in] size New size of dividers, provide 0 for height to automatically set height
 122    */
 123   void ResizeDividers( Size& size );
 124
 125   /**
 126    * @brief Raises the layer above the given @e target layer.
 127    *
 128    * @param[in] target The layer to get above of.
 129    */
 130   void RaiseAbove( Layer target );
 131
 132   /**
 133    * @brief Downcast a handle to TextSelectionToolbar.
 134    *
 135    * If the BaseHandle points is a TextSelectionToolbar the downcast returns a valid handle.
 136    * If not the returned handle is left empty.
 137    *
 138    * @param[in] handle Handle to an object
 139    * @return handle to a TextSelectionToolbar or an empty handle
 140    */
 141   static TextSelectionToolbar DownCast( BaseHandle handle );
 142
 143 public: // Not intended for application developers
 144
 145   /**
 146    * @brief Creates a handle using the Toolkit::Internal implementation.
 147    *
 148    * @param[in] implementation The Control implementation.
 149    */
 150   DALI_INTERNAL TextSelectionToolbar( Internal::TextSelectionToolbar& implementation );
 151
 152   /**
 153    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 154    *
 155    * @param[in]  internal  A pointer to the internal CustomActor.
 156    */
 157   explicit DALI_INTERNAL TextSelectionToolbar( Dali::Internal::CustomActor* internal );
 158
 159 }; // Class TextSelectionToolbar
 160
 161 } // namespace Toolkit
 162
 163 } // namespace Dali
 164
 165 #endif // __DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H__