src/ElmSharp/ElmSharp/GenItem.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace ElmSharp
  20 {
  21     /// <summary>
  22     /// Enumeration for the selection modes of GenItem.
  23     /// </summary>
  24     /// <since_tizen> preview </since_tizen>
  25     [Obsolete("This has been deprecated in API12")]
  26     public enum GenItemSelectionMode
  27     {
  28         /// <summary>
  29         /// Default select mode.
  30         /// </summary>
  31         Default,
  32
  33         /// <summary>
  34         /// Always select mode.
  35         /// </summary>
  36         Always,
  37
  38         /// <summary>
  39         /// No select mode.
  40         /// </summary>
  41         None,
  42
  43         /// <summary>
  44         /// No select mode with no finger size rule.
  45         /// </summary>
  46         DisplayOnly
  47     }
  48
  49     /// <summary>
  50     /// It inherits <see cref="ItemObject"/>.
  51     /// A base class for <see cref="GenGridItem"/> and <see cref="GenListItem"/>.
  52     /// It contains the GenItem class and data to display the data.
  53     /// </summary>
  54     /// <since_tizen> preview </since_tizen>
  55     [Obsolete("This has been deprecated in API12")]
  56     public abstract class GenItem : ItemObject
  57     {
  58         internal Interop.Elementary.Elm_Tooltip_Item_Content_Cb _tooltipCb;
  59         GetTooltipContentDelegate _tooltipContentDelegate = null;
  60
  61         /// <summary>
  62         /// The delegate returning the tooltip contents.
  63         /// </summary>
  64         /// <since_tizen> preview </since_tizen>
  65         [Obsolete("This has been deprecated in API12")]
  66         public delegate EvasObject GetTooltipContentDelegate();
  67
  68         internal GenItem(object data, GenItemClass itemClass) : base(IntPtr.Zero)
  69         {
  70             Data = data;
  71             ItemClass = itemClass;
  72             _tooltipCb = (d, obj, tooltip, item) => { return TooltipContentDelegate(); };
  73         }
  74
  75         internal GenItem(object data, GenItemClass itemClass, EvasObject parent) : base(IntPtr.Zero, parent)
  76         {
  77             Data = data;
  78             ItemClass = itemClass;
  79             _tooltipCb = (d, obj, tooltip, item) => { return TooltipContentDelegate(); };
  80         }
  81
  82         /// <summary>
  83         /// Gets the item class that defines how to display data. It returns <see cref="GenItemClass"/> type.
  84         /// </summary>
  85         /// <since_tizen> preview </since_tizen>
  86         [Obsolete("This has been deprecated in API12")]
  87         public GenItemClass ItemClass { get; protected set; }
  88
  89         /// <summary>
  90         /// Sets or gets the tooltip content delegate.
  91         /// </summary>
  92         /// <since_tizen> preview </since_tizen>
  93         [Obsolete("This has been deprecated in API12")]
  94         public GetTooltipContentDelegate TooltipContentDelegate
  95         {
  96             get
  97             {
  98                 return _tooltipContentDelegate;
  99             }
 100             set
 101             {
 102                 _tooltipContentDelegate = value;
 103                 UpdateTooltipDelegate();
 104             }
 105         }
 106
 107         /// <summary>
 108         /// It's an abstract property.
 109         /// </summary>
 110         /// <since_tizen> preview </since_tizen>
 111         [Obsolete("This has been deprecated in API12")]
 112         public abstract GenItemSelectionMode SelectionMode { get; set; }
 113
 114         /// <summary>
 115         /// Sets or gets the cursor to be shown when the mouse is over the gengrid item.
 116         /// </summary>
 117         /// <since_tizen> preview </since_tizen>
 118         [Obsolete("This has been deprecated in API12")]
 119         public abstract string Cursor { get; set; }
 120
 121         /// <summary>
 122         /// Sets or gets the style for this item cursor.
 123         /// </summary>
 124         /// <since_tizen> preview </since_tizen>
 125         [Obsolete("This has been deprecated in API12")]
 126         public abstract string CursorStyle { get; set; }
 127
 128         /// <summary>
 129         /// Sets or gets the cursor engine only usage for this item cursor.
 130         /// </summary>
 131         /// <since_tizen> preview </since_tizen>
 132         [Obsolete("This has been deprecated in API12")]
 133         public abstract bool IsUseEngineCursor { get; set; }
 134
 135         /// <summary>
 136         /// Gets the item data that is added through calling <see cref="GenGrid.Append(GenItemClass, object)"/>, <see cref="GenGrid.Prepend(GenItemClass, object)"/>, or <see cref="GenGrid.InsertBefore(GenItemClass, object, GenGridItem)"/> methods.
 137         /// </summary>
 138         /// <since_tizen> preview </since_tizen>
 139         [Obsolete("This has been deprecated in API12")]
 140         public object Data { get; protected set; }
 141
 142         /// <summary>
 143         /// It's an abstract property. It's implemented by <see cref="GenGridItem.IsSelected"/> and <see cref="GenListItem.IsSelected"/>.
 144         /// </summary>
 145         /// <since_tizen> preview </since_tizen>
 146         [Obsolete("This has been deprecated in API12")]
 147         public abstract bool IsSelected { get; set; }
 148
 149         /// <summary>
 150         /// It's an abstract property. It's implemented by <see cref="GenGridItem.TooltipStyle"/> and <see cref="GenListItem.TooltipStyle"/>.
 151         /// </summary>
 152         /// <since_tizen> preview </since_tizen>
 153         [Obsolete("This has been deprecated in API12")]
 154         public abstract string TooltipStyle { get; set; }
 155
 156         /// <summary>
 157         /// Sets the tooltip text.
 158         /// </summary>
 159         /// <param name="tooltip">The text to set.</param>
 160         /// <since_tizen> preview </since_tizen>
 161         [Obsolete("This has been deprecated in API12")]
 162         public abstract void SetTooltipText(string tooltip);
 163
 164         /// <summary>
 165         /// Unsets the tooltip.
 166         /// </summary>
 167         /// <since_tizen> preview </since_tizen>
 168         [Obsolete("This has been deprecated in API12")]
 169         public abstract void UnsetTooltip();
 170
 171         /// <summary>
 172         /// It's an abstract method. It's implemented by <see cref="GenGridItem.Update"/> and <see cref="GenListItem.Update"/>.
 173         /// </summary>
 174         /// <since_tizen> preview </since_tizen>
 175         [Obsolete("This has been deprecated in API12")]
 176         public abstract void Update();
 177
 178         /// <summary>
 179         /// The override method for deleting the item class and item data. It's called when the item is deleted.
 180         /// </summary>
 181         /// <since_tizen> preview </since_tizen>
 182         [Obsolete("This has been deprecated in API12")]
 183         protected override void OnInvalidate()
 184         {
 185             ItemClass?.SendItemDeleted(Data);
 186             Data = null;
 187             ItemClass = null;
 188         }
 189
 190         /// <summary>
 191         /// Abstract method for updating the tooltip content.
 192         /// </summary>
 193         /// <since_tizen> preview </since_tizen>
 194         [Obsolete("This has been deprecated in API12")]
 195         protected abstract void UpdateTooltipDelegate();
 196     }
 197 }