namespace ElmSharp
{
/// <summary>
- /// Enumeration for the popup orientation type.
+ /// Enumeration for the popup orientation types.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public enum PopupOrientation
{
/// <summary>
- /// Appears in the top of parent, default.
+ /// Appears in the top of parent, by default.
/// </summary>
Top,
/// <summary>
}
/// <summary>
- /// The Popup is a widget that is an enhancement of Notify.
+ /// The Popup is a widget that is an enhancement of notify.
/// In addition to content area, there are two optional sections, namely title area and action area.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public class Popup : Layout
{
HashSet<PopupItem> _children = new HashSet<PopupItem>();
/// <summary>
/// Creates and initializes a new instance of the Popup class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new Popup will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new popup will be attached as a child.</param>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public Popup(EvasObject parent) : base(parent)
{
_dismissed = new SmartEvent(this, "dismissed");
}
/// <summary>
- /// Dismissed will be triggered when Popup have been dismissed.
+ /// Dismissed will be triggered when the popup has been dismissed.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public event EventHandler Dismissed;
/// <summary>
/// OutsideClicked will be triggered when users taps on the outside of Popup.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public event EventHandler OutsideClicked;
/// <summary>
- /// OutsideClicked will be triggered when Popup is closed as a result of timeout.
+ /// OutsideClicked will be triggered when the popup is closed as a result of timeout.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public event EventHandler TimedOut;
/// <summary>
- /// OutsideClicked will be triggered when the Popup transition is finished in showing.
+ /// OutsideClicked will be triggered when the popup transition has finished in showing.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public event EventHandler ShowAnimationFinished;
/// <summary>
- /// Sets or gets the position in which Popup will appear in its parent.
+ /// Sets or gets the position in which the popup will appear in its parent.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public PopupOrientation Orientation
{
get
}
/// <summary>
- /// Sets or gets the wrapping type of content text packed in content area of Popup widget.
+ /// Sets or gets the wrapping type of content text packed in the content area of Popup widget.
/// </summary>
+ /// <remarks>
+ /// Popup need to wrap the content text, so not allowing WrapType.None.
+ /// </remarks>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public WrapType ContentTextWrapType
{
get
}
/// <summary>
- /// Sets or gets the timeout value set to the Popup(in seconds).
+ /// Sets or gets the timeout value set to the popup (in seconds).
/// </summary>
+ /// <remarks>
+ /// Since calling Show() on a popup restarts the timer controlling when it is hidden,
+ /// setting this before the popup is shown, will in effect mean starting the timer when the popup is shown.
+ /// TimedOut is called afterwards, which can be handled, if needed.
+ /// <![CDATA[Set a value <= 0.0 to disable a running timer. If the value is > 0.0 and the popup is previously visible,]]>
+ /// the timer will be started with this value, canceling any running timer.
+ /// </remarks>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public double Timeout
{
get
}
/// <summary>
- /// Sets or gets whether events should be passed to event blocked area by a click outside.
+ /// Sets or gets whether events should be passed to the event blocked area by a click outside.
/// </summary>
/// <remarks>
- /// The visible region of popup is surrounded by a translucent region called Blocked Event area.
+ /// The visible region of the popup is surrounded by a translucent region called the Blocked event area.
/// </remarks>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public bool AllowEvents
{
get
/// <summary>
/// Sets or gets the AlignmentX in which the popup will appear in its parent.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public override double AlignmentX
{
get
/// <summary>
/// Sets or gets the AlignmentY in which the popup will appear in its parent.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public override double AlignmentY
{
get
}
/// <summary>
- /// Gets the Opacity value set to the Popup(in seconds).
+ /// Gets the opacity value of the popup.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public override int Opacity
{
get
}
/// <summary>
- /// Adds label to a Popup widget.
+ /// Adds the label to a Popup widget.
/// </summary>
/// <param name="label"></param>
- /// <returns>The new PopupItem which contains label .</returns>
+ /// <returns>The new PopupItem which contains a label.</returns>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public PopupItem Append(string label)
{
return Append(label, null);
}
/// <summary>
- /// Adds Label and icon to a Popup widget.
+ /// Adds the Label and icon to a Popup widget.
/// </summary>
- /// <param name="label">The Label which will be added into a new PopupItem. </param>
- /// <param name="icon">The icon which will be added into a new PopupItem. </param>
- /// <returns>The new PopupItem which contains label and icon.</returns>
+ /// <param name="label">The Label, which will be added into a new PopupItem.</param>
+ /// <param name="icon">The icon, which will be added into a new PopupItem. </param>
+ /// <returns>The new PopupItem, which contains the label and icon.</returns>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public PopupItem Append(string label, EvasObject icon)
{
- PopupItem item = new PopupItem(label, icon);
+ PopupItem item = new PopupItem(label, icon, this);
item.Handle = Interop.Elementary.elm_popup_item_append(Handle, label, icon, null, (IntPtr)item.Id);
AddInternal(item);
return item;
/// <summary>
/// Uses this function to dismiss the popup in hide effect.
- /// when the Popup is dismissed, the "dismissed" signal will be emitted.
+ /// When the Popup is dismissed, the "dismissed" signal will be emitted.
/// </summary>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
public void Dismiss()
{
Interop.Elementary.elm_popup_dismiss(Handle);
}
+ /// <summary>
+ /// Creates a widget handle.
+ /// </summary>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
+ /// <since_tizen> preview </since_tizen>
+ [Obsolete("This has been deprecated in API12")]
protected override IntPtr CreateHandle(EvasObject parent)
{
return Interop.Elementary.elm_popup_add(parent.Handle);
_children.Remove((PopupItem)sender);
}
}
-}
\ No newline at end of file
+}