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

   1 #ifndef __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__
   2 #define __DALI_TOOLKIT_TEXT_SELECTION_POPUP_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 class TextSelectionPopupCallbackInterface;
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class TextSelectionPopup;
  35 }
  36
  37 /**
  38  * @brief A control which provides a Popup with a number of buttons
  39  *
  40  * The style of the pop can be set through style sheets, this includes the images for the buttons
  41  * A Show and Hide API is provided.
  42  *
  43  * If the buttons exceed the size constraints of the popup then it will offer scrolling.
  44  *
  45  *
  46  */
  47 class DALI_IMPORT_API TextSelectionPopup : public Control
  48 {
  49 public:
  50
  51   enum Buttons
  52   {
  53     CUT = 1u << 0,
  54     COPY = 1u << 1,
  55     PASTE = 1u << 2,
  56     SELECT = 1u << 3,
  57     SELECT_ALL = 1u << 4,
  58     CLIPBOARD = 1u << 5,
  59     NONE = 1u << 6,
  60   };
  61
  62   /**
  63    * @brief The start and end property ranges for this control.
  64    */
  65   enum PropertyRange
  66   {
  67     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  68     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  69   };
  70
  71   /**
  72    * @brief An enumeration of properties belonging to the TextSelectionPopup class.
  73    */
  74   struct Property
  75   {
  76     enum
  77     {
  78       POPUP_MAX_SIZE =  PROPERTY_START_INDEX,   ///< name "popup-max-size",                maximum size the Popup can be,                  type VECTOR2
  79       POPUP_MIN_SIZE,                           ///< name "popup-min-size",                minimum size the Popup can be,                  type VECTOR2
  80       OPTION_MAX_SIZE,                          ///< name "option-max-size",               maximum size an option can be,                  type VECTOR2
  81       OPTION_MIN_SIZE,                          ///< name "option-min-size",               minimum size an option can be,                  type VECTOR2
  82       OPTION_DIVIDER_SIZE,                      ///< name "option-divider-size",           size of the divider between options             type VECTOR2
  83       POPUP_CLIPBOARD_BUTTON_ICON_IMAGE,        ///< name "popup-clipboard-button-image",  The image to use as the popup clipboard icon,   type STRING
  84       POPUP_CUT_BUTTON_ICON_IMAGE,              ///< name "popup-cut-button-image",        The image to use as the popup cut icon,         type STRING
  85       POPUP_COPY_BUTTON_ICON_IMAGE,             ///< name "popup-copy-button-image",       The image to use as the popup copy icon,        type STRING
  86       POPUP_PASTE_BUTTON_ICON_IMAGE,            ///< name "popup-paste-button-image",      The image to use as the popup paste icon,       type STRING
  87       POPUP_SELECT_BUTTON_ICON_IMAGE,           ///< name "popup-select-button-image",     The image to use as the popup select icon,      type STRING
  88       POPUP_SELECT_ALL_BUTTON_ICON_IMAGE,       ///< name "popup-select-all-button-image", The image to use as the popup select all icon,  type STRING
  89       DIVIDER_COLOR,                            ///< name "popup-divider-color", VECTOR4,  The color of the divider between options,       type VECTOR4
  90       ICON_COLOR,                               ///< name "popup-icon-color", VECTOR4,     The color of the icons (if supplied),           type VECTOR4
  91       PRESSED_COLOR                             ///< name "popup-pressed-color", VECTOR4,  The color of the option when pressed,           type VECTOR4
  92     };
  93   };
  94
  95   /**
  96    * Create the TextSelectionPopup control with the given set of buttons.
  97    * @param[in] enabledButtons The given set of buttons to enable
  98    * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
  99    * @return A handle to the TextSelectionPopup control.
 100    */
 101   static TextSelectionPopup New( Buttons enabledButtons,
 102                                  TextSelectionPopupCallbackInterface* callbackInterface );
 103
 104   /**
 105    * @brief Creates an empty handle.
 106    */
 107   TextSelectionPopup();
 108
 109   /**
 110    * @brief Copy constructor.
 111    *
 112    * @param[in] handle The handle to copy from.
 113    */
 114   TextSelectionPopup( const TextSelectionPopup& handle );
 115
 116   /**
 117    * @brief Assignment operator.
 118    *
 119    * @param[in] handle The handle to copy from.
 120    * @return A reference to this.
 121    */
 122   TextSelectionPopup& operator=( const TextSelectionPopup& handle );
 123
 124   /**
 125    * @brief Destructor
 126    *
 127    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 128    */
 129   ~TextSelectionPopup();
 130
 131   /**
 132    * @brief Downcast a handle to TextSelectionPopup.
 133    *
 134    * If the BaseHandle points is a TextSelectionPopup the downcast returns a valid handle.
 135    * If not the returned handle is left empty.
 136    *
 137    * @param[in] handle Handle to an object
 138    * @return handle to a TextSelectionPopup or an empty handle
 139    */
 140   static TextSelectionPopup DownCast( BaseHandle handle );
 141
 142   /**
 143    * @brief Raises the toolbar's layer above the given @e target layer.
 144    *
 145    * @param[in] target The layer to get above of.
 146    */
 147   void RaiseAbove( Layer target );
 148
 149   /**
 150    * @brief Show the Popup
 151    */
 152   void ShowPopup();
 153
 154 public: // Not intended for application developers
 155
 156   /**
 157    * @brief Creates a handle using the Toolkit::Internal implementation.
 158    *
 159    * @param[in] implementation The Control implementation.
 160    */
 161   DALI_INTERNAL TextSelectionPopup( Internal::TextSelectionPopup& implementation );
 162
 163   /**
 164    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 165    *
 166    * @param[in]  internal  A pointer to the internal CustomActor.
 167    */
 168   explicit DALI_INTERNAL TextSelectionPopup( Dali::Internal::CustomActor* internal );
 169
 170 }; // Class TextSelectionPopup
 171
 172 } // namespace Toolkit
 173
 174 } // namespace Dali
 175
 176 #endif // __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__