public interface IAccessibleRelation
{
+ /// <summary>
+ /// Gets or sets the target object.
+ /// </summary>
AccessibleObject Target { get; set; }
+
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
int Type { get; }
}
namespace ElmSharp
{
+ /// <summary>
+ /// The AnimatorMotionMapper interface
+ /// </summary>
public interface AnimatorMotionMapper
{
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
double Caculate(double position);
}
+ /// <summary>
+ /// The LinearMotionMapper class
+ /// </summary>
public class LinearMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Linear, 0, 0);
}
}
+ /// <summary>
+ /// The AccelerateMotionMapper class
+ /// </summary>
public class AccelerateMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Accelerate, 0, 0);
}
}
+ /// <summary>
+ /// The DecelerateMotionMapper class
+ /// </summary>
public class DecelerateMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Decelerate, 0, 0);
}
}
+ /// <summary>
+ /// The SinusoidalMotionMapper class
+ /// </summary>
public class SinusoidalMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Sinusoidal, 0, 0);
}
}
+ /// <summary>
+ /// The AccelerateFactorMotionMapper class
+ /// </summary>
public class AccelerateFactorMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The power factor of AccelerateFactorMotionMapper
+ /// </summary>
public double PowerFactor { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.AccelerateFactor, PowerFactor, 0);
}
}
+ /// <summary>
+ /// The DecelerateFactorMotionMapper class
+ /// </summary>
public class DecelerateFactorMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The power factor of DecelerateFactorMotionMapper
+ /// </summary>
public double PowerFactor { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.DecelerateFactor, PowerFactor, 0);
}
}
+ /// <summary>
+ /// The SinusoidalFactorMotionMapper class
+ /// </summary>
public class SinusoidalFactorMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The power factor of SinusoidalFactorMotionMapper
+ /// </summary>
public double PowerFactor { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.SinusoidalFactor, PowerFactor, 0);
}
}
+ /// <summary>
+ /// The DivisorInterpolatedMotionMapper class
+ /// </summary>
public class DivisorInterpolatedMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The Divisor of DivisorInterpolatedMotionMapper
+ /// </summary>
public double Divisor { get; set; } = 0;
+
+ /// <summary>
+ /// The power of DivisorInterpolatedMotionMapper
+ /// </summary>
public double Power { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.DivisorInterp, Divisor, Power);
}
}
+ /// <summary>
+ /// The BounceMotionMapper class
+ /// </summary>
public class BounceMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The bounces of BounceMotionMapper
+ /// </summary>
public int Bounces { get; set; } = 0;
+
+ /// <summary>
+ /// The decay factor of BounceMotionMapper
+ /// </summary>
public double DecayFactor { get; set; } = 0;
+
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Bounce, DecayFactor, Bounces);
}
}
+ /// <summary>
+ /// The SpringMotionMapper class
+ /// </summary>
public class SpringMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The wobbles of SpringMotionMapper
+ /// </summary>
public int Wobbles { get; set; } = 0;
+
+ /// <summary>
+ /// The decat factir of SpringMotionMapper
+ /// </summary>
public double DecayFactor { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Bounce, DecayFactor, Wobbles);
}
}
+ /// <summary>
+ /// The CubicBezierMotionMapper class
+ /// </summary>
public class CubicBezierMotionMapper : AnimatorMotionMapper
{
+ /// <summary>
+ /// The X1 of CubicBezierMotionMapper
+ /// </summary>
public double X1 { get; set; } = 0;
+
+ /// <summary>
+ /// The Y1 of CubicBezierMotionMapper
+ /// </summary>
public double Y1 { get; set; } = 0;
+
+ /// <summary>
+ /// The X2 of CubicBezierMotionMapper
+ /// </summary>
public double X2 { get; set; } = 0;
+
+ /// <summary>
+ /// The Y2 of CubicBezierMotionMapper
+ /// </summary>
public double Y2 { get; set; } = 0;
+ /// <summary>
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// </summary>
public double Caculate(double position)
{
double[] values = { X1, Y1, X2, Y2 };
}
}
+ /// <summary>
+ /// Delete the object color class.
+ /// </summary>
+ /// <param name="part">The color class to be deleted.</param>
[Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")]
public void DeleteColorClass(string part)
{
{
var tm = new Interop.Libc.SystemTime();
Interop.Elementary.elm_calendar_displayed_time_get(RealHandle, out tm);
- ///TODO
- ///If the defect is fixed, it will be removed.
+ // TODO
+ // If the defect is fixed, it will be removed.
var daysInMonth = DateTime.DaysInMonth(tm.tm_year + 1900, tm.tm_mon + 1);
var day = tm.tm_mday;
/// </summary>
/// <remarks>
/// The usage should be like this;
- /// List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };
+ /// <![CDATA[List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };]]>
/// Calendar.WeekDayNames = weekDayNames;
/// </remarks>
public IReadOnlyList<string> WeekDayNames
/// With RGBA parameters.
/// </summary>
/// <param name="r">Red of RGBA</param>
- /// <param name="g">Green of RGBA<</param>
- /// <param name="b">Blue of RGBA<</param>
- /// <param name="a">Alpha of RGBA<</param>
+ /// <param name="g">Green of RGBA</param>
+ /// <param name="b">Blue of RGBA</param>
+ /// <param name="a">Alpha of RGBA</param>
public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb)
{
}
}
}
+ /// <summary>
+ /// Returns the hash code for this instance.
+ /// </summary>
+ /// <returns>A 32-bit signed integer hash code.</returns>
public override int GetHashCode()
{
int hashcode = _r.GetHashCode();
return hashcode;
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
if (obj is Color)
return color1._r == color2._r && color1._g == color2._g && color1._b == color2._b && color1._a == color2._a;
}
+ /// <summary>
+ /// Returns the fully qualified type name of this instance.
+ /// </summary>
+ /// <returns>The fully qualified type name.</returns>
public override string ToString()
{
return string.Format(CultureInfo.InvariantCulture, "[Color: R={0}, G={1}, B={2}, A={3}]", R, G, B, A);
/// <summary>
/// The check is a widget that can be used in elementary apps
/// to account for space taken up by the indicator,
- /// virtual keypad & softkey windows when running the illume2 module of E17.
+ /// virtual keypad & softkey windows when running the illume2 module of E17.
/// </summary>
public class Conformant : Widget
{
}
}
+ /// <summary>
+ /// Gets the collection of child EvasObject of the Container.
+ /// </summary>
protected IEnumerable<EvasObject> Children => _children;
+ /// <summary>
+ /// Add an EvasObject object as a child of Container.
+ /// </summary>
+ /// <param name="obj">The EvasObject object to be added</param>
protected void AddChild(EvasObject obj)
{
_children.Add(obj);
obj.Deleted += OnChildDeleted;
}
+ /// <summary>
+ /// Remove an EvasObject object as a child of Container.
+ /// </summary>
+ /// <param name="obj">The EvasObject object to be removed</param>
protected void RemoveChild(EvasObject obj)
{
_children.Remove(obj);
}
+ /// <summary>
+ /// Clear all children of the Container.
+ /// </summary>
protected void ClearChildren()
{
_children.Clear();
}
+ /// <summary>
+ /// The Container Callback that is invoked when a child is removed.
+ /// </summary>
+ /// <param name="sender">The called Container</param>
+ /// <param name="a"><see cref="EventArgs"/></param>
void OnChildDeleted(object sender, EventArgs a)
{
_children.Remove((EvasObject)sender);
/// </summary>
public enum DateTimeFieldType
{
+ /// <summary>
+ /// Indicates Year field.
+ /// </summary>
Year,
+ /// <summary>
+ /// Indicates Month field.
+ /// </summary>
Month,
+ /// <summary>
+ /// Indicates Date field.
+ /// </summary>
Date,
+ /// <summary>
+ /// Indicates Hour field.
+ /// </summary>
Hour,
+ /// <summary>
+ /// Indicates Minute field.
+ /// </summary>
Minute,
+ /// <summary>
+ /// Indicates AM/PM field.
+ /// </summary>
AmPm
}
/// <summary>
/// It inherits <see cref="Layout"/>
- /// DateTimeSelector is a widget to display and input date & time values.
+ /// DateTimeSelector is a widget to display and input date & time values.
/// This widget displays date and time as per the system's locale settings
- /// (Date includes Day, Month & Year along with the defined separators and Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored.
+ /// (Date includes Day, Month & Year along with the defined separators and Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored.
/// </summary>
public class DateTimeSelector : Layout
{
/// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
public class EcoreEvent<TEventArgs> : IDisposable where TEventArgs : EventArgs
{
+ /// <summary>
+ /// EventInfoParser delegate of EcoreEvent class
+ /// </summary>
+ /// <param name="data">IntPtr</param>
+ /// <param name="type">EcoreEventType</param>
+ /// <param name="info">IntPtr</param>
+ /// <returns></returns>
public delegate TEventArgs EventInfoParser(IntPtr data, EcoreEventType type, IntPtr info);
private bool _disposed = false;
_parser = parser;
}
+ /// <summary>
+ /// Destructor for EcoreEvent class.
+ /// </summary>
~EcoreEvent()
{
Dispose(false);
}
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
}
}
+ /// <summary>
+ /// Destroy current object
+ /// </summary>
public void Dispose()
{
Dispose(true);
-using System;
-using System.Collections.Generic;
-using System.Text;
+/*
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * 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.
+ */
+
+using System;
namespace ElmSharp
{
+ /// <summary>
+ /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations.
+ /// </summary>
public class EcoreTimelineAnimator
{
double _runtime;
Interop.Ecore.EcoreTimelineCallback _nativeCallback;
double _position;
+ /// <summary>
+ /// It occurs when the animator is complete.
+ /// </summary>
public event EventHandler Finished;
-
+ /// <summary>
+ /// Creates and initializes a new instance of the EcoreTimelineAnimator class.
+ /// </summary>
+ /// <param name="runtime">The time to run in seconds</param>
+ /// <param name="timelineCallback">Functions called at each time line</param>
public EcoreTimelineAnimator(double runtime, Action timelineCallback)
{
_runtime = runtime;
_position = 0;
}
+ /// <summary>
+ /// Gets whether the animation is running.
+ /// </summary>
public bool IsRunning { get; private set; }
+
+ /// <summary>
+ /// Gets the current position of the animation.
+ /// </summary>
public double Position => _position;
+ /// <summary>
+ /// Starts an animator that runs for a limited time.for a limited time.
+ /// </summary>
public void Start()
{
IsRunning = true;
_animator = Interop.Ecore.ecore_animator_timeline_add(_runtime, _nativeCallback, IntPtr.Zero);
}
+ /// <summary>
+ /// Stops an animator that running.
+ /// </summary>
public void Stop()
{
IsRunning = false;
_animator = IntPtr.Zero;
}
+ /// <summary>
+ /// Suspends the specified animator.
+ /// </summary>
public void Freeze()
{
Interop.Ecore.ecore_animator_freeze(_animator);
}
+ /// <summary>
+ /// Restores execution of the specified animator.
+ /// </summary>
public void Thaw()
{
Interop.Ecore.ecore_animator_thaw(_animator);
}
+ /// <summary>
+ /// Callback that is called when ticks off
+ /// </summary>
protected void OnTimeline()
{
_timelineCallback();
Action = action;
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
SignalData s = obj as SignalData;
/// Directly show the focused region or item automatically
/// </summary>
Show,
+
/// <summary>
/// Do not show the focused region or item automatically
/// </summary>
None,
+
/// <summary>
/// Bring in the focused region or item automatically which might invole the scrolling
/// </summary>
Interop.Elementary.elm_run();
}
+ /// <summary>
+ /// Prepends a theme overlay to the list of overlays
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static void ThemeOverlay()
{
Interop.Elementary.elm_theme_extension_del(IntPtr.Zero, item);
}
+ /// <summary>
+ /// Gets the amount of inertia a scroller imposes during region bring animations.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static double GetSystemScrollFriction()
{
return BringInScrollFriction;
}
+ /// <summary>
+ /// Sets the amount of inertia a scroller imposes during region bring animations.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static void SetSystemScrollFriction(double timeSet)
+
{
BringInScrollFriction = timeSet;
}
+ /// <summary>
+ /// Get Elementary's profile in use
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static string GetProfile()
{
return Interop.Elementary.elm_config_profile_get();
}
+ /// <summary>
+ /// Set the global scaling factor
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static void SetScale(double scale)
{
Scale = scale;
}
+ /// <summary>
+ /// Get the global scaling factor
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static double GetScale()
{
return Interop.Elementary.elm_policy_set(policy, value);
}
+ /// <summary>
+ /// Reload Elementary's configuration, bounded to current selected profile.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static void ReloadConfig()
{
/// </summary>
public static class ElmScrollConfig
{
+ /// <summary>
+ /// Gets or sets the amount of inertia a scroller imposes during region bring animations.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static double BringInScrollFriction
{
}
/// <summary>
- /// Enumeration that defines the entry's copy & paste policy.
+ /// Enumeration that defines the entry's copy and paste policy.
/// </summary>
public enum CopyAndPasteMode
{
/// <summary>
- /// Copy & paste text with markup tag
+ /// Copy and paste text with markup tag
/// </summary>
Markup,
/// <summary>
- /// Copy & paste text without item(image) tag
+ /// Copy and paste text without item(image) tag
/// </summary>
NoImage,
/// <summary>
- /// Copy & paste text without markup tag
+ /// Copy and paste text without markup tag
/// </summary>
PlainText
}
/// <summary>
/// Creates an Evas canvas handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
+ /// <param name="evasObject">EvasObject</param>
/// <returns>Handle IntPtr</returns>
IntPtr CreateHandle(IntPtr evasObject)
{
Action = action;
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
EventData e = obj as EventData;
-using System;
+using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
set
{
Interop.Evas.evas_object_image_alpha_set(RealHandle, !value);
-
}
}
return result;
}
+ /// <summary>
+ /// Set the native surface of a given image of the canvas
+ /// </summary>
+ /// <param name="surface">The surface.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetNativeSurface(IntPtr surface)
{
return _handle != IntPtr.Zero ? _handle : Interop.Evas.evas_object_image_add(Interop.Evas.evas_object_evas_get(parent.Handle));
}
}
-}
+}
\ No newline at end of file
-/*
+/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
/// BackButton name in Platform
/// </summary>
public const string PlatformBackButtonName = "XF86Back";
+
/// <summary>
/// MenuButton name in Platform
/// </summary>
public const string PlatformMenuButtonName = "XF86Menu";
+
/// <summary>
/// HomeButton name in Platform
/// </summary>
/// </summary>
public string KeyName { get; private set; }
+ /// <summary>
+ /// Sets or gets the flags.
+ /// </summary>
public EvasEventFlag Flags
{
get
/// Name string of the key pressed
/// </summary>
public string keyname;
+
/// <summary>
/// Data to be passed to the event
/// </summary>
public IntPtr data;
+
/// <summary>
/// Modifier keys pressed during the event
/// </summary>
public IntPtr modifiers;
+
/// <summary>
/// Locks info
/// </summary>
public IntPtr locks;
+
/// <summary>
/// Logical key: (example, shift+1 == exclamation)
/// </summary>
public string key;
+
/// <summary>
/// UTF8 string if this keystroke has produced a visible string to be ADDED
/// </summary>
public string str;
+
/// <summary>
/// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
/// </summary>
/// Event_flags
/// </summary>
public EvasEventFlag event_flags;
+
/// <summary>
///
/// </summary>
public IntPtr dev;
+
/// <summary>
/// Keycode
/// </summary>
/// No fancy flags set
/// </summary>
None = 0,
+
/// <summary>
///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything
/// </summary>
OnHold = 1,
}
-
-}
+}
\ No newline at end of file
_ownership = false;
}
+ /// <summary>
+ /// Destructor for the EvasMap class.
+ /// </summary>
~EvasMap()
{
if (_ownership)
Interop.Evas.evas_map_util_zoom(_evasMap, x, y, cx, cy);
}
}
-}
+}
\ No newline at end of file
namespace ElmSharp
{
+ /// <summary>
+ /// Enumeration for tooltip orientation.
+ /// </summary>
public enum TooltipOrientation
{
+ /// <summary>
+ /// Default value, Tooltip moves with mouse pointer.
+ /// </summary>
None,
+
+ /// <summary>
+ /// Tooltip should appear at the top left of parent.
+ /// </summary>
TopLeft,
+
+ /// <summary>
+ /// Tooltip should appear at the left of parent.
+ /// </summary>
Top,
+
+ /// <summary>
+ /// Tooltip should appear at the top right of parent.
+ /// </summary>
TopRight,
+
+ /// <summary>
+ /// Tooltip should appear at the left of parent.
+ /// </summary>
Left,
+
+ /// <summary>
+ /// Tooltip should appear at the center of parent.
+ /// </summary>
Center,
+
+ /// <summary>
+ /// Tooltip should appear at the right of parent.
+ /// </summary>
Right,
+
+ /// <summary>
+ /// Tooltip should appear at the bottom left of parent.
+ /// </summary>
BottomLeft,
+
+ /// <summary>
+ /// Tooltip should appear at the bottom of parent.
+ /// </summary>
Bottom,
+
+ /// <summary>
+ /// Tooltip should appear at the bottom right of parent.
+ /// </summary>
BottomRight,
}
+ /// <summary>
+ /// Enumeration for aspect control.
+ /// </summary>
public enum AspectControl
{
- None = 0, /* Preference on scaling unset */
- Neither = 1, /* Same effect as unset preference on scaling */
- Horizontal = 2, /* Use all horizontal container space to place an object, using the given aspect */
- Vertical = 3, /* Use all vertical container space to place an object, using the given aspect */
- Both = 4 /* Use all horizontal @b and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect */
+ /// <summary>
+ /// Preference on scaling unset.
+ /// </summary>
+ None = 0,
+
+ /// <summary>
+ /// Same effect as unset preference on scaling.
+ /// </summary>
+ Neither = 1,
+
+ /// <summary>
+ /// Use all horizontal container space to place an object, using the given aspect
+ /// </summary>
+ Horizontal = 2,
+
+ /// <summary>
+ /// Use all vertical container space to place an object, using the given aspect.
+ /// </summary>
+ Vertical = 3,
+
+ /// <summary>
+ /// Use all horizontal @b and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect.
+ /// </summary>
+ Both = 4
}
/// <summary>
private Interop.Eext.EextEventCallback _backButtonHandler;
private Interop.Eext.EextEventCallback _moreButtonHandler;
+ /// <summary>
+ /// Sets or gets the handle for EvasObject.
+ /// </summary>
public IntPtr Handle { get; protected set; }
+
+ /// <summary>
+ /// Gets the parent object for EvasObject.
+ /// </summary>
public EvasObject Parent { get; private set; }
+ /// <summary>
+ /// Sets or gets the real handle for EvasObject.
+ /// </summary>
public IntPtr RealHandle
{
get
_eventStore.Add(item);
}
}
-}
+}
\ No newline at end of file
/// </summary>
public interface IInvalidatable : IDisposable
{
+ /// <summary>
+ /// Make current instance invalidate
+ /// </summary>
void MakeInvalidate();
}
{
}
+ /// <summary>
+ /// Creates and initializes a new instance of the EvasObjectEvent.
+ /// </summary>
+ /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="handle">EvasObject handle</param>
+ /// <param name="type">EvasObjectCallbackType</param>
+ /// <param name="parser">SmartEventInfoParser</param>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type, SmartEventInfoParser parser)
{
{
}
+ /// <summary>
+ /// Destroy the EvasObjectEvent object.
+ /// </summary>
~EvasObjectEvent()
{
Dispose(false);
}
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
}
/// <summary>
- /// Destroy Current Obj
+ /// Destroy current object
/// </summary>
public void Dispose()
{
{
}
+ /// <summary>
+ /// Creates and initializes a new instance of the EvasObjectEvent.
+ /// </summary>
+ /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="handle">EvasObject handle</param>
+ /// <param name="type">EvasObjectCallbackType</param>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type)
{
_evasObjectEvent = new EvasObjectEvent<EventArgs>(sender, handle, type, null);
}
+ /// <summary>
+ /// Destroy the EvasObjectEvent object.
+ /// </summary>
~EvasObjectEvent()
{
Dispose(false);
_handlers?.Invoke(sender, e);
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
}
/// <summary>
- /// Destroy Current Obj
+ /// Destroy current object
/// </summary>
public void Dispose()
{
}
}
+ /// <summary>
+ /// Sets or gets the cursor to be shown when mouse is over the gengrid item.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override string Cursor
{
}
}
+ /// <summary>
+ /// Sets or gets the style for this item cursor.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override string CursorStyle
{
}
}
+ /// <summary>
+ /// Sets or gets the cursor engine only usage for this item cursor.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool IsUseEngineCursor
{
}
/// <summary>
- /// Gets or sets the style of given gengrid item's tooltip.
+ /// Sets or gets or sets the style of given gengrid item's tooltip.
/// </summary>
public override string TooltipStyle
{
}
}
+ /// <summary>
+ /// Get the gengrid item's select mode.
+ /// </summary>
public override GenItemSelectionMode SelectionMode
{
get
}
}
+ /// <summary>
+ /// Set the text to be shown in the gengrid item.
+ /// </summary>
+ /// <param name="tooltip">The text to set.</param>
public override void SetTooltipText(string tooltip)
{
Interop.Elementary.elm_gengrid_item_tooltip_text_set(Handle, tooltip);
}
+ /// <summary>
+ /// Unset tooltip from item.
+ /// </summary>
public override void UnsetTooltip()
{
Interop.Elementary.elm_gengrid_item_tooltip_unset(Handle);
Interop.Elementary.elm_gengrid_item_update(Handle);
}
+ /// <summary>
+ /// Set the content to be shown in the tooltip item.
+ /// </summary>
protected override void UpdateTooltipDelegate()
{
Interop.Elementary.elm_gengrid_item_tooltip_content_cb_set(Handle,
/// </summary>
public GenItemClass ItemClass { get; protected set; }
+ /// <summary>
+ /// Sets or gets tooltip content delegate.
+ /// </summary>
public GetTooltipContentDelegate TooltipContentDelegate
{
get
/// </summary>
public abstract GenItemSelectionMode SelectionMode { get; set; }
+ /// <summary>
+ /// Sets or gets the cursor to be shown when mouse is over the gengrid item
+ /// </summary>
public abstract string Cursor { get; set; }
+
+ /// <summary>
+ /// Sets or gets the style for this item cursor.
+ /// </summary>
public abstract string CursorStyle { get; set; }
+ /// <summary>
+ /// Sets or gets the cursor engine only usage for this item cursor.
+ /// </summary>
public abstract bool IsUseEngineCursor { get; set; }
/// <summary>
/// </summary>
public abstract string TooltipStyle { get; set; }
+ /// <summary>
+ /// Set tooltip text.
+ /// </summary>
+ /// <param name="tooltip">The text to set.</param>
public abstract void SetTooltipText(string tooltip);
+
+ /// <summary>
+ /// Unset tooltip.
+ /// </summary>
public abstract void UnsetTooltip();
/// <summary>
ItemClass = null;
}
+ /// <summary>
+ /// Abstract method for updating tooltip content.
+ /// </summary>
protected abstract void UpdateTooltipDelegate();
}
-}
+}
\ No newline at end of file
ReleaseItemClass(unmanaged);
}
+ /// <summary>
+ /// Destroy the GenItemClass object.
+ /// </summary>
~GenItemClass()
{
Dispose(false);
}
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (_unmanagedPtr != IntPtr.Zero)
}
}
+ /// <summary>
+ /// Destroy current object
+ /// </summary>
public void Dispose()
{
Dispose(true);
DeleteHandler?.Invoke(data);
}
+ /// <summary>
+ /// Create a new genlist item class in a given genlist widget.
+ /// </summary>
+ /// <returns>The new item class object.</returns>
protected virtual IntPtr CreateItemClass()
{
return Interop.Elementary.elm_genlist_item_class_new();
}
+ /// <summary>
+ /// Remove an item class in a given genlist widget.
+ /// </summary>
+ /// <param name="unmanagedPtr">The object to be removed.</param>
protected virtual void ReleaseItemClass(IntPtr unmanagedPtr)
{
Interop.Elementary.elm_genlist_item_class_free(unmanagedPtr);
}
}
+ /// <summary>
+ /// It represents the GenGrid item class definition field details.
+ /// </summary>
public class GenGridItemClass : GenItemClass
{
+ /// <summary>
+ /// Create the GenGridItemClass instance.
+ /// </summary>
+ /// <param name="style">The item display style.</param>
public GenGridItemClass(string style) : base(style)
{
}
+ /// <summary>
+ /// Add a new gengrid item class in a given gengrid widget.
+ /// </summary>
+ /// <returns>The new instance.</returns>
protected override IntPtr CreateItemClass()
{
return Interop.Elementary.elm_gengrid_item_class_new();
}
+ /// <summary>
+ /// Remove an item class in a given gengrid widget.
+ /// </summary>
+ /// <param name="unmanagedPtr">The object to be removed.</param>
protected override void ReleaseItemClass(IntPtr unmanagedPtr)
{
Interop.Elementary.elm_gengrid_item_class_free(unmanagedPtr);
}
}
+ /// <summary>
+ /// Sets or gets the content to be shown in the tooltip item
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override string Cursor
{
}
}
+ /// <summary>
+ /// Sets or gets the style for this item cursor.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override string CursorStyle
{
}
}
+ /// <summary>
+ /// Sets or gets the cursor engine only usage for this item cursor.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool IsUseEngineCursor
{
}
}
+ /// <summary>
+ /// Set the text to be shown in the genlist item.
+ /// </summary>
+ /// <param name="tooltip">The text to set in the content.</param>
public override void SetTooltipText(string tooltip)
{
Interop.Elementary.elm_genlist_item_tooltip_text_set(Handle, tooltip);
}
+ /// <summary>
+ /// Unset tooltip from item.
+ /// </summary>
public override void UnsetTooltip()
{
Interop.Elementary.elm_genlist_item_tooltip_unset(Handle);
Interop.Elementary.elm_genlist_item_item_class_update((IntPtr)Handle, itemClass.UnmanagedPtr);
}
+ /// <summary>
+ /// Set the content to be shown in the tooltip item.
+ /// </summary>
protected override void UpdateTooltipDelegate()
{
Interop.Elementary.elm_genlist_item_tooltip_content_cb_set(Handle,
null);
}
}
-}
+}
\ No newline at end of file
/// </summary>
public interface IAccessibleObject
{
+ /// <summary>
+ /// Gets or sets the reading information types of an accessible object.
+ /// </summary>
ReadingInfoType ReadingInfoType { get; set; }
+
+ /// <summary>
+ /// Gets or sets the role of the object in accessibility domain.
+ /// </summary>
AccessRole Role { get; set; }
+
+ /// <summary>
+ /// Gets or sets highlightable of given widget.
+ /// </summary>
bool CanHighlight { get; set; }
+
+ /// <summary>
+ /// Gets or sets the translation domain of "name" and "description" properties.
+ /// Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties.
+ /// When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter.
+ /// It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled.
+ /// </summary>
string TranslationDomain { get; set; }
+
+ /// <summary>
+ /// Gets or sets an accessible name of the object.
+ /// </summary>
string Name { get; set; }
+
+ /// <summary>
+ /// Gets or sets contextual information about object.
+ /// </summary>
string Description { get; set; }
+
+ /// <summary>
+ /// Gets or sets the delegate for <see cref="IAccessibleObject.Name"/>.
+ /// </summary>
AccessibleInfoProvider NameProvider { get; set; }
+
+ /// <summary>
+ /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
+ /// </summary>
AccessibleInfoProvider DescriptionProvider { get; set; }
+
+ /// <summary>
+ /// Defines the relationship between two accessible objects.
+ /// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.
+ /// AppendRelation API is asymmetric, which means that appending, for example, relation <see cref="FlowsTo"/> from object A to B, do not append relation <see cref="FlowsFrom"/> from object B to object A.
+ /// </summary>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
void AppendRelation(IAccessibleRelation relation);
+
+ /// <summary>
+ /// Removes the relationship between two accessible objects.
+ /// </summary>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
void RemoveRelation(IAccessibleRelation relation);
+
+ /// <summary>
+ /// Highlights accessible widget.
+ /// </summary>
void Highlight();
+
+ /// <summary>
+ /// Clears highlight of accessible widget.
+ /// </summary>
void Unhighlight();
}
}
Func = func;
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
SignalData s = obj as SignalData;
/// <summary>
/// Creates and initializes a new instance of ItemEvasObject class.
/// </summary>
- /// <param name="handle">IntPtr</param>
+ /// <param name="parent">IntPtr</param>
public ItemEvasObject(IntPtr parent) : base()
{
_parent = parent;
/// </summary>
public int Y;
+ /// <summary>
+ /// A human-readable representation of the <see cref="T:Tizen.UI.Point" />.
+ /// </summary>
+ /// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
public override string ToString()
{
return string.Format("{{X={0} Y={1}}}", X, Y);
}
+ /// <summary>
+ /// Gets hash code.
+ /// </summary>
+ /// <returns>The hash code.</returns>
public override int GetHashCode()
{
unchecked
}
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
if (!(obj is Point))
return Equals((Point)obj);
}
+ /// <summary>
+ /// Indicates whether this instance and a <see cref="Point"/> object are equal.
+ /// </summary>
+ /// <param name="other">The <see cref="Point"/> to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public bool Equals(Point other)
{
return X.Equals(other.X) && Y.Equals(other.Y);
return !p1.Equals(p2);
}
}
-}
+}
\ No newline at end of file
/// </summary>
public int Z;
+ /// <summary>
+ /// A human-readable representation of the <see cref="T:Tizen.UI.Point3D" />.
+ /// </summary>
+ /// <returns>The string is formatted as "{{X={0} Y={1} Z={2}}}".</returns>
public override string ToString()
{
return string.Format("{{X={0} Y={1} Z={2}}}", X, Y, Z);
}
+ ///
public override int GetHashCode()
{
unchecked
}
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
if (!(obj is Point3D))
return Equals((Point3D)obj);
}
+ /// <summary>
+ /// Indicates whether this instance and a <see cref="Point3D"/> object are equal.
+ /// </summary>
+ /// <param name="other">The <see cref="Point3D"/> to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public bool Equals(Point3D other)
{
return X.Equals(other.X) && Y.Equals(other.Y) && Z.Equals(other.Z);
return !p1.Equals(p2);
}
}
-}
+}
\ No newline at end of file
/// 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.
- /// Set a value <= 0.0 to disable a running timer.If the value > 0.0 and the popup is previously visible,
+ /// <![CDATA[Set a value <= 0.0 to disable a running timer.If the value > 0.0 and the popup is previously visible,]]>
/// the timer will be started with this value, canceling any running timer.
/// </remarks>
public double Timeout
Interop.Elementary.elm_progressbar_pulse(RealHandle, true);
}
+ /// <summary>
+ /// Stops a given progress bar "pulsing" animation, if its under that mode.
+ /// </summary>
[Obsolete("use StopPulse instead")]
public void StopPluse()
{
Width = w;
Height = h;
}
+
/// <summary>
/// Gets or sets the position of this Rectangle on the X axis.
/// </summary>
/// </summary>
public Size Size { get { return new Size { Width = Width, Height = Height }; } }
+ /// <summary>
+ /// A human-readable representation of the <see cref="T:Tizen.UI.Rect" />.
+ /// </summary>
+ /// <returns>The string is formatted as "{{X={0} Y={1} Width={2} Height={3}}}".</returns>
public override string ToString()
{
return string.Format("{{X={0} Y={1} Width={2} Height={3}}}", X, Y, Width, Height);
}
+ /// <summary>
+ /// Gets the hash code.
+ /// </summary>
+ /// <returns>The hash code.</returns>
public override int GetHashCode()
{
unchecked
}
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
if (!(obj is Rect))
return Equals((Rect)obj);
}
+ /// <summary>
+ /// Indicates whether this instance and a <see cref="Rect"/> object are equal.
+ /// </summary>
+ /// <param name="other">The <see cref="Rect"/> to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public bool Equals(Rect other)
{
return X.Equals(other.X) && Y.Equals(other.Y) && Width.Equals(other.Width) && Height.Equals(other.Height);
return !r1.Equals(r2);
}
}
-}
+}
\ No newline at end of file
return string.Format("{{Width={0} Height={1}}}", Width, Height);
}
+ /// <summary>
+ /// Gets hash code.
+ /// </summary>
+ /// <returns>The hash code.</returns>
public override int GetHashCode()
{
unchecked
}
}
+ /// <summary>
+ /// Indicates whether this instance and a specified object are equal.
+ /// </summary>
+ /// <param name="obj">The object to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public override bool Equals(object obj)
{
if (!(obj is Size))
return Equals((Size)obj);
}
+ /// <summary>
+ /// Indicates whether this instance and a <see cref="Size"/> object are equal.
+ /// </summary>
+ /// <param name="other">The <see cref="Size"/> to compare with the current instance.</param>
+ /// <returns>
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
+ /// </returns>
public bool Equals(Size other)
{
return Width.Equals(other.Width) && Height.Equals(other.Height);
return !s1.Equals(s2);
}
}
-}
+}
\ No newline at end of file
{
}
+ /// <summary>
+ /// reates and initializes a new instance of the SmartEvent class.
+ /// </summary>
+ /// <param name="sender">The source of the event.</param>
+ /// <param name="handle">Teh event handler.</param>
+ /// <param name="eventName">The event name.</param>
+ /// <param name="parser">The event parser.</param>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public SmartEvent(EvasObject sender, IntPtr handle, string eventName, SmartEventInfoParser parser)
{
{
}
+ /// <summary>
+ /// Destroy the SmartEvent object.
+ /// </summary>
~SmartEvent()
{
Dispose(false);
}
}
+ /// <summary>
+ /// Destroy current object
+ /// </summary>
public void Dispose()
{
Dispose(true);
_handle = IntPtr.Zero;
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (disposing)
public class SmartEvent : IInvalidatable
{
private SmartEvent<EventArgs> _smartEvent;
+
private event EventHandler _handlers;
/// <summary>
{
}
+ /// <summary>
+ /// Creates and initializes a new instance of the SmartEvent class.
+ /// </summary>
+ /// <param name="sender">The source of the event.</param>
+ /// <param name="handle">The event handler.</param>
+ /// <param name="eventName">The event name.</param>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public SmartEvent(EvasObject sender, IntPtr handle, string eventName)
{
_smartEvent = new SmartEvent<EventArgs>(sender, handle, eventName, null);
}
+ /// <summary>
+ /// Destroy the SmartEvent object.
+ /// </summary>
~SmartEvent()
{
Dispose(false);
_handlers?.Invoke(sender, e);
}
+ /// <summary>
+ /// Destroy current object
+ /// </summary>
public void Dispose()
{
Dispose(true);
_smartEvent.MakeInvalidate();
}
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (disposing)
}
}
}
-}
+}
\ No newline at end of file
}
}
+ /// <summary>
+ /// Sets or gets toolbar's current orientation.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public bool IsHorizontal
{
public Transit()
{
_handle = Interop.Elementary.elm_transit_add();
- DeletedCallback = (ptr1, ptr2) => {
+ DeletedCallback = (ptr1, ptr2) =>
+ {
Deleted?.Invoke(this, EventArgs.Empty);
Dispose(true);
};
((INotifyCollectionChanged)_chains).CollectionChanged += OnChaninCollectionChanged;
}
+ /// <summary>
+ /// Destroy the Transit object.
+ /// </summary>
~Transit()
{
Dispose(false);
Interop.Elementary.elm_transit_effect_add(_handle, EffectTransitionCallback, _effect, EffectEndCallback);
}
+ /// <summary>
+ /// Destroy current object
+ /// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
- protected virtual void Dispose(bool isDisposing)
+ /// <summary>
+ /// Releases all resources currently used by this instance.
+ /// </summary>
+ /// <param name="disposing">
+ /// true if managed resources should be disposed
+ /// otherwise, false.
+ /// </param>
+ protected virtual void Dispose(bool disposing)
{
if (_isDisposed)
return;
- if (isDisposing)
+ if (disposing)
{
((INotifyCollectionChanged)_chains).CollectionChanged -= OnChaninCollectionChanged;
_chains.Clear();
Interop.Elementary.elm_transit_chain_transit_del(_handle, transit._handle);
}
}
-}
+}
\ No newline at end of file
namespace ElmSharp
{
+ /// <summary>
+ /// This class is a static class for a utility methods.
+ /// </summary>
public static class Utility
{
/// <summary>
internal Color _backgroundColor = Color.Default;
internal int _opacity = Color.Default.A;
+ /// <summary>
+ /// Creates and initializes a new instance of Widget class.
+ /// </summary>
protected Widget()
{
}
Transparent = 3,
}
+ /// <summary>
+ /// Enumeration for the keygrab modes of window.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum KeyGrabMode
{
+ /// <summary>
+ /// Unknown keygrab mode
+ /// </summary>
Shared = 256,
+
+ /// <summary>
+ /// Getting the grabbed-key together with the other client windows.
+ /// </summary>
Topmost = 512,
+
+ /// <summary>
+ /// Getting the grabbed-key only when window is top of the stack.
+ /// </summary>
Exclusive = 1024,
+
+ /// <summary>
+ /// Getting the grabbed-key exclusively regardless of window's position.
+ /// </summary>
OverrideExclusive = 2048,
}
_rotationChanged.On += (s, e) => RotationChanged?.Invoke(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Creates and initializes a new instance of the Window class.
+ /// </summary>
protected Window()
{
}
}
}
+ /// <summary>
+ /// Sets or gets available rotation degree.
+ /// </summary>
[Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")]
public DisplayRotation AavailableRotations { get; set; }
}
}
+ /// <summary>
+ /// Sets or gets the iconified state of a window.
+ /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Iconified
{
Interop.Elementary.elm_win_resize_object_add(Handle, obj);
}
+ /// <summary>
+ /// Set keygrab value of the window.
+ /// This function grabs the key of window using grab_mode.
+ /// </summary>
+ /// <param name="keyname">The keyname to grab.</param>
+ /// <param name="mode">According to the grabmode, it can grab key differently</param>
[EditorBrowsable(EditorBrowsableState.Never)]
public void WinKeyGrab(string keyname, KeyGrabMode mode)
{
Interop.Elementary.elm_win_keygrab_set(RealHandle, keyname, 0, 0, 0, mode);
}
+ /// <summary>
+ /// Unset keygrab value of the window.
+ /// This function unset keygrab value.Ungrab key of window.
+ /// </summary>
+ /// <param name="keyname">The keyname to grab.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
public void WinKeyUngrab(string keyname)
{
return (DisplayRotation)orientation;
}
}
-}
+}
\ No newline at end of file
_handle = handle;
}
+ /// <summary>
+ /// Account destructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
~Account()
{
Dispose(false);
GC.SuppressFinalize(this);
}
+ /// <summary>
+ /// Dispose API for destroying the account handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="disposing">The boolean value for destoying account handle.</param>
protected virtual void Dispose(bool disposing)
{
if (!disposing)
public class AccountProvider : IDisposable
{
internal IntPtr _handle;
+
+ /// <summary>
+ /// AccountProvider destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="handle"> The account handle.</param>
internal AccountProvider(IntPtr handle)
{
Handle = handle;
}
+ /// <summary>
+ /// AccountProvider deconstructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~AccountProvider()
{
Dispose(false);
GC.SuppressFinalize(this);
}
+ /// <summary>
+ /// Dispose API for destroying the AccountProvider handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="disposing">The boolean value for destoying AccountProvider handle.</param>
protected virtual void Dispose(bool disposing)
{
if (!disposing)
/// APIs are provided so that an application can register itself
/// with the push server along with APIs to request push message.
/// </remarks>
- /// <example>
- /// <code>
- /// public class Program
- /// {
- /// static void Main(string[] args)
- /// {
- /// PushClient.PushServiceConnect("xxxxx");
- /// Task<ServerResponse> tr = PushClient.PushServerRegister();
- /// tr.GetAwaiter().OnCompleted(() => {
- /// ServerResponse res = tr.Result;
- /// PushClient.GetUnreadNotifications();
- /// Task<ServerResponse> tu = PushClient.PushServerUnregister();
- /// tu.GetAwaiter().OnCompleted(() => {
- /// PushClient.PushServiceDisconnect();
- /// });
- /// });
- /// PushClient.NotificationReceived += EventHandlerNotificationReceived;
- /// PushClient.StateChanged += EventHandlerStateChanged;
- /// }
- /// }
- /// static void EventHandlerNotificationReceived(object sender, PushMessageEventArgs e)
- /// {
- /// // any user code
- /// }
- /// static void EventHandlerStateChanged(object sender, PushConnectionStateEventArgs e)
- /// {
- /// // any user code
- /// }
- /// </code>
- /// </example>
public static class PushClient
{
/// <summary>
}
/// <summary>
- /// registration ID received from server. </summary>
+ /// registration ID received from server.
+ /// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It is the string, which is the ID received from the server.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the current state.</value>
+ /// It is the current state.
+ /// </value>
public PushState State
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the string, which contains the error string if set.</value>
+ /// It is the string, which contains the error string if set.
+ /// </value>
public string Error
{
get;
internal PushImpl()
{
- //Empty
+ // Empty
}
private IntPtr _connection;
ob.Type = type;
}
PushClient.Notify(ob);
- //Interop.PushClient.FreeNotification(notification);
- Log.Info(Interop.PushClient.LogTag, "Free Notification Done");
};
Interop.PushClient.ServiceError connectResult = Interop.PushClient.ServiceConnect(pushAppId, stateDelegate, notifyDelegate, IntPtr.Zero, out _connection);
if (connectResult != Interop.PushClient.ServiceError.None)
public class PushMessageEventArgs : EventArgs
{
/// <summary>
- /// Gives the Application Data recieved. </summary>
+ /// Gives the Application Data recieved.
+ /// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the string, which stores the application data.</value>
+ /// It is the string, which stores the application data.
+ /// </value>
public string AppData
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the string, which stores the message field.</value>
+ /// It is the string, which stores the message field.
+ /// </value>
public string Message
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the DateTime field representing the time at which the Notification was received.</value>
+ /// It is the DateTime field representing the time at which the Notification was received.
+ /// </value>
public DateTime ReceivedAt
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is a string value representing the Sender of the Notification.</value>
+ /// It is a string value representing the Sender of the Notification.
+ /// </value>
public string Sender
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is a string value representing the session ID of the Notification.</value>
+ /// It is a string value representing the session ID of the Notification.
+ /// </value>
public string SessionInfo
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is a string value representing the request ID of the Notification.</value>
+ /// It is a string value representing the request ID of the Notification.
+ /// </value>
public string RequestId
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is an integer value representing the type field of the notification.</value>
+ /// It is an integer value representing the type field of the notification.
+ /// </value>
public int Type
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the Result state of the operation performed.</value>
+ /// It is the Result state of the operation performed.
+ /// </value>
public Result ServerResult
{
get;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// It is the Message sent by the server.</value>
+ /// It is the Message sent by the server.
+ /// </value>
public string ServerMessage
{
get;
#region Dispose support
private bool _isDisposed = false;
+ /// <summary>
+ /// Releases all resources used by the <see cref="AudioCaptureBase"/> object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
+ /// <summary>
+ /// Releases the resources used by the <see cref="AudioCaptureBase"/> object.
+ /// </summary>
+ /// <param name="disposing">
+ /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (_isDisposed)
namespace Tizen.Multimedia
{
+ /// <summary>
+ /// Specifies the audio channels.
+ /// </summary>
+ /// <seealso cref="AudioCapture"/>
+ /// <seealso cref="AsyncAudioCapture"/>
+ /// <seealso cref="AudioPlayback"/>
public enum AudioChannel
{
+ /// <summary>
+ /// Mono.
+ /// </summary>
Mono = 0x80,
+ /// <summary>
+ /// Stereo.
+ /// </summary>
Stereo
}
#region Dispose support
private bool _isDisposed = false;
+ /// <summary>
+ /// Releases all resources used by the <see cref="AudioPlayback"/> object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
+ /// <summary>
+ /// Releases the resources used by the <see cref="AudioPlayback"/> object.
+ /// </summary>
+ /// <param name="disposing">
+ /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// </param>
protected virtual void Dispose(bool disposing)
{
if (_isDisposed)
projects / platform / core / csapi / tizenfx.git / commitdiff