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 "max-size",                The maximum size the Popup can be,              type VECTOR2
  66       ENABLE_OVERSHOOT,                 ///< name "enable-overshoot",        Whether the overshoot image is enabled,         type BOOLEAN
  67     };
  68   };
  69
  70   /**
  71    * Create the TextSelectionToolbar control.
  72    * @return A handle to the TextSelectionToolbar control.
  73    */
  74   static TextSelectionToolbar New();
  75
  76   /**
  77    * @brief Creates an empty handle.
  78    */
  79   TextSelectionToolbar();
  80
  81   /**
  82    * @brief Copy constructor.
  83    *
  84    * @param[in] handle The handle to copy from.
  85    */
  86   TextSelectionToolbar( const TextSelectionToolbar& handle );
  87
  88   /**
  89    * @brief Assignment operator.
  90    *
  91    * @param[in] handle The handle to copy from.
  92    * @return A reference to this.
  93    */
  94   TextSelectionToolbar& operator=( const TextSelectionToolbar& handle );
  95
  96   /**
  97    * @brief Destructor
  98    *
  99    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 100    */
 101   ~TextSelectionToolbar();
 102
 103
 104   /**
 105    * @brief Add a option to the the Tool bar
 106    * @param[in] option Option actor to add
 107    */
 108   void AddOption( Actor& option );
 109
 110   /**
 111    * @brief Add a divider to the the Tool bar
 112    * @param[in] divider Actor to be used as divider
 113    */
 114   void AddDivider( Actor& divider );
 115
 116   /**
 117    *  @brief ResizeDividers
 118    *  @param[in] size New size of dividers, provide 0 for height to automatically set height
 119    */
 120   void ResizeDividers( Size& size );
 121
 122   /**
 123    * @brief Raises the layer above the given @e target layer.
 124    *
 125    * @param[in] target The layer to get above of.
 126    */
 127   void RaiseAbove( Layer target );
 128
 129   /**
 130    * @brief Downcast a handle to TextSelectionToolbar.
 131    *
 132    * If the BaseHandle points is a TextSelectionToolbar the downcast returns a valid handle.
 133    * If not the returned handle is left empty.
 134    *
 135    * @param[in] handle Handle to an object
 136    * @return handle to a TextSelectionToolbar or an empty handle
 137    */
 138   static TextSelectionToolbar DownCast( BaseHandle handle );
 139
 140 public: // Not intended for application developers
 141
 142   /**
 143    * @brief Creates a handle using the Toolkit::Internal implementation.
 144    *
 145    * @param[in] implementation The Control implementation.
 146    */
 147   DALI_INTERNAL TextSelectionToolbar( Internal::TextSelectionToolbar& implementation );
 148
 149   /**
 150    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 151    *
 152    * @param[in]  internal  A pointer to the internal CustomActor.
 153    */
 154   explicit DALI_INTERNAL TextSelectionToolbar( Dali::Internal::CustomActor* internal );
 155
 156 }; // Class TextSelectionToolbar
 157
 158 } // namespace Toolkit
 159
 160 } // namespace Dali
 161
 162 #endif // __DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H__