-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// The Popup widget provides a configurable pop-up dialog with built-in layout of three main fields.
+ /// The Popup widget provides a configurable popup dialog with a built-in layout of three main fields.
/// </summary>
public class Popup : View
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Event arguments that passed via OutsideTouchedEvent
+ /// Event arguments that passed via the OutsideTouchedEvent.
/// </summary>
public class TouchedOutsideEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via ShowingEventArgs
+ /// Event arguments that passed via the ShowingEventArgs.
/// </summary>
public class ShowingEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via ShownEventArgs
+ /// Event arguments that passed via the ShownEventArgs.
/// </summary>
public class ShownEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via HidingEventArgs
+ /// Event arguments that passed via the HidingEventArgs.
/// </summary>
public class HidingEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via HiddenEventArgs
+ /// Event arguments that passed via the HiddenEventArgs.
/// </summary>
public class HiddenEventArgs : EventArgs
{
private HiddenEventCallbackDelegate _popUpHiddenEventCallbackDelegate;
/// <summary>
- /// Event is sent when user has touched outside of the Dialog.
+ /// An event is sent when the user has touched outside the dialog.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<TouchedOutsideEventArgs> TouchedOutside
{
add
}
/// <summary>
- /// Event is sent when the Popup is starting to be shown.
+ /// An event is sent when the popup starts showing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ShowingEventArgs> Showing
{
add
/// <summary>
- /// Event is sent when the Popup has been fully displayed.
+ /// An event is sent when the popup has been fully displayed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ShownEventArgs> Shown
{
add
}
/// <summary>
- /// Event is sent when the Popup is starting to be hidden.
+ /// An event is sent when the popup starts to hide.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<HidingEventArgs> Hiding
{
add
}
/// <summary>
- /// Event is sent when the Popup has been completely hidden.
+ /// An event is sent when the popup has been completely hidden.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<HiddenEventArgs> Hidden
{
add
}
/// <summary>
- /// Create the Popup.
+ /// Creates the popup.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Popup() : this(NDalicPINVOKE.Popup_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[Obsolete("Please do not use! this will be deprecated")]
public new static Popup DownCast(BaseHandle handle)
{
}
/// <summary>
- /// Sets a title for this Popup.
+ /// Sets the title for this popup.
/// </summary>
- /// <param name="titleView">The actor to set a title</param>
+ /// <param name="titleView">The actor to set the title.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetTitle(View titleView)
{
NDalicPINVOKE.Popup_SetTitle(swigCPtr, View.getCPtr(titleView));
/// <summary>
/// Sets the content actor.
/// </summary>
- /// <param name="content">The actor to use</param>
+ /// <param name="content">The actor to use.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetContent(View content)
{
NDalicPINVOKE.Popup_SetContent(swigCPtr, View.getCPtr(content));
}
/// <summary>
- /// Sets the actor to use for a footer in this Popup.
+ /// Sets the actor to use for the footer in this popup.
/// </summary>
- /// <param name="footer">The footer actor to be added to this Popup</param>
+ /// <param name="footer">The footer actor to be added to this popup.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFooter(View footer)
{
NDalicPINVOKE.Popup_SetFooter(swigCPtr, View.getCPtr(footer));
}
/// <summary>
- /// Sets the display state of Popup.<br>
- /// There are 4 total display states.<br>
- /// Only 2 can be set, but all four can be read for better inspection of the current popup state.<br>
- /// <br>
- /// The other two states are getable, but not setable and are there for consistency.<br>
- /// <br>
- /// | Value | Setting the state | Getting the state |<br>
- /// |----------|--------------------------------|--------------------------------|<br>
- /// | SHOWN | Show the popup | The popup is fully shown |<br>
- /// | HIDDEN | Hide the popup | The popup is fully hidden |<br>
- /// | SHOWING | | The popup is transitioning in |<br>
- /// | HIDING | | The popup is transitioning out |<br>
- /// <br>
- /// All 4 state changes cause notifications via 4 respective signals that can be connected to.<br>
+ /// Sets the display state of popup.<br />
+ /// There are 4 total display states.<br />
+ /// Only 2 can be set, but all four can be read for better inspection of the current popup state.<br />
+ /// <br />
+ /// The other two states are getable, but not setable, and are there for consistency.<br />
+ /// <br />
+ /// | Value | Setting the state | Getting the state |<br />
+ /// |----------|--------------------------------|--------------------------------|<br />
+ /// | SHOWN | Show the popup | The popup is fully shown |<br />
+ /// | HIDDEN | Hide the popup | The popup is fully hidden |<br />
+ /// | SHOWING | | The popup is transitioning in |<br />
+ /// | HIDING | | The popup is transitioning out |<br />
+ /// <br />
+ /// All 4 states changes cause notifications via 4 respective signals that can be connected to.<br />
/// </summary>
- /// <param name="displayState">The desired display state to change to</param>
+ /// <param name="displayState">The desired display state to change to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetDisplayState(Popup.DisplayStateType displayState)
{
NDalicPINVOKE.Popup_SetDisplayState(swigCPtr, (int)displayState);
}
/// <summary>
- /// The display states of the Popup.
+ /// The display states of the popup.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DisplayStateType
{
+ /// <summary>
+ /// The popup is transitioning in
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Showing,
+ /// <summary>
+ /// The popup is fully shown
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Shown,
+ /// <summary>
+ /// The popup is transitioning out
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Hiding,
+ /// <summary>
+ /// The popup is fully hidden
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Hidden
}
/// <summary>
- /// The animation mode within popup.<br>
- /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties.<br>
+ /// The animation modes within the popup.<br />
+ /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum AnimationModeType
{
+ /// <summary>
+ /// No animation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
+ /// <summary>
+ /// Popup zooms in and out animating the scale property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Zoom,
+ /// <summary>
+ /// Popup fades in and out
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fade,
+ /// <summary>
+ /// Use the EntryAnimation and ExitAnimation animation properties.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Custom
}
/// <summary>
- /// Types of contextual layout.<br>
- /// The Popup is positioned adjacent to it's parent in the direction specified by this mode.<br>
- /// NON_CONTEXTUAL disables any contextual positioning.<br>
+ /// The types of the contextual layout.<br />
+ /// The popup is positioned adjacent to it's parent in the direction specified by this mode.<br />
+ /// NON_CONTEXTUAL disables any contextual positioning.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ContextualModeType
{
+ /// <summary>
+ /// any contextual positioning
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NonContextual,
+ /// <summary>
+ /// Above
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Above,
+ /// <summary>
+ /// Rright
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Rright,
+ /// <summary>
+ /// Below
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Below,
+ /// <summary>
+ /// Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Left
}
/// <summary>
- /// Popup title.
+ /// The popup title.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Title
{
get
}
}
/// <summary>
- /// Popup content.
+ /// The popup content.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Content
{
get
}
}
/// <summary>
- /// Popup footer.
+ /// The popup footer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Footer
{
get
}
}
/// <summary>
- /// Popup display state.
+ /// The popup display state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public DisplayStateType DisplayState
{
get
}
}
/// <summary>
- /// Touch transparent.
+ /// The touch transparent.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool TouchTransparent
{
get
}
}
/// <summary>
- /// Popup tail visibility.
+ /// The popup tail visibility.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool TailVisibility
{
get
}
}
/// <summary>
- /// Popup tail position.
+ /// The popup tail position.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 TailPosition
{
get
}
}
/// <summary>
- /// Contextual mode.
+ /// The contextual mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ContextualModeType ContextualMode
{
get
}
}
/// <summary>
- /// Animation duration.
+ /// The animation duration.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float AnimationDuration
{
get
}
}
/// <summary>
- /// Animation mode.
+ /// The animation mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AnimationModeType AnimationMode
{
get
}
}
/// <summary>
- /// Entry animation.
+ /// The entry animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap EntryAnimation
{
get
}
}
/// <summary>
- /// Exit animation.
+ /// The exit animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap ExitAnimation
{
get
}
}
/// <summary>
- /// Auto hide delay.
+ /// The auto hide delay.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int AutoHideDelay
{
get
}
}
/// <summary>
- /// Backing enabled.
+ /// The backing enabled.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BackingEnabled
{
get
}
}
/// <summary>
- /// Backing color.
+ /// The backing color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 BackingColor
{
get
}
}
/// <summary>
- /// Background image.
+ /// The background image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PopupBackgroundImage
{
get
}
}
/// <summary>
- /// Background border.
+ /// The background border.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle PopupBackgroundBorder
{
get
}
}
/// <summary>
- /// Tail up image.
+ /// The tail up image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailUpImage
{
get
}
}
/// <summary>
- /// Tail down image.
+ /// The tail down image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailDownImage
{
get
}
}
/// <summary>
- /// Tail left image.
+ /// The tail left image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailLeftImage
{
get
}
}
/// <summary>
- /// Tail right image.
+ /// The tail right image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailRightImage
{
get
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff