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 namespace Internal DALI_INTERNAL
  31 {
  32 class TextSelectionPopup;
  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 TextSelectionPopup : public Control
  46 {
  47 public:
  48
  49   enum Buttons
  50   {
  51     CUT = 1u << 0,
  52     COPY = 1u << 1,
  53     PASTE = 1u << 2,
  54     SELECT = 1u << 3,
  55     SELECT_ALL = 1u << 4,
  56     CLIPBOARD = 1u << 5,
  57     NONE = 1u << 6,
  58   };
  59
  60   /**
  61    * @brief The start and end property ranges for this control.
  62    */
  63   enum PropertyRange
  64   {
  65     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  66     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  67   };
  68
  69   /**
  70    * @brief An enumeration of properties belonging to the TextSelectionPopup class.
  71    */
  72   struct Property
  73   {
  74     enum
  75     {
  76       POPUP_MAX_SIZE =  PROPERTY_START_INDEX,   ///< name "popup-max-size",                maximum size the Popup can be,                  type VECTOR2
  77       POPUP_MIN_SIZE,                           ///< name "popup-min-size",                minimum size the Popup can be,                  type VECTOR2
  78       OPTION_MAX_SIZE,                          ///< name "option-max-size",               maximum size an option can be,                  type VECTOR2
  79       OPTION_MIN_SIZE,                          ///< name "option-min-size",               minimum size an option can be,                  type VECTOR2
  80       OPTION_DIVIDER_SIZE,                      ///< name "option-divider-size",           size of the divider between options             type VECTOR2
  81       POPUP_CLIPBOARD_BUTTON_ICON_IMAGE,        ///< name "popup-clipboard-button-image",  The image to use as the popup clipboard icon,   type STRING
  82       POPUP_CUT_BUTTON_ICON_IMAGE,              ///< name "popup-cut-button-image",        The image to use as the popup cut icon,         type STRING
  83       POPUP_COPY_BUTTON_ICON_IMAGE,             ///< name "popup-copy-button-image",       The image to use as the popup copy icon,        type STRING
  84       POPUP_PASTE_BUTTON_ICON_IMAGE,            ///< name "popup-paste-button-image",      The image to use as the popup paste icon,       type STRING
  85       POPUP_SELECT_BUTTON_ICON_IMAGE,           ///< name "popup-select-button-image",     The image to use as the popup select icon,      type STRING
  86       POPUP_SELECT_ALL_BUTTON_ICON_IMAGE,       ///< name "popup-select-all-button-image", The image to use as the popup select all icon,  type STRING
  87     };
  88   };
  89
  90   /**
  91    * Create the TextSelectionPopup control.
  92    * @return A handle to the TextSelectionPopup control.
  93    */
  94   static TextSelectionPopup New();
  95
  96   /**
  97    * Create the TextSelectionPopup control with the given set of buttons.
  98    * @param[in] enabledButtons The given set of buttons to enable
  99    * @return A handle to the TextSelectionPopup control.
 100    */
 101   static TextSelectionPopup New( Buttons enabledButtons );
 102
 103   /**
 104    * @brief Creates an empty handle.
 105    */
 106   TextSelectionPopup();
 107
 108   /**
 109    * @brief Copy constructor.
 110    *
 111    * @param[in] handle The handle to copy from.
 112    */
 113   TextSelectionPopup( const TextSelectionPopup& handle );
 114
 115   /**
 116    * @brief Assignment operator.
 117    *
 118    * @param[in] handle The handle to copy from.
 119    * @return A reference to this.
 120    */
 121   TextSelectionPopup& operator=( const TextSelectionPopup& handle );
 122
 123   /**
 124    * @brief Destructor
 125    *
 126    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 127    */
 128   ~TextSelectionPopup();
 129
 130   /**
 131    * @brief Downcast a handle to TextSelectionPopup.
 132    *
 133    * If the BaseHandle points is a TextSelectionPopup the downcast returns a valid handle.
 134    * If not the returned handle is left empty.
 135    *
 136    * @param[in] handle Handle to an object
 137    * @return handle to a TextSelectionPopup or an empty handle
 138    */
 139   static TextSelectionPopup DownCast( BaseHandle handle );
 140
 141 public: // Not intended for application developers
 142
 143   /**
 144    * @brief Creates a handle using the Toolkit::Internal implementation.
 145    *
 146    * @param[in] implementation The Control implementation.
 147    */
 148   DALI_INTERNAL TextSelectionPopup( Internal::TextSelectionPopup& implementation );
 149
 150   /**
 151    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 152    *
 153    * @param[in]  internal  A pointer to the internal CustomActor.
 154    */
 155   explicit DALI_INTERNAL TextSelectionPopup( Dali::Internal::CustomActor* internal );
 156
 157 }; // Class TextSelectionPopup
 158
 159 } // namespace Toolkit
 160
 161 } // namespace Dali
 162
 163 #endif // __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__