/// <summary>
/// A class which defines the properties of call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallData
{
internal uint CallId;
/// <summary>
/// Gets call id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Id
{
get
/// <summary>
/// Gets call direction(MO or MT).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallDirection Direction
{
get
/// <summary>
/// Get the call number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CallNumber
{
get
/// <summary>
/// Get the contact name of calling number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CallingName
{
get
/// <summary>
/// Get the call type(Voice call or Video call).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallType Type
{
get
/// <summary>
/// Get the call state(Incoming, Active, etc).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallState State
{
get
/// <summary>
/// Get the member count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int MemberCount
{
get
/// <summary>
/// Checks if the call is emergency call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsEmergency
{
get
/// <summary>
/// Checks if the number is voice mail number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsVoiceMailNumber
{
get
/// <summary>
/// Get the call domain(PS call, CS call, etc).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallDomain Domain
{
get
/// <summary>
/// Get the person ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int PersonId
{
get
/// <summary>
/// Get the start time of the call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public long StartTime
{
get
/// <summary>
/// Get the contact name mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallNameMode Mode
{
get
/// <summary>
/// Get the session ID of the call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int SessionId
{
get
/// <summary>
/// Checks if HD is enabled for calling.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsHdEnable
{
get
/// <summary>
/// Checks if the call is a WiFi call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsWiFiCalling
{
get
/// <summary>
/// Checks if upgrade/downgrade is enabled.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsUpgradeDowngradeEnable
{
get
/// <summary>
/// Checks if the remote call is on hold.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsRemoteOnHold
{
get
/// <summary>
/// Checks if the call is added to conference.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsAddedToConference
{
get
/// <summary>
/// Checks if the incoming call is a forwarded call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsMtForwarded
{
get
/// <summary>
/// A class which contains information about call event data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallEventData
{
internal uint EventId;
/// <summary>
/// Get the Call id of the number for which Call event has occurred.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Id
{
get
/// <summary>
/// Get the Sim slot type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public MultiSimSlot SimSlot
{
get
/// <summary>
/// Get call end cause type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallEndCause EndCause
{
get
/// <summary>
/// Get incoming call data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallData IncomingData
{
get
/// <summary>
/// Get active call data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallData ActiveData
{
get
/// <summary>
/// Get the call data for held call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallData HeldData
{
get
/// <summary>
/// A class which manages the use of Call Manager APIs.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class CallManager
{
/// <summary>
/// Initializes the call manager.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>An instance of CmClientHandle class to use call manager APIs.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <summary>
/// Deinitializes the Call Manager handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">The Call Manager handle to be deinitialized.</param>
/// <exception cref="ArgumentNullException">Thrown when CmClientHandle is passed as null.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Sets LCD state for the device display.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="state">LCD state to be set.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public static void SetLcdState(LcdControlState state)
/// <summary>
/// A class which manages call manager events, properties and functions.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CmClientHandle
{
internal IntPtr _handle = IntPtr.Zero;
/// <summary>
/// This event is raised when call status changes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<CallStatusChangedEventArgs> CallStatusChanged
{
add
/// <summary>
/// This event is raised when the mute status changes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<CallMuteStatusChangedEventArgs> CallMuteStatusChanged
{
add
/// <summary>
/// This event is raised when call events change.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<CallEventEventArgs> CallEvent
{
add
/// <summary>
/// This event is raised when dial status changes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<DialStatusEventArgs> DialStatusChanged
{
add
/// <summary>
/// This event is raised when audio status changes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<AudioStatusChangedEventArgs> AudioStateChanged
{
add
/// <summary>
/// This event is raised during DTMF indication.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<DtmfIndicationEventArgs> DtmfIndication
{
add
/// <summary>
/// This event is raised when call comes to foreground.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<EventArgs> GoForeground
{
add
/// <summary>
/// This event is raised when voice record status is changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<VoiceRecordStatusEventArgs> VoiceRecordStatusChanged
{
add
/// <summary>
/// Gets the status of the current call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallStatus CallStatus
{
get
/// <summary>
/// Gets the mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallMuteStatus CallMuteStatus
{
get
/// <summary>
/// Gets the audio state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public AudioState AudioState
{
get
/// <summary>
/// Gets the list of call data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<CallData> AllCalls
{
get
/// <summary>
/// Gets the list of conference call data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<ConferenceCallData> AllConferenceCalls
{
get
/// <summary>
/// Rejects the incoming call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privlevel>partner</privlevel>
/// <privilege>http://developer.samsung.com/tizen/privilege/call.reject</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when privilege access is denied.</exception>
/// <summary>
/// Starts incoming call alert ringtone.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="UnauthorizedAccessException">Thrown when privilege access is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void StartAlert()
/// <summary>
/// Stops incoming call alert ringtone.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privlevel>partner</privlevel>
/// <privilege>http://developer.samsung.com/tizen/privilege/call.reject</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when privilege access is denied.</exception>
/// <summary>
/// Enables call recovery.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="appId">App ID to be recovered.</param>
/// <exception cref="ArgumentNullException">Thrown appId is passed as null.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Dials a call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="number">Calling number to be dialed.</param>
/// <param name="type">Type of the call to be dialed.</param>
/// <param name="slot">Multi sim slot type in which the call is dialed.</param>
/// <summary>
/// Swaps the calls.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SwapCall()
{
/// <summary>
/// Joins a call with another.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void JoinCall()
{
/// <summary>
/// Splits a call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="id">Call id to be splitted.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SplitCall(uint id)
/// <summary>
/// Transfers a call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void TransferCall()
{
/// <summary>
/// Accepts MT ViLTE call as VoLTE.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="answerType">Call answer type.</param>
/// <param name="type">Call type.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Answers an incoming call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="answerType">Call answer type.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void AnswerCall(CallAnswerType answerType)
/// <summary>
/// Upgrades a call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void UpgradeCall()
{
/// <summary>
/// Downgrades a call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void DowngradeCall()
{
/// <summary>
/// Confirms upgrade call request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="response">Upgrade response type.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void ConfirmUpgradeCall(CallUpgradeResponseType response)
/// <summary>
/// Sets the speaker on/off.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="status">Status of the speaker to be set.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void ManageSpeaker(FeatureStatus status)
/// <summary>
/// Sets the bluetooth feature on/off.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="status">Status of the bluetooth to be set.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void ManageBluetooth(FeatureStatus status)
/// <summary>
/// Sets extra volume if needed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="isExtraVolume">Boolean value to indicate if the call is set to have extra volume.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SetExtraVolume(bool isExtraVolume)
/// <summary>
/// Sets the noise reduction feature during call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="isNoiceReduction">Boolean value to indicate whether the call needs noise reduction.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SetNoiseReduction(bool isNoiceReduction)
/// <summary>
/// Sets the mute state of the call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="isMuteState">Mute state to be set.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SetMuteState(bool isMuteState)
/// <summary>
/// Starts sending signal through DTMF digit.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="dtmfDigit">DTMF digit to be pressed on the phone.</param>
/// <exception cref="ArgumentException">Thrown when method failed due to invalid parameter.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Stops sending DTMF signal.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void StopDtmf()
{
/// <summary>
/// Sends signal through DTMF digits.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="dtmfDigits">DTMF digits.</param>
/// <exception cref="ArgumentNullException">Thrown when dtmfDigits is passed as null.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Sends DTMF response.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="response">DTMF response type.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SendDtmfResponse(DtmfResponseType response)
/// <summary>
/// Activates call manager UI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void ActivateUi()
{
/// <summary>
/// Sets device LCD time out.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="timeout">LCD timeout to be set.</param>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void SetLcdTimeout(LcdTimeOut timeout)
/// <summary>
/// Starts voice recording.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="number">Call number.</param>
/// <exception cref="ArgumentNullException">Thrown when number is passed as null.</exception>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
/// <summary>
/// Stops voice record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
public void StopVoiceRecord()
{
/// <summary>
/// Gets all current call data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="incoming">Incoming calldata instance to be filled.</param>
/// <param name="active">Active calldata instance to be filled.</param>
/// <param name="held">Held calldata instance to be filled.</param>
/// <summary>
/// Holds the active call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privlevel>platform</privlevel>
/// <privilege>http://developer.samsung.com/tizen/privilege/call.admin</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when privilege access is denied.</exception>
/// <summary>
/// Unholds the active call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privlevel>platform</privlevel>
/// <privilege>http://developer.samsung.com/tizen/privilege/call.admin</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when privilege access is denied.</exception>
/// <summary>
/// Ends ongoing call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="id">ID of the call which is to be ended.</param>
/// <param name="type">Call release type.</param>
/// <privlevel>platform</privlevel>
/// <summary>
/// Enumeration for Call status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallStatus
{
/// <summary>
/// <summary>
/// Enumeration for Mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallMuteStatus
{
/// <summary>
/// <summary>
/// Enumeration for call dial status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DialStatus
{
/// <summary>
/// <summary>
/// Enumeration for DTMF indication type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DtmfIndication
{
/// <summary>
/// <summary>
/// Enumeration for audio state type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum AudioState
{
/// <summary>
/// <summary>
/// Enumeration for video record status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum VrStatus
{
/// <summary>
/// <summary>
/// Enumeration for Video record status extra type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum VrStatusExtraType
{
/// <summary>
/// <summary>
/// Enumeration for call type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallType
{
/// <summary>
/// <summary>
/// Enumeration for sim slot type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum MultiSimSlot
{
/// <summary>
/// <summary>
/// Enumeration for call answer types for accepting the incoming call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallAnswerType
{
/// <summary>
/// <summary>
/// Enumeration for call upgrade response type while receiving upgrade request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallUpgradeResponseType
{
/// <summary>
/// <summary>
/// Enumeration for feature(speaker/bluetooth) status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum FeatureStatus
{
/// <summary>
/// <summary>
/// Enumeration for DTMF response type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DtmfResponseType
{
/// <summary>
/// <summary>
/// Enumeration for LCD time out.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum LcdTimeOut
{
/// <summary>
/// <summary>
/// Enumeration for contact name mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallNameMode
{
/// <summary>
/// <summary>
/// Enumeration for LCD control state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum LcdControlState
{
/// <summary>
/// <summary>
/// Enumeration for call event type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallEvent
{
/// <summary>
/// <summary>
/// Enumeration for call direction
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallDirection
{
/// <summary>
/// <summary>
/// Enumeration for the call state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallState
{
/// <summary>
/// <summary>
/// Enumeration for call domain.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallDomain
{
/// <summary>
/// <summary>
/// Enumeration for call end cause type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallEndCause
{
/// <summary>
/// <summary>
/// Enumeration for call release type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallReleaseType
{
/// <summary>
/// <summary>
/// An extended EventArgs class which contains information about DTMF indication.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class DtmfIndicationEventArgs : EventArgs
{
private DtmfIndication _indication;
/// <summary>
/// DTMF indication.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public DtmfIndication Indication
{
get
/// <summary>
/// DTMF number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string DtmfNumber
{
get
/// <summary>
/// An extended EventArgs class which contains changed audio status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class AudioStatusChangedEventArgs : EventArgs
{
private AudioState _state;
/// <summary>
/// Audio state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public AudioState State
{
get
/// <summary>
/// An extended EventArgs class which contains changed voice record status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class VoiceRecordStatusEventArgs : EventArgs
{
private VrStatus _status;
/// <summary>
/// Voice record status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public VrStatus Status
{
get
/// <summary>
/// Voice record status extra type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public VrStatusExtraType ExtraType
{
get
/// <summary>
/// An extended EventArgs class which contains changed call mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallMuteStatusChangedEventArgs : EventArgs
{
private CallMuteStatus _Status;
/// <summary>
/// Call mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallMuteStatus Status
{
get
/// <summary>
/// An extended EventArgs class which contains changed call status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallStatusChangedEventArgs : EventArgs
{
private CallStatus _status;
/// <summary>
/// Call status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallStatus Status
{
get
/// <summary>
/// Call number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CallNumber
{
get
/// <summary>
/// An extended EventArgs class which contains changed dial status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class DialStatusEventArgs : EventArgs
{
private DialStatus _status;
/// <summary>
/// Dial status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public DialStatus Status
{
get
/// <summary>
/// An extended EventArgs class which contains changed call event.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallEventEventArgs : EventArgs
{
private CallEvent _event;
/// <summary>
/// Call event.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallEvent Event
{
get
/// <summary>
/// Call event data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallEventData EventData
{
get
/// <summary>
/// A class which defines the properties of conference call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class ConferenceCallData
{
internal uint CallId;
/// <summary>
/// Conference call ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Id
{
get
/// <summary>
/// Call number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CallNumber
{
get
/// <summary>
/// Person ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int PersonId
{
get
/// <summary>
/// Call name mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallNameMode Mode
{
get
/// <summary>
/// This class provides functions to manage call related setup and methods.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Call
{
private IntPtr _handle;
/// <summary>
/// A public constructor for Call class to create a Call instance for the given tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">The tapi handle.</param>
public Call(TapiHandle handle)
{
/// <summary>
/// Setup the call to be dialled asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="info">Information of call type and number.</param>
/// <returns>A task indicating whether the DialCall method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Supports answering the incoming call by accepting or rejecting the call asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callHandle">Unique handle that refer to the call.</param>
/// <param name="type">The answer type.</param>
/// <returns>The call id of answer call. This call handle is available to the application through an incoming call(IncomingVoiceCall) event.</returns>
/// <summary>
/// Releases the call asynchronously irrespective of whether the call is in the hold or active state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callHandle">Unique handle that refer to the call.</param>
/// <param name="type">The end call type.</param>
/// <returns>Instance of CallEndData.</returns>
/// <summary>
/// Puts the given call on hold asynchoronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callHandle">Unique handle for referring the call.</param>
/// <returns>The call id of hold call.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Retrieves the call being held asynchoronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callHandle">Unique handle for referring the call.</param>
/// <returns>The call id of active call.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Swaps calls asynchoronously. This is only for calls dialed or answered with Telephony.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="activeCallHandle">Active call.</param>
/// <param name="heldCallHandle">Held call.</param>
/// <returns>The call id of swap call.</returns>
/// <summary>
/// Starts continuous dtmf by sending a single digit during the call asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="digit">The dtmf digit to be sent.</param>
/// <returns>A task indicating whether the StartContDtmfCall method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Stops continuous dtmf during the call asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task indicating whether the StopContDtmfCall method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <summary>
/// Send one or more dtmf digits during the call asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="dtmfData">A burst dtmf info containing dtmf string, pulse width, and inter digit interval.</param>
/// <returns>A task indicating whether the SendBurstDtmfCall method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Joins the given two calls (one call in the active conversation state and the other call in the held state) into conference asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="activeCallhandle">Unique handle which is either an active call or a held call.</param>
/// <param name="callHandle">Unique call handle.</param>
/// <returns>The call id of join call.</returns>
/// <summary>
/// Triggers splitting a private call from a multiparty call asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callHandle">The handle of the call to be made private. The call handle referring to the call that is to be split from the conference.</param>
/// <returns>The call id of split call.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Triggers making an explicit call transfer by connecting the two parties where one party is being active(active state) and another party is being held(held state) asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="activeCallHandle">The call handle of an active call.</param>
/// <returns>The call id of transferred call.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Redirects the incoming call to another subscriber asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="incomingCallHandle">Incoming call handle.</param>
/// <param name="destinationNumber">The destination number.</param>
/// <returns>A task indicating whether the DeflectCall method is done or not.</returns>
/// <summary>
/// Gets the status of the current call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="callId">A unique handle for referring the call.</param>
/// <returns>The call status information like destination number, call direction, call type, whether call is in the conference state or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Get the list of status of the current call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>List of CallStatus.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Get the call volume asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="device">The sound device.</param>
/// <param name="type">The sound type.</param>
/// <returns>Instance of CallVolumeInfo.</returns>
/// <summary>
/// Set the call volume asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="record">The call volume information.</param>
/// <returns>A task indicating whether the SetCallVolumeInfo method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Set the call sound path asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="path">The call sound path information.</param>
/// <returns>A task indicating whether the SetCallSoundPath method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Set the call mute state asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="record">The call mute status information.</param>
/// <returns>A task indicating whether the SetCallMuteStatus method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Get the call mute state asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of CallMuteStatusRecord.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Get the voice privacy mode in the phone asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>CallPrivacyMode value.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Set the voice privacy mode in the phone asynchronously. It is available only where a call exists.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="mode">Voice privacy option mode value.</param>
/// <returns>A task indicating whether the SetCallPrivacyMode method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Set the preferred voice subscription asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="subscription">Preferred voice subscription value.</param>
/// <returns>A task indicating whether the SetCallPreferredVoiceSubscription method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Get the preferred voice subscription.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>CallPreferredVoiceSubscription value.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// A class containing information about call idle status notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallIdleStatusNotificationData
{
internal uint Id;
/// <summary>
/// Notification id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Notificatio id in unsigned integer format.</value>
public uint NotiId
{
/// <summary>
/// End cause for the call indicates whether the call is released normally or due to some other cause.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>En cause enum value.</value>
public CallEndCause EndCause
{
/// <summary>
/// A class which contains calling name information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallerNameInfo
{
internal CallNameMode Mode;
/// <summary>
/// Display mode of the name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Enum value for call name mode</value>
public CallNameMode NameMode
{
/// <summary>
/// Calling party name string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>String value representing calling party name.</value>
public string Name
{
/// <summary>
/// A class which contains details about call information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallIncomingInfo
{
internal uint Handle;
/// <summary>
/// Call handle indicates the handle of the call for the application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call handle represented in unsigned integer format.</value>
public uint CallHandle
{
/// <summary>
/// Call type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call type indicating whether the requested call is a voice or video call.</value>
public CallType CallType
{
/// <summary>
/// Caller number, null terminated ASCII.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A string representing calling party number.</value>
public string CallerNumber
{
/// <summary>
/// Call name info. If there is no information from the network, this information will be null.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A CallerNameInfo which contains information about the calling party name.</value>
public CallerNameInfo NameInfo
{
/// <summary>
/// CLI mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Enum value representing CLI mode.</value>
public CallCliMode CliMode
{
/// <summary>
/// No CLI cause.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Enum value representing the cause for no CLI.</value>
public CallNoCliCause CliCause
{
/// <summary>
/// Checks whether the incoming call is a forwarded call or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>True or false. If the incoming call is a forwarded call, then true else false.</value>
public bool IsForwarded
{
/// <summary>
/// Current Active Line.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Enum value representing call active line.</value>
public CallActiveLine ActiveLine
{
/// <summary>
/// A class which contains information about call line control.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallRecordLineControl
{
internal byte PolarityInc;
/// <summary>
/// Polarity included.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Polarity value represented in byte format.</value>
public byte PolarityIncluded
{
/// <summary>
/// Toggle mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Toggle mode represented in byte format.</value>
public byte ToggleMode
{
/// <summary>
/// Reverse polarity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Reverse polarity value represented in byte format.</value>
public byte ReversePolarity
{
/// <summary>
/// Power denial time.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Time value in byte which represents power denial time.</value>
public byte PowerDenialTime
{
/// <summary>
/// A class which contains information about call record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallRecord
{
internal uint Id;
/// <summary>
/// Call id
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call id which is represented in unsigned integer format.</value>
public uint CallId
{
/// <summary>
/// Call record type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An enum value representing the call record type.</value>
public CallRecordType CallRecordType
{
/// <summary>
/// Name record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallRecordType is Name, otherwise it is null.
/// </remarks>
/// <summary>
/// Number record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallRecordType is Record, otherwise it is null.
/// </remarks>
/// <summary>
/// Gets the line control info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallRecordType is LineControl, otherwise it is null.
/// </remarks>
/// <summary>
/// A class which contains information about call signal notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallSignalNotification
{
internal CallAlertSignal Signal;
/// <summary>
/// Gets the call signal type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Signal type of the call represented as CallAlertSignal enum.</value>
public CallAlertSignal SignalType
{
/// <summary>
/// Gets the call pitch type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Pitch type of the call represented as CallAlertPitch enum.</value>
public CallAlertPitch PitchType
{
/// <summary>
/// Gets the call signal tone type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if SignalType is Tone.
/// </remarks>
/// <summary>
/// Gets the signal ISDN Alert type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if SignalType is IsdnAlert.
/// </remarks>
/// <summary>
/// Gets the signal IS54B alert type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if SignalType is Is54bAlert.
/// </remarks>
/// <summary>
/// A class which contains information about call upgrade/downgrade request of VoLTE call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallUpgradeDowngradeRequestNoti
{
internal int Handle;
/// <summary>
/// Gets the call handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call handle value represented in integer format.</value>
public int CallHandle
{
/// <summary>
/// Gets the call upgrade/downgrade config type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call upgrade/downgrade type represented in CallConfigType enum.</value>
public CallConfigType UpgradeType
{
/// <summary>
/// A class which contains information about an outgoing call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallInformation
{
private CallType _type;
/// <summary>
/// A parameterized constructor of CallInformation.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">Type of call(voice, data, video, emergency).</param>
/// <param name="etype">Emergency category.</param>
/// <param name="phoneNumber">Destination phone number.</param>
/// <summary>
/// A class which contains information about call end response data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallEndData
{
private CallEndType _type;
/// <summary>
/// End type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallEndType Type
{
get
/// <summary>
/// Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Id
{
get
/// <summary>
/// A class which contains information about burst DTMF in CDMA.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallBurstDtmfData
{
private string _dtmf;
/// <summary>
/// A parameterized constructor of CallBurstDtmfData.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="dtmf">Burst DTMF string.</param>
/// <param name="width">DTMF Pulse Width.</param>
/// <param name="interval">DTMF Inter Digit Interval.</param>
/// <summary>
/// A class which contains information about call status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallStatus
{
private int _handle;
/// <summary>
/// Call handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CallHandle
{
get
/// <summary>
/// Status will be true for MO calls. If MT call, then its false.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsMoCall
{
get
/// <summary>
/// Mobile number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string PhoneNumber
{
get
/// <summary>
/// Type of call(voice, data, emergency).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallType Type
{
get
/// <summary>
/// Current call state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public CallState State
{
get
/// <summary>
/// Whether call is in conference state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsConferenceState
{
get
/// <summary>
/// Whether call is volte call.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsVolteCall
{
get
/// <summary>
/// A class that contains call volume info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallVolumeRecord
{
private SoundDevice _device;
/// <summary>
/// A parameterized constructor of CallVolumeRecord.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="device">Call sound device.</param>
/// <param name="type">Call sound type.</param>
/// <param name="volume">Call sound volume.</param>
/// <summary>
/// Call sound device info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SoundDevice Device
{
get
/// <summary>
/// Call sound type info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SoundType Type
{
get
/// <summary>
/// Call sound volume info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SoundVolume Volume
{
get
/// <summary>
/// A class which contains call volume info reponse data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallVolumeInfo
{
private uint _id;
/// <summary>
/// Record number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint RecordId
{
get
/// <summary>
/// Volume info record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<CallVolumeRecord> Records
{
get
/// <summary>
/// A class which contains call sound path and volume information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallSoundPathInfo
{
private SoundPath _path;
/// <summary>
/// A parameterized constructor of CallSoundPathInfo.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="path">Sound path.</param>
/// <param name="exVolume">Extra volume status.</param>
public CallSoundPathInfo(SoundPath path, ExtraVolume exVolume)
/// <summary>
/// A class which contains call mute status reponse data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class CallMuteStatusRecord
{
private SoundMutePath _path;
/// <summary>
/// A parameterized constructor of CallMuteStatusRecord.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="path">Mute path.</param>
/// <param name="status">Mute status.</param>
public CallMuteStatusRecord(SoundMutePath path, SoundMuteStatus status)
/// <summary>
/// Gets the sound mute path.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SoundMutePath Path
{
get
/// <summary>
/// Gets the sound mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SoundMuteStatus Status
{
get
/// <summary>
/// Enumeration for call end cause.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallEndCause
{
/// <summary>
/// <summary>
/// Enumeration for call type to be used by applications.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallType
{
/// <summary>
/// <summary>
/// Enumeration for the call name mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallNameMode
{
/// <summary>
/// <summary>
/// Enumeration for the "Cli mode" value.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallCliMode
{
/// <summary>
/// <summary>
/// Enumeration for "No Cli cause" value.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallNoCliCause
{
/// <summary>
/// <summary>
/// Enumeration for call active line(IN GSM ONLY: call identification number).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallActiveLine
{
/// <summary>
/// <summary>
/// Enumeration for the call record info type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallRecordType
{
/// <summary>
/// <summary>
/// Enumeration for the voice privacy option mode. (CDMA only).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallPrivacyMode
{
/// <summary>
/// <summary>
/// Enumeration for the OTASP Status. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallOtaspStatus
{
/// <summary>
/// <summary>
/// Enumeration for the OTAPA status. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallOtapaStatus
{
/// <summary>
/// <summary>
/// Enumeration for call sound path.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundPath
{
/// <summary>
/// <summary>
/// Enumeration for the Alert Signal Type. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallAlertSignal
{
/// <summary>
/// <summary>
/// Enumeration for the Alert Pitch Type. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallAlertPitch
{
/// <summary>
/// <summary>
/// Enumeration for the signals specific to the alert signal type. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallToneSignal
{
/// <summary>
/// <summary>
/// Enumeration for the call ISDN Alert signal. (CDMA only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallIsdnAlertSignal
{
/// <summary>
/// <summary>
/// Enumeration for the call IS54B Alert signal types.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallIs54bAlertSignal
{
/// <summary>
/// <summary>
/// Enumeration for call sound ringback tone notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallSoundRingbackNoti
{
/// <summary>
/// <summary>
/// Enumeration for call sound WBAMR notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallSoundWbamrNoti
{
/// <summary>
/// <summary>
/// Enumeration for call sound noise reduction.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallSoundNoiseReduction
{
/// <summary>
/// <summary>
/// Enumeration for call preferred voice subscription.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallPreferredVoiceSubscription
{
/// <summary>
/// <summary>
/// Enumeration for specifying type for call upgrade/downgrade.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallConfigType
{
/// <summary>
/// <summary>
/// Enumeration for the emergency call category type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum EmergencyType
{
/// <summary>
/// <summary>
/// Enumeration for the call answer type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallAnswerType
{
/// <summary>
/// <summary>
/// Enumeration for the call end type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallEndType
{
/// <summary>
/// <summary>
/// Enumeration for the onlength to send DTMF.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallDtmfPulseWidth
{
/// <summary>
/// <summary>
/// Enumeration for the offlength to send DTMF.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallDtmfDigitInterval
{
/// <summary>
/// <summary>
/// Enumeration for call states.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CallState
{
/// <summary>
/// <summary>
/// Enumeration for call sound device type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundDevice
{
/// <summary>
/// <summary>
/// Enumeration for call sound type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundType
{
/// <summary>
/// <summary>
/// Enumeration for call sound volume level.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundVolume
{
/// <summary>
/// <summary>
/// Enumeration for call extra volume.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ExtraVolume
{
/// <summary>
/// <summary>
/// Enumeration for call sound mute status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundMuteStatus
{
/// <summary>
/// <summary>
/// Enumeration for call sound mute path.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SoundMutePath
{
/// <summary>
/// <summary>
/// This class provides functions for modem services.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Modem
{
private IntPtr _handle;
/// <summary>
/// A public constructor for Modem class to create a Modem instance for the given tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">The tapi handle.</param>
public Modem(TapiHandle handle)
{
/// <summary>
/// Turn the modem on/off asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="cmd">Power command value.</param>
/// <returns>A task indicating whether the ProcessPowerCommand method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Switch the flight mode on/off asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="mode">Flight mode request value.</param>
/// <returns>A task indicating whether the SetFlightMode method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Get the flight mode asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>If flight mode is On, it returns true else it returns false.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Get Me version information asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of MiscVersionInformation.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Misc me version information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <remarks>Returns null in case of failure.</remarks>
/// <summary>
/// Get the Me Esn/Meid for each phone type asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of MiscSerialNumberInformation.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Misc me serial number information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <remarks>Returns null in case of failure.</remarks>
/// <summary>
/// Get the Misc Me Imei asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>The imei string.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Misc me Imei information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <remarks>Returns null in case of failure.</remarks>
/// <summary>
/// Check the modem power status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Phone power status value.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Get device vendor name and device name of cellular dongle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of MiscDeviceInfo.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// A class containing information about mobile equipment version.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class MiscVersionInformation
{
internal byte Version;
/// <summary>
/// Version mask.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte VersionMask
{
get
/// <summary>
/// Software version.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string SwVersion
{
get
/// <summary>
/// Hardware version.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string HwVersion
{
get
/// <summary>
/// Calculation date.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CalculationDate
{
get
/// <summary>
/// Product code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ProductCode
{
get
/// <summary>
/// Model id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ModelId
{
get
/// <summary>
/// Number of prl nam fields.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte PrlNam
{
get
/// <summary>
/// Prl version (only for CDMA).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string PrlVersion
{
get
/// <summary>
/// Number of Eri nam fields.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte EriNam
{
get
/// <summary>
/// Eri version.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string EriVersion
{
get
/// <summary>
/// A class containing information about mobile serial number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class MiscSerialNumberInformation
{
internal string SzEsn;
/// <summary>
/// Esn number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Esn
{
get
/// <summary>
/// Meid number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string MeId
{
get
/// <summary>
/// Imei number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Imei
{
get
/// <summary>
/// Imeisv number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ImeiSv
{
get
/// <summary>
/// A class containing device information of cellular dongle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class MiscDeviceInfo
{
internal string Vendor;
/// <summary>
/// Vendor name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string VendorName
{
get
/// <summary>
/// Device name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string DeviceName
{
get
/// <summary>
/// This class provides functions for managing telephony service network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Network
{
private IntPtr _handle;
/// <summary>
/// A public constructor for Network class to create a Network instance for the given tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">The tapi handle.</param>
public Network(TapiHandle handle)
{
/// <summary>
/// Request the lower layers to select the network automatically asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Request the lower layers to select the network which is selected by the user from the network list asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="plmn">The user selected plmn.</param>
/// <param name="act">The user selected access technology.</param>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Sends a request to do manual search for the available networks and provides the Network List to the user asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of NetworkPlmnList.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <summary>
/// Get the present network selection mode i.e. automatic or manual asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Value of NetworkSelectionMode.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Set the network preferred plmn asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="operation">The operation to be done on the preferred plmn.</param>
/// <param name="info">The preferred plmn info.</param>
/// <returns>A task indicating whether the SetNetworkPreferredPlmn method is done or not.</returns>
/// <summary>
/// Get the preferred plmn list asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>List of NetworkPreferredPlmnInfo.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Cancel the triggered manual network search asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task indicating whether the CancelNetworkManualSearch method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <summary>
/// Get the network serving information asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of NetworkServing.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Set the network mode asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="mode">The network mode.</param>
/// <returns>A task indicating whether the SetNetworkMode method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Get the network mode asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Value of NetworkMode.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Get the neighboring cell info asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Instance of NetworkNeighboringCell.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Enters or exits the emergency callback mode asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="mode">The emergency callback mode.</param>
/// <returns>A task indicating whether the SetEmergencyCallbackMode method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Set the network roaming preference asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="roamPref">The network roaming preference.</param>
/// <returns>A task indicating whether the SetRoamingPreference method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Get the network roaming preference asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Value of NetworkPreferred.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Set the default data subscription asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task indicating whether the SetDefaultDataSubscription method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <summary>
/// Get the default data subscription.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Value of NetworkDefaultDataSubscription.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Set the default subscription for voice asynchronously.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task indicating whether the SetNetworkDefaultSubscription method is done or not.</returns>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <privlevel>platform</privlevel>
/// <summary>
/// Get the default subscription for voice.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>Value of NetworkDefaultSubscription.</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// A class which defines network registration status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkRegistrationStatus
{
internal NetworkServiceLevel Cs;
/// <summary>
/// Circuit Switched status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Status of circuit switched data.</value>
public NetworkServiceLevel CircuitStatus
{
/// <summary>
/// Packet Switched status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Status of packet switched data.</value>
public NetworkServiceLevel PacketStatus
{
/// <summary>
/// Registration service type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Service type represented in NetworkServiceType enum.</value>
public NetworkServiceType Type
{
/// <summary>
/// Roaming status
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the roaming status.</value>
public bool IsRoaming
{
/// <summary>
/// A class which defines network cell info notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkCellNoti
{
internal int Location;
/// <summary>
/// Location Area Code (In case of LTE network, it represents Tracking Area Code).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Location area code represented in integer.</value>
public int Lac
{
/// <summary>
/// Cell ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Cell id represented in integer.</value>
public int CellId
{
/// <summary>
/// A class which defines network change notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkChangeNoti
{
internal NetworkSystemType Type;
/// <summary>
/// Access technology.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Access technology represented in NetworkSystemType enum.</value>
public NetworkSystemType Act
{
/// <summary>
/// Network PLMN.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Plmn value represented as string.</value>
public string Plmn
{
/// <summary>
/// A class which defines network time notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkTimeNoti
{
internal DateTime TimeInfo;
/// <summary>
/// Date time information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of DateTime representing date time information.</value>
public DateTime Time
{
/// <summary>
/// Wday information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Wday info represented in integer.</value>
public int WDay
{
/// <summary>
/// GMT Off.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>GMT off info represented in integer.</value>
public int GmtOff
{
/// <summary>
/// DST Off.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>DST off info represented in integer.</value>
public int DstOff
{
/// <summary>
/// Flag for checking if it is DST.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check if the time is DST or not.</value>
public bool IsDst
{
/// <summary>
/// Network PLMN.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>PLMN value represented in string.</value>
public string Plmn
{
/// <summary>
/// A class which defines network identity notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkIdentityNoti
{
internal string NwPlmn;
/// <summary>
/// Network PLMN.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Plmn value represented in string.</value>
public string Plmn
{
/// <summary>
/// Short network name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Short name of the network in string.</value>
public string ShortName
{
/// <summary>
/// Full network name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Full name of the network in string.</value>
public string FullName
{
/// <summary>
/// A class which defines network VoLTE status notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkVolteStatus
{
internal bool NwIsRegistered;
/// <summary>
/// VoLTE status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check if it is registered.</value>
public bool IsRegistered
{
/// <summary>
/// Services registered for.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Service mask represented in integer.</value>
public int FeatureMask
{
/// <summary>
/// Network on which VoLTE is registered.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of VoLTE network represented in VolteNetworkType enum.</value>
public VolteNetworkType Type
{
/// <summary>
/// A class which defines network identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkIdentity
{
internal string IdName;
/// <summary>
/// Network name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Name
{
get
/// <summary>
/// Service provider name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ServiceProviderName
{
get
/// <summary>
/// Network plmn.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Plmn
{
get
/// <summary>
/// Plmn Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint PlmnId
{
get
/// <summary>
/// Plmn type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public NetworkPlmnType PlmnType
{
get
/// <summary>
/// Access technology.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public NetworkSystemType SystemType
{
get
/// <summary>
/// A class for the network plmn list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkPlmnList
{
internal byte NwCount;
/// <summary>
/// Network plmn count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Count of the network plmn.</value>
public byte NetworkCount
{
/// <summary>
/// Network list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of NetworkIdentity.</value>
public IEnumerable<NetworkIdentity> NetworkList
{
/// <summary>
/// A class which defines the preferred plmn information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkPreferredPlmnInfo
{
internal byte idex;
/// <summary>
/// Preferred plmn list index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
///<value>Index of preferred plmn list.</value>
public byte Index
{
/// <summary>
/// Preferred plmn.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Plmn string.</value>
public string Plmn
{
/// <summary>
/// Network name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Name of network.</value>
public string NetworkName
{
/// <summary>
/// Service provider name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Name of service provider.</value>
public string ServiceProviderName
{
/// <summary>
/// System type of network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>System type of network.</value>
public NetworkSystemType SystemType
{
/// <summary>
/// A class containing information related to a cdma system.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkCdmaSysInfo
{
internal int Car;
/// <summary>
/// Cdma carrier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Cdma carrier.</value>
public int Carrier
{
/// <summary>
/// System Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>System Id.</value>
public uint SystemId
{
/// <summary>
/// Network Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Id of network.</value>
public uint NetworkId
{
/// <summary>
/// Base station Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Id of base station.</value>
public uint BaseStationId
{
/// <summary>
/// Latitude of the current base station.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Latitude of the current base station.</value>
public int BaseStationLatitude
{
/// <summary>
/// Longitude of the current base station.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Longitude of the current base station.</value>
public int BaseStationLongitude
{
/// <summary>
/// Registration zone.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Registration zone.</value>
public uint RegistrationZone
{
/// <summary>
/// Pilot offset.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Offset of pilot.</value>
public uint PilotOffset
{
/// <summary>
/// A class containing information about network area.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkAreaInfo
{
internal int Code;
/// <summary>
/// Location area code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Area code of location.</value>
public int Lac
{
/// <summary>
/// Instance of NetworkCdmaSysInfo.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkCdmaSysInfo.</value>
public NetworkCdmaSysInfo CdmaInfo
{
/// <summary>
/// A class containing information of serving network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkServing
{
internal NetworkSystemType Type;
/// <summary>
/// Access technology.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>System type of network.</value>
public NetworkSystemType SystemType
{
/// <summary>
/// Network plmn.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Plmn of network.</value>
public string Plmn
{
/// <summary>
/// Area information of network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkAreaInfo.</value>
public NetworkAreaInfo AreaInfo
{
/// <summary>
/// A class containing information of cdma cell.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkCdmaCell
{
internal uint SysId;
/// <summary>
/// System Id info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>System Id.</value>
public uint SystemId
{
/// <summary>
/// Network Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Network Id.</value>
public uint NetworkId
{
/// <summary>
/// Base station Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Base station id.</value>
public uint BaseStationId
{
/// <summary>
/// Reference pn.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Reference pn.</value>
public uint ReferencePn
{
/// <summary>
/// Latitude of the current base station.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Latitude of the current base station.</value>
public int BaseStationLatitude
{
/// <summary>
/// Longitude of the current base station.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Longitude of the current base station.</value>
public int BaseStationLongitude
{
/// <summary>
/// A class containing information of lte cell.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkLteCell
{
internal int Id;
/// <summary>
/// Value of cell Id. -1 indicates that cell Id information is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Cell Id.</value>
public int CellId
{
/// <summary>
/// Location area code. This field is ignored when CellId is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Code of area.</value>
public int Lac
{
/// <summary>
/// Physical cell id info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Physical cell id.</value>
public int PhysicalId
{
/// <summary>
/// E-Utra absolute rf channel number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>E-Utra absolute rf channel number.</value>
public int Earfcn
{
/// <summary>
/// Tracking area code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Area code for tracking.</value>
public int Tac
{
/// <summary>
/// Rssi in dBm(signed)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Rssi in dBm.</value>
public int Rssi
{
/// <summary>
/// A class containing information of umts cell.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkUmtsCell
{
internal int Id;
/// <summary>
/// Ucid. -1 indicates that cell Id information is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>RNCID + Cell ID(16 bit).</value>
public int CellId
{
/// <summary>
/// Location area code. This field is ignored when CellId is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Code of area.</value>
public int Lac
{
/// <summary>
/// Utra absolute rf channel number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Utra absolute rf channel number.</value>
public int Arfcn
{
/// <summary>
/// Primary scrambling code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Primary scrambling code.</value>
public int Psc
{
/// <summary>
/// Received signal code power. Valid values are (0-96, 255).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Power of received signal code.</value>
public int Rscp
{
/// <summary>
/// A class containing information of geran cell.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkGeranCell
{
internal int Id;
/// <summary>
/// Value of cell Id. -1 indicates that cell Id information is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Cell Id.</value>
public int CellId
{
/// <summary>
/// Location area code. This field is ignored when CellId is not present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Code of area.</value>
public int Lac
{
/// <summary>
/// Broadcast control channel frequency number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Broadcast control channel frequency number.</value>
public int Bcch
{
/// <summary>
/// Base station identification code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Id code of base station.</value>
public int Bsic
{
/// <summary>
/// Received signal strength level. Valid values are (0-63, 99).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Strength of received signal.</value>
public int Rxlev
{
/// <summary>
/// A class which contains geran, umts, cdma and lte cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Cell
{
internal NetworkGeranCell Geran;
/// <summary>
/// Geran cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkGeranCell.</value>
public NetworkGeranCell GeranCell
{
/// <summary>
/// Cdma cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkCdmaCell.</value>
public NetworkCdmaCell CdmaCell
{
/// <summary>
/// Umts cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkUmtsCell.</value>
public NetworkUmtsCell UmtsCell
{
/// <summary>
/// Lte cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkLteCell.</value>
public NetworkLteCell LteCell
{
/// <summary>
/// A class which contains serving cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkServingCell
{
internal NetworkSystemType SysType;
/// <summary>
/// Access technology.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Network system type.</value>
public NetworkSystemType SystemType
{
/// <summary>
/// Mobile country code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Country code of the mobile.</value>
public int MobileCountryCode
{
/// <summary>
/// Mobile network code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Network code of the mobile.</value>
public int MobileNetworkCode
{
/// <summary>
/// Information of cell.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
///<value>Instance of Cell.</value>
public Cell CellInfo
{
/// <summary>
/// A class which contains neighboring cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NetworkNeighboringCell
{
internal NetworkServingCell ServCell;
/// <summary>
/// Serving cell information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Instance of NetworkServingCell.</value>
public NetworkServingCell ServingCell
{
/// <summary>
/// Geran cell info list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of NetworkGeranCell.</value>
public IEnumerable<NetworkGeranCell> GeranList
{
/// <summary>
/// Umts cell info list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of NetworkUmtsCell.</value>
public IEnumerable<NetworkUmtsCell> UmtsList
{
/// <summary>
/// Lte cell info list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of NetworkLteCell.</value>
public IEnumerable<NetworkLteCell> LteList
{
/// <summary>
/// Enumeration for the status of the network service.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkServiceLevel
{
/// <summary>
/// <summary>
/// Enumeration for the service types of TAPI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkServiceType
{
/// <summary>
/// <summary>
/// Enumeration for the system types of network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkSystemType
{
/// <summary>
/// <summary>
/// Enumeration for the network emergency callback mode states (3GPP2 specific enum).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkEmergencyCallbackMode
{
/// <summary>
/// <summary>
/// Enumeration for the possible default Data Subscriptions.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkDefaultDataSubscription
{
/// <summary>
/// <summary>
/// Enumeration for the possible default Subscriptions for CS (Voice).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkDefaultSubscription
{
/// <summary>
/// <summary>
/// Enumeration for type of network on which VoLTE is registered.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum VolteNetworkType
{
/// <summary>
/// <summary>
/// Enumeration for the packet service protocol type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkPsType
{
/// <summary>
/// <summary>
/// Enumeration for the network name display condition type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkNameDisplayCondition
{
/// <summary>
/// <summary>
/// Enumeration for the different serving network LTE band type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkLteBandType
{
/// <summary>
/// <summary>
/// Enumeration for the operation that can be done on a preferred PLMN.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkPreferredPlmnOp
{
/// <summary>
/// <summary>
/// Enumeration for the CDMA Preferred Network Type(CDMA only).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkPreferred
{
/// <summary>
/// <summary>
/// Enumeration for the different network operation causes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkOperationCause
{
/// <summary>
/// <summary>
/// Enumeration for the network plmn type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkPlmnType
{
/// <summary>
/// <summary>
/// Enumeration for the network selection mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkSelectionMode
{
/// <summary>
/// <summary>
/// Enumeration for the different network modes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum NetworkMode
{
/// <summary>
/// <summary>
/// This class provides functions for sending oem related data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Oem
{
private IntPtr _handle;
/// <summary>
/// A public constructor for Oem class to create a Oem instance for the given tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">The tapi handle.</param>
public Oem(TapiHandle handle)
{
/// <summary>
/// Sends oem data directly.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="oemId">Oem id for user specification.</param>
/// <param name="data">Oem data for sending.</param>
/// <privilege>http://tizen.org/privilege/telephony.admin</privilege>
/// <summary>
/// Sends oem data directly.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="oemId">Oem id for user specification.</param>
/// <param name="data">Oem data for sending.</param>
/// <returns>The oem data which is sent.</returns>
/// <summary>
/// Sends oem data directly.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="oemId">Oem id for user specification.</param>
/// <param name="data">Oem data for sending.</param>
/// <returns>The oem data which is sent.</returns>
/// <summary>
/// A class which defines OEM data base structure.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class OemData
{
internal uint OemId;
/// <summary>
/// Oem ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Oem id represented in unsigned integer.</value>
public uint Id
{
/// <summary>
/// Oem data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Oem data represented in byte array.</value>
public byte[] Data
{
/// <summary>
/// A class which manages sim phonebook record information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Phonebook
{
private IntPtr _handle = IntPtr.Zero;
/// <summary>
/// Gets the instance of Phonebook class.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">An instance of TapiHandle obtained from InitTapi in TapiManager API.</param>
/// <exception cref="ArgumentNullException">Thrown when handle is passed as null.</exception>
public Phonebook(TapiHandle handle)
/// <summary>
/// Gets the current inserted SIM phonebook init status, available phonebook list, and first valid index in case of FDN, ADN, and 3G phonebook.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>An instance of SimPhonebookStatus containing init status and phonebook list information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the number of used records and total records of a specific SIM phonebook type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The different storage types to be selected in the SIM.</param>
/// <returns>A task containing an instance of PhonebookStorageInfo.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets the max text length and max number length supported by the SIM phone book elementary file.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The different storage types to be selected in the SIM.</param>
/// <returns>A task containing an instance of PhonebookMetaInfo.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM 3G phonebook supported EFs like ANR, SNE, GRP, EMAIL and the corresponding EFs max text length, number length, and size.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing an instance of PhonebookMetaInfo3G.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Reads SIM phone book entry information from the given storage type and index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The different storage types to be selected in the SIM.</param>
/// <param name="index">The index for accessing the SIM data.</param>
/// <returns>A task containing an instance of PhonebookRecord.</returns>
/// <summary>
/// Adds or edits SIM phone book record entry information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="record">The phonebook data to be updated or added.</param>
/// <returns>A task indicating whether the updation is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Deletes a SIM phonebook record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The different storage types to be selected in the SIM.</param>
/// <param name="index">The index of the record to be deleted.</param>
/// <returns>A task indicating whether deletion is done or not.</returns>
/// <summary>
/// A class which defines the list of phone book availability of the current SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPhonebookList
{
internal int PbFdn;
/// <summary>
/// Fixed Dialing Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Fdn represented in integer format.</value>
public int Fdn
{
/// <summary>
/// SIM - ADN(2G phonebook, Under DF phonebook).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Adn represented in integer format.</value>
public int Adn
{
/// <summary>
/// Service Dialing Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sdn represented in integer format.</value>
public int Sdn
{
/// <summary>
/// USIM - 3G phonebook.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Usim represented in integer format.</value>
public int Usim
{
/// <summary>
/// Additional number Alpha String phonebook.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Aas represented in integer format.</value>
public int Aas
{
/// <summary>
/// Grouping information Alpha String phonebook.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Gas represented in integer format.</value>
public int Gas
{
/// <summary>
/// A class which defines phone book status of the current SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPhonebookStatus
{
internal bool InitStatus;
/// <summary>
/// Init completed or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the status of Init.</value>
public bool IsInitCompleted
{
/// <summary>
/// List of phonebook.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SimPhonebookList containing the list of available phone book.</value>
public SimPhonebookList PbList
{
/// <summary>
/// A class which defines phonebook contact change information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PhonebookContactChangeInfo
{
internal PhonebookType PbType;
/// <summary>
/// Storage file type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of phonebook storage represented as PhonebookType enum.</value>
public PhonebookType Type
{
/// <summary>
/// Changed index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Index value represented in unsigned short.</value>
public ushort Index
{
/// <summary>
/// Phonebook operation.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Operation indicating the action on phonebook contact.</value>
public PhonebookOperationType Operation
{
/// <summary>
/// A class which defines phone book storage count information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PhonebookStorageInfo
{
internal PhonebookType PbType;
/// <summary>
/// Storage file type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of phone book storage file.</value>
public PhonebookType Type
{
/// <summary>
/// Total record count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Count of total phonebook record.</value>
public ushort TotalRecord
{
/// <summary>
/// Used record count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Number of used phonebook record.</value>
public ushort UsedRecord
{
/// <summary>
/// A class which defines phone book entry information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PhonebookMetaInfo
{
internal PhonebookType MetaType;
/// <summary>
/// Storage file type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of phonebook storage.</value>
public PhonebookType Type
{
/// <summary>
/// Phone book minimum index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Minimum index value of the phone book record.</value>
public ushort MinIndex
{
/// <summary>
/// Phone book maximum index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum index value of the phone book record.</value>
public ushort MaxIndex
{
/// <summary>
/// Phone number's maximum length
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum length of the phone number.</value>
public ushort NumberMaxLength
{
/// <summary>
/// Text's maximum length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum length of the text.</value>
public ushort TextMaxLength
{
/// <summary>
/// Phone book used record count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Number of used phone book record.</value>
public ushort UsedCount
{
/// <summary>
/// A class which defines 3G phone book capability information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class FileTypeCapabilityInfo3G
{
internal PhonebookFileType3G Type;
/// <summary>
/// 3G phonebook file type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>File type of the 3G phonebook.</value>
public PhonebookFileType3G FileType
{
/// <summary>
/// Max index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum index value present in 3G phonebook.</value>
public ushort MaxIndex
{
/// <summary>
/// Max text length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum text length in unsigned short.</value>
public ushort TextMaxLength
{
/// <summary>
/// Used record count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Number of used record in 3G phonebook.</value>
public ushort UsedCount
{
/// <summary>
/// A class which manages Sim phonebook and its capabilities information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PhonebookMetaInfo3G
{
internal ushort FileCount;
/// <summary>
/// Phonebook file type count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Filetype count of the 3G phonebook.</value>
public ushort FileTypeCount
{
/// <summary>
/// Phonebook file type information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of FileTypeCapabilityInfo3G instances.</value>
public IEnumerable<FileTypeCapabilityInfo3G> FileTypeInfo
{
/// <summary>
/// A class which contains information about phonebook record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PhonebookRecord
{
private PhonebookType _type;
/// <summary>
/// Phonebook type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of the phonebook used.</value>
public PhonebookType Type
{
/// <summary>
/// Index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Index value represented in unsigned short.</value>
public ushort Index
{
/// <summary>
/// Next index (This field is not used in the add/update case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Next index represented in unsigned short.</value>
public ushort NextIndex
{
/// <summary>
/// Name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Name in phonebook record.</value>
public string Name
{
/// <summary>
/// Dcs.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sim encryption type.</value>
public TextEncryptionType Dcs
{
/// <summary>
/// Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Number in phonebook record.</value>
public string Number
{
/// <summary>
/// Ton.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sim type of number.</value>
public SimTypeOfNumber Ton
{
/// <summary>
/// SNE(Second Name Entry).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Second name entry in byte array.</value>
public string Sne
{
/// <summary>
/// SNE DCS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SNE text encryption type.</value>
public TextEncryptionType SneDcs
{
/// <summary>
/// Additional Number1.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number1 represented in byte array.</value>
public string Anr1
{
/// <summary>
/// ANR1 TON.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number1 type of number.</value>
public SimTypeOfNumber Anr1Ton
{
/// <summary>
/// Additional Number2.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number2 represented in byte array.</value>
public string Anr2
{
/// <summary>
/// ANR2 TON.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number2 type of number.</value>
public SimTypeOfNumber Anr2Ton
{
/// <summary>
/// Additional number3.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number3 represented in byte array.</value>
public string Anr3
{
/// <summary>
/// ANR3 TON.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Additional number3 type of number.</value>
public SimTypeOfNumber Anr3Ton
{
/// <summary>
/// Email1.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Email1 represented in byte array.</value>
public string Email1
{
/// <summary>
/// Email2.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Email2 represented in byte array.</value>
public string Email2
{
/// <summary>
/// Email3.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Email3 represented in byte array.</value>
public string Email3
{
/// <summary>
/// Email4.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Email4 reprensented in byte array.</value>
public string Email4
{
/// <summary>
/// Group index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Group index represented in unsigned short.</value>
public ushort GroupIndex
{
/// <summary>
/// Phonebook control.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Phonebook control represented in unsigned short.</value>
public ushort PbControl
{
/// <summary>
/// Enumeration for the storage types to be selected in the SIM or USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum PhonebookType
{
/// <summary>
/// <summary>
/// Enumeration for the phonebook operation types.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum PhonebookOperationType
{
/// <summary>
/// <summary>
/// Enumeration for the storage field types in the 3G Phone book.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum PhonebookFileType3G
{
/// <summary>
/// <summary>
/// Enumeration for the text encryption type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TextEncryptionType
{
/// <summary>
/// <summary>
/// Enumeration for the phonebook access result.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum PhonebookAccessResult
{
/// <summary>
/// <summary>
/// A class which defines SAT main menu info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatMainMenuInfo
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command number represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Flag for checking whether main menu is present or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value checking the presence of main menu.</value>
public bool IsMainMenuPresent
{
/// <summary>
/// Menu title text.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Title text of the menu item represented in string.</value>
public string MenuTitle
{
/// <summary>
/// Menu items.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of SatMenuInfo objects.</value>
public IEnumerable<SatMenuInfo> MenuItems
{
/// <summary>
/// Number of menu itmes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An unsigned value representing the number of menu items.</value>
public ushort MainMenuCount
{
/// <summary>
/// Flag for a help information request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value for checking the flag for help information request.</value>
public bool IsMainMenuHelpInfo
{
/// <summary>
/// Updated Sat main menu or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check whether Sat main menu is updated or not.</value>
public bool IsUpdatedMainMenu
{
/// <summary>
/// Icon Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo class representing the icon identifier.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// List of Icon Identifiers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdListInfo class representing the icon identifier list.</value>
public SatIconIdListInfo IconIdList
{
/// <summary>
/// A class which contains menu item information for the setup menu.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatMenuInfo
{
internal string Item;
/// <summary>
/// Menu item character data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Menu item data represented in string.</value>
public string MenuItem
{
/// <summary>
/// Identifies the item on the menu that the user selected.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Item identifier value represented as a character.</value>
public char ItemId
{
/// <summary>
/// A class defining the icon data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatIconIdInfo
{
internal bool IsPresent;
/// <summary>
/// Flag for checking whether the icon identifier exists.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value representing if the icon exists or not.</value>
public bool IsIconPresent
{
/// <summary>
/// Icon qualifier type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Icon qualifier type represented as SatIconQualifierType enum.</value>
public SatIconQualifierType IconQualifier
{
/// <summary>
/// Icon identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A byte value representing the icon identifier.</value>
public byte IconId
{
/// <summary>
/// Icon info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconInfo class.</value>
public SatIconInfo IconInfo
{
/// <summary>
/// A class containing the definition of icon info object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatIconInfo
{
internal byte IconWidth;
/// <summary>
/// Icon width.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Width of the icon represented in byte.</value>
public byte Width
{
/// <summary>
/// Icon height.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Height of the icon represented in byte.</value>
public byte Height
{
/// <summary>
/// Image coding scheme.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Image coding scheme represented as SatImageCodingScheme enum.</value>
public SatImageCodingScheme Ics
{
/// <summary>
/// Icon data length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Data length of the icon represented in ushort.</value>
public ushort IconDataLength
{
/// <summary>
/// Clut data length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Data length of the clut represented in ushort.</value>
public ushort ClutDataLength
{
/// <summary>
/// Icon file.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Icon file string.</value>
public string IconFile
{
/// <summary>
/// Clut file.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Clut file string.</value>
public string ClutFile
{
/// <summary>
/// A class which defines the icon identifier data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatIconIdListInfo
{
internal bool IsPresent;
/// <summary>
/// Flag for checking whether the icon identifier exists.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value indicating the presence of icon.</value>
public bool IsIconPresent
{
/// <summary>
/// Icon list qualifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Icon list qualifier represented in SatIconQualifierType enum.</value>
public SatIconQualifierType IconListQualifier
{
/// <summary>
/// Number of icons.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Byte value indicating the number of icons.</value>
public byte IconCount
{
/// <summary>
/// Icon identifier list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A byte array containing the list of Icon identifier.</value>
public byte[] IconIdList
{
/// <summary>
/// Icon list info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>List of icon info.</value>
public IEnumerable<SatIconInfo> IconInfo
{
/// <summary>
/// A class containing display text proactive command for SAT UI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatDisplayTextData
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id in integer format.</value>
public int CommandId
{
/// <summary>
/// Character data to display on screen.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo containing text information.</value>
public SatTextInfo TextInfo
{
/// <summary>
/// Duration of the display.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Duration in integer format.</value>
public uint Duration
{
/// <summary>
/// Flag that indicates whether text is to be displayed if some other app is using the screen.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value checking the priority of the display.</value>
public bool IsPriorityHigh
{
/// <summary>
/// Flag that indicates whether user response is required.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the need of user response.</value>
public bool IsUserResponseRequired
{
/// <summary>
/// Flag for checking whether immediate response is required.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the immediate response status.</value>
public bool IsImmediateResponse
{
/// <summary>
/// Icon Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo class.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// A class defining character data for the SAT engine data structure.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatTextInfo
{
internal ushort Length;
/// <summary>
/// Character data length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An unsigned short value representing the string length.</value>
public ushort StringLength
{
/// <summary>
/// Character data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A byte array representing the string data.</value>
public byte[] StringData
{
/// <summary>
/// A class which defines select item proactive command data for SAT UI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSelectItemData
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Flag for a help information request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check whether help information is availale or not.</value>
public bool IsHelpInfoAvailable
{
/// <summary>
/// Menu title text.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class containing the text information.</value>
public SatTextInfo TextInfo
{
/// <summary>
/// Selected default item.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Default item index of the given items.</value>
public char DefaultItemIndex
{
/// <summary>
/// Number of menu items.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Menu items count represented as a character.</value>
public char MenuItemCount
{
/// <summary>
/// Menu items.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of SatMenuItemInfo objects.</value>
public IEnumerable<SatMenuItemInfo> MenuItems
{
/// <summary>
/// Icon Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo class.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// List of Icon Identifiers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdListInfo class containing the list of icon identifiers.</value>
public SatIconIdListInfo IconIdList
{
/// <summary>
/// A class which defines the menu item data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatMenuItemInfo
{
internal byte Id;
/// <summary>
/// Item identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Item Id represented in byte.</value>
public byte ItemId
{
/// <summary>
/// Text length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of the text represented in byte.</value>
public byte TextLength
{
/// <summary>
/// Text information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A byte array of length TextLength containing the text information.</value>
public byte[] Text
{
/// <summary>
/// A class which defines get inkey proactive command data for SAT UI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatGetInKeyData
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Input Type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Character Set or Yes/No.</value>
public SatInKeyType KeyType
{
/// <summary>
/// Flag for checking whether input character is numeric.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value for checking whether input character is numeric or not.</value>
public bool IsNumeric
{
/// <summary>
/// Help info request flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value for checking whether help info is available or not.</value>
public bool IsHelpInfoAvailable
{
/// <summary>
/// Character data to display on the screen.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class containing the text information.</value>
public SatTextInfo TextInfo
{
/// <summary>
/// Duration of the display.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Display duration represented in unsigned integer.</value>
public uint Duration
{
/// <summary>
/// Icon identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo class containing the Icon identifier information.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// A class which defines get input proactive command data for SAT UI.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatGetInputData
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Input character mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SMS default, UCS2.</value>
public SatInputAlphabetType AlphabetType
{
/// <summary>
/// Flag to check whether input character is numeric.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the nature of input character.</value>
public bool IsNumeric
{
/// <summary>
/// Help info request flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check help information availability.</value>
public bool IsHelpInfoAvailable
{
/// <summary>
/// Flag that indicates whether to show input data on the screen.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the availability of input data on the screen.</value>
public bool IsEchoInput
{
/// <summary>
/// Character data to display on the screen.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo.</value>
public SatTextInfo TextInfo
{
/// <summary>
/// Input data min, max length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatResponseLengthInfo.</value>
public SatResponseLengthInfo ResponseLength
{
/// <summary>
/// Default input character data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo.</value>
public SatTextInfo DefualtText
{
/// <summary>
/// Icon identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// A class which defines expected user response length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatResponseLengthInfo
{
internal byte Min;
/// <summary>
/// User response length's minimum value.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Minimum value represented in byte.</value>
public byte Minimum
{
/// <summary>
/// User response length's maximum value.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Maximum value represented in byte.</value>
public byte Maximum
{
/// <summary>
/// A class which defines refresh proactive command data for applications that are concerned with files residing on USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatRefreshData
{
internal int Id;
/// <summary>
/// Proactive command number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Concerned application type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Refresh app type represented in SatRefreshAppType enum.</value>
public SatRefreshAppType AppType
{
/// <summary>
/// Refresh mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Refresh mode represented in SatCmdQualiRefresh enum.</value>
public SatCmdQualiRefresh RefreshMode
{
/// <summary>
/// Refresh file count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>File count represented in byte.</value>
public byte FileCount
{
/// <summary>
/// Refresh file identifiers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of SimFileId enums.</value>
public IEnumerable<SimFileId> FileId
{
/// <summary>
/// A class which defines send SMS proactive command data for the SMS application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSendSmsData
{
internal int Id;
/// <summary>
/// Proactive Command Number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer.</value>
public int CommandId
{
/// <summary>
/// Flag to check if packing is required for SMS Tpdu.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the need of packing in SMS Tpdu data.</value>
public bool IsPackingRequired
{
/// <summary>
/// Destination address.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatAddressData containing the address info.</value>
public SatAddressData Address
{
/// <summary>
/// SMS Tpdu data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatSmsTpduInfo.</value>
public SatSmsTpduInfo TpduInfo
{
/// <summary>
/// A class which defines SAT address data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatAddressData
{
internal SimTypeOfNumber Type;
/// <summary>
/// Type of number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sim type of number represented in SimTypeOfNumber enum.</value>
public SimTypeOfNumber Ton
{
/// <summary>
/// Number plan identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sim number plan represented in SimNumberPlanIdentity enum.</value>
public SimNumberPlanIdentity Npi
{
/// <summary>
/// Length of dialling number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Dialling number length represented in byte.</value>
public byte DiallingNumberLength
{
/// <summary>
/// Dialling number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Dialling number represented in string.</value>
public string DiallingNumber
{
/// <summary>
/// A class which defines the Result data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSmsTpduInfo
{
internal SatSmsTpduType Type;
/// <summary>
/// SMS TPDU type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Tpdu type represented in SatSmsTpduType.</value>
public SatSmsTpduType TpduType
{
/// <summary>
/// SMS TPDU data length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of Tpdu data represented in byte.</value>
public byte DataLength
{
/// <summary>
/// SMS TPDU data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An array of bytes representing TPDU data.</value>
public byte[] TpduData
{
/// <summary>
/// A class which defines Event list info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatEventListData
{
internal bool IsDownloadActive;
/// <summary>
/// Flag to check if the event download is acive.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check for active event download.</value>
public bool IsEventDownloadActive
{
/// <summary>
/// Flag to check if the event is about Mt call event.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the event for Mt call event.</value>
public bool IsMtCallEvent
{
/// <summary>
/// Flag to check if the call is connected.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the connection of call.</value>
public bool IsCallConnected
{
/// <summary>
/// Flag to check if the call is disconnected.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the call disconnection.</value>
public bool IsCallDisconnected
{
/// <summary>
/// Flag to check if the event is aboout locaion status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the presence of location status in the event.</value>
public bool IsLocationStatus
{
/// <summary>
/// Flag to check if the event is about user activity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the presence of user activity.</value>
public bool IsUserActivity
{
/// <summary>
/// Flag to check if idle screen is available.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the availability of idle screen.</value>
public bool IsIdleScreenAvailable
{
/// <summary>
/// Flag to check if the event is about card reader status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the status of card reader.</value>
public bool IsCardReaderStatus
{
/// <summary>
/// Flag to check if the event is about language selection.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check if the event is language selection.</value>
public bool IsLanguageSelection
{
/// <summary>
/// Flag to check if the browser is terminated.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the termination of browser.</value>
public bool IsBrowserTermination
{
/// <summary>
/// Flag to check if the data is available.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check availablility of data.</value>
public bool IsDataAvailable
{
/// <summary>
/// Flag to check if the event has channel status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check if this field is a channel status.</value>
public bool IsChannelStatus
{
/// <summary>
/// A class which defines send DTMF proactive command data for the DTMF application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSendDtmfData
{
internal int Id;
/// <summary>
/// Proactive Command Number sent by USIM
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer.</value>
public int CommandId
{
/// <summary>
/// Hidden mode flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Flag to check if the data is in hidden mode.</value>
public bool IsHiddenMode
{
/// <summary>
/// DTMF string data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo containing DTMF string data.</value>
public SatTextInfo DtmfString
{
/// <summary>
/// A class which defines call control confirm data for Call/Ss.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatCallCtrlData
{
internal SatTextInfo Addr;
/// <summary>
/// Call destination address.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class.</value>
public SatTextInfo Address
{
/// <summary>
/// Call SUB address.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class.</value>
public SatTextInfo SubAddress
{
/// <summary>
/// BC repeat indicator.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SatBcRepeatIndicatorType enum representing Bc repeat indicator.</value>
public SatBcRepeatIndicatorType BcRepeatIndicator
{
/// <summary>
/// Configuration Capability Parameter 1.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class.</value>
public SatTextInfo Ccp1
{
/// <summary>
/// Configuration Capability Parameter 2.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class.</value>
public SatTextInfo Ccp2
{
/// <summary>
/// A class which defines common call control confirm data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatCallCtrlConfirmData
{
internal SatCallType Type;
/// <summary>
/// Call control confirm type - call, SS or USSD.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of call represented in SatCallType enum.</value>
public SatCallType CallType
{
/// <summary>
/// Call control result type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of call control result represented in SatCallCtrlResultType enum.</value>
public SatCallCtrlResultType CallCtrlResult
{
/// <summary>
/// Call control display data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo class containing information about call control display data.</value>
public SatTextInfo DisplayData
{
/// <summary>
/// Flag for checking existence of call control display.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check existence of user info display.</value>
public bool IsUserInfoDisplayEnabled
{
/// <summary>
/// Call control call address.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallType is MoVoice. Otherwise it will be null.
/// </remarks>
/// <summary>
/// Call control SS string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallType is Ss. Otherwise it will be null.
/// </remarks>
/// <summary>
/// Call control USSD string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This value will be filled only if CallType is Ussd. Otherwise it will be null.
/// </remarks>
/// <summary>
/// A class which defines the data coding scheme object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatDataCodingScheme
{
internal bool IsCompressed;
/// <summary>
/// Flag to verify the compressed format.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the compressed value.</value>
public bool IsCompressedFormat
{
/// <summary>
/// Alphabet format type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Represented in SatAlphabetFormat enum.</value>
public SatAlphabetFormat AlphabetFormat
{
/// <summary>
/// Type of message class.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Message class represented in SatMsgClassType enum.</value>
public SatMsgClassType MsgClass
{
/// <summary>
/// Raw DCS info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Dcs info stored in byte.</value>
public byte RawDcs
{
/// <summary>
/// A class which defines text string data object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatTextTypeInfo
{
internal bool IsDigit;
/// <summary>
/// Flag for checking whether only digits are used.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value for checking the usage of only digits.</value>
public bool IsDigitOnly
{
/// <summary>
/// Data coding scheme.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatDataCodingScheme class.</value>
public SatDataCodingScheme DCS
{
/// <summary>
/// Text length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of the string in unsigned short format.</value>
public ushort StringLength
{
/// <summary>
/// Text string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Text represented in string.</value>
public string TextString
{
/// <summary>
/// A class which defines MO SMS control confirm data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatMoSmsCtrlData
{
internal SatCallCtrlResultType Result;
/// <summary>
/// Envelope result.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Result of MO SMS control confirm data.</value>
public SatCallCtrlResultType MoResult
{
/// <summary>
/// Display present flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the presence of user information display.</value>
public bool IsUserInfoDisplayEnabled
{
/// <summary>
/// Display data for sending SMS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextTypeInfo containing display data for sending SMS.</value>
public SatTextTypeInfo DisplayData
{
/// <summary>
/// The RP destination address of the service center.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextTypeInfo containing RP destination address.</value>
public SatTextTypeInfo RpDestAddress
{
/// <summary>
/// The TP destinationn address.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextTypeInfo containing TP destination address.</value>
public SatTextTypeInfo TpDestAddress
{
/// <summary>
/// A class which defines setup call proactive command data for the call application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSetupCallData
{
internal int Id;
/// <summary>
/// Proactive Command Number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command Id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Call type
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of call represented in SatCmdQualiSetupCall enum.</value>
public SatCmdQualiSetupCall CallType
{
/// <summary>
/// Display data for calling.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo containing display data for calling.</value>
public SatTextInfo DisplayText
{
/// <summary>
/// Call number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatTextInfo containing call number information.</value>
public SatTextInfo CallNumber
{
/// <summary>
/// Maximum repeat duration.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Max repeat duration represented in unsigned integer format.</value>
public uint Duration
{
/// <summary>
/// Icon identifier for the call application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SatIconIdInfo containing Icon id information.</value>
public SatIconIdInfo IconId
{
/// <summary>
/// A class which defines Send SS notification proactive command data for the applicaiton.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSendSsData
{
internal int Id;
/// <summary>
/// Proactive Command Number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Type of Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>TON represented in SimTypeOfNumber enum.</value>
public SimTypeOfNumber Ton
{
/// <summary>
/// Numbering Plan Identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>NPI reprensented in SimNumberPlanIdentity enum.</value>
public SimNumberPlanIdentity Npi
{
/// <summary>
/// SS string length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of SS string represented in byte.</value>
public byte StringLength
{
/// <summary>
/// SS string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Text string represented in string.</value>
public string SsString
{
/// <summary>
/// A class which defines send USSD notification proactive command data for the application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SatSetupUssdData
{
internal int Id;
/// <summary>
/// Proactive Command Number sent by USIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Command id represented in integer format.</value>
public int CommandId
{
/// <summary>
/// Raw DCS info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Raw DCS information represented in byte.</value>
public byte RawDcs
{
/// <summary>
/// USSD string length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of USSD string in byte.</value>
public byte UssdStringLength
{
/// <summary>
/// USSD string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Ussd text represented in string format.</value>
public string UssdString
{
/// <summary>
/// Enumeration for the UI display status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatUiDisplayStatus
{
/// <summary>
/// <summary>
/// Enumeration for the command qualifier values of the refresh command.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatCmdQualiRefresh
{
/// <summary>
/// <summary>
/// Enumeration for the icon qualifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatIconQualifierType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM image coding scheme type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatImageCodingScheme
{
/// <summary>
/// <summary>
/// Enumeration for the inkey type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatInKeyType
{
/// <summary>
/// <summary>
/// Enumeration for the user input type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatInputAlphabetType
{
/// <summary>
/// <summary>
/// Enumeration for the refresh application type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatRefreshAppType
{
/// <summary>
/// <summary>
/// Enumeration for the SMS TPDU type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatSmsTpduType
{
/// <summary>
/// <summary>
/// Enumeration for the type of command and the next action indicator.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatCommandType
{
/// <summary>
/// <summary>
/// Enumeration for the SAT call type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatCallType
{
/// <summary>
/// <summary>
/// Enumeration for the result of call control by SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatCallCtrlResultType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM ATK BC repeat indicator type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatBcRepeatIndicatorType
{
/// <summary>
/// <summary>
/// Enumeration for alphabet format.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatAlphabetFormat
{
/// <summary>
/// <summary>
/// Enumeration for the message class.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatMsgClassType
{
/// <summary>
/// <summary>
/// Enumeration for the command qualifier values of the setup call command.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SatCmdQualiSetupCall
{
/// <summary>
/// <summary>
/// A class which manages SIM card services.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Sim
{
private IntPtr _handle = IntPtr.Zero;
/// <summary>
/// A constructor to instantiate Sim class using the Tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">An instance of TapiHandle obtained from InitTapi in TapiManager API.</param>
/// <exception cref="ArgumentNullException">Thrown when handle is passed as null.</exception>
public Sim(TapiHandle handle)
/// <summary>
/// Gets SIM card initialization status and SIM card identification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>An instance of SimInitInfo class in case of success. Null in case of failure.</value>
public SimInitInfo InitInfo
{
/// <summary>
/// Gets the card type (SIM/USIM).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCardType SimType
{
get
/// <summary>
/// Gets SIM IMSI information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimImsiInfo Imsi
{
get
/// <summary>
/// Gets ECC(SIM) or UECC(USIM) data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimEccInfoList Ecc
{
get
/// <summary>
/// Gets the list of application on UICC.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A byte containing the masking value for SimAppType.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the unique identification number of the (U)ICC.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing ICCID information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets language preference(indication) information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing information about SIM language preference.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Updates language preference information to the SIM card.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="language">The language preference information.</param>
/// <returns>A task indicating whether setting of language preference is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM call forwarding indication related data(EF-CFIS and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing call forward response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Sets SIM call forwarding indication related data(EF-CFIS and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="request">The data requesting for call forwarding.</param>
/// <returns>A task indicating whether setting call forward info is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM message waiting indication related data(EF-MWIS and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing message waiting response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Sets SIM message waiting indication related data(EF-MWIS and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="request">The data requesting for message waiting.</param>
/// <returns>A task indicating whether setting message waiting info is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM mailbox related data(EF-MBDN, MBDI, and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimMailboxList information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Sets SIM mailbox related data(EF-MBDN, MBDI and CPHS case).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="mailboxNumber">The data requesting for mailbox info.</param>
/// <returns>A task indicating whether setting mailbox info is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM CPHS specific data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimCphs information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the SIM Service Table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SIM service table information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets SIM MSISDN data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimMsisdnList information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets SIM OPLMNWACT(Operator controlled PLMN Selector with Access Technology) data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimOplmnwactList information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets SIM SPN data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimSpn information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets SIM CPHS NETNAME data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SimCphsNetName information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Executes an authentication procedure by using SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="authenticationData">The authentication code to be validated by the ISIM, 3G, and GSM application in the SIM card.</param>
/// <returns>A task containing SimAuthenticationResponse information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Performs PIN1/PIN2/SIM LOCK verification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="pinData">The PIN code.</param>
/// <returns>A task containing SimPinResult information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Performs PIN1/PIN2 unblocking operation based on PUK information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="pukData">The unblocking PIN password.</param>
/// <param name="newPinData">The PIN password to use after the unblocking operation.</param>
/// <returns>A task containing SimPinResult information.</returns>
/// <summary>
/// Changes the PIN1/PIN2 code based on the PIN type passed along with old PIN data and new PIN data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="oldPin">The old PIN code entered by the user.</param>
/// <param name="newPin">The new PIN code entered by the user.</param>
/// <returns>A task containing SimPinResult information.</returns>
/// <summary>
/// Disables the SIM facility.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="facility">An object which contains the facility type and password.</param>
/// <returns>A task containing SIM facility result information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Enables the SIM facility.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="facility">An object which contains the facility type and password.</param>
/// <returns>A task containing SIM facility result information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets the SIM facility.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="lockType">The type of security lock.</param>
/// <returns>A task containing SIM facility information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets SIM lock type info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="lockType">The type of security lock.</param>
/// <returns>A task containing SIM lock information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Sets the SIM power state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="state">The state of SIM to be set.</param>
/// <returns>A task indicating whether setting SIM power state is done or not.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Provides a common interface for accessing SIM data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="apdu">The APDU data.</param>
/// <returns>A task containing SIM APDU response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Provides a common interface to get the SIM ATR(Answer To Reset) value.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SIM ATR response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the IMPI(IMS private user identity). (ISIM only).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing IMPI string.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the IMPU(IMS public user identity). (ISIM only).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SIM IMPU list information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the Domain(Home Network Domain Name). (ISIM only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing domain string.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the P-CSCF(Proxy Call Session Control Function). (ISIM only)
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing SIM PCSCF list information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// Gets the ISIM service table. (ISIM only).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>A task containing a byte array in which mask value of SimIsimService enum will be stored.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <summary>
/// A class which defines SIM card initialization information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimInitInfo
{
internal SimCardStatus SimStatus;
/// <summary>
/// The SIM initialization status from the Telephony server boot up time.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCardStatus Status
{
get
/// <summary>
/// The SIM card identification value. It will be true when the current inserted SIM card differs from the previous SIM. False otherwise.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCardChanged
{
get
/// <summary>
/// A class which defines data for IMSI information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimImsiInfo
{
internal string CountryCode;
/// <summary>
/// Mobile Country Code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Mcc
{
get
/// <summary>
/// Mobile Network Code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Mnc
{
get
/// <summary>
/// Mobile Station Identification Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Msin
{
get
/// <summary>
/// A class which defines data for ECC information of GSM/USIM/CDMA SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimEccInfo
{
internal string NameInfo;
/// <summary>
/// Name. Applicable only for USIM(3G) SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Name
{
get
/// <summary>
/// Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Number
{
get
/// <summary>
/// Emergency service type. Applicable only for USIM(3G) SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimEccEmergencyServiceType Category
{
get
/// <summary>
/// A class which defines ECC information list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimEccInfoList
{
internal int EccCount;
/// <summary>
/// ECC count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Count
{
get
/// <summary>
/// List of ECC.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimEccInfo> EccList
{
get
/// <summary>
/// A class which defines ICCID(Integrated Circuit Card Identifier).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimIccIdInfo
{
internal int Length;
/// <summary>
/// Integrated Circuit Card number length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int IccLength
{
get
/// <summary>
/// Integrated Circuit Card number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string IccNumber
{
get
/// <summary>
/// A class which defines call forwarding indication status data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCfis
{
private int _recIndex;
/// <summary>
/// Record index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RecIndex
{
get
/// <summary>
/// MSP number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte MspNum
{
get
/// <summary>
/// Call forwarding unconditional indication status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte CfuStatus
{
get
/// <summary>
/// SIM Type of number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimTypeOfNumber Ton
{
get
/// <summary>
/// SIM numbering plan identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimNumberPlanIdentity Npi
{
get
/// <summary>
/// Dialing Number/SSC String.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CfuNum
{
get
/// <summary>
/// Capability/Configuration 2 Record Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte Cc2Id
{
get
/// <summary>
/// Extension 7 Record Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte Ext7Id
{
get
/// <summary>
/// A class which defines call forwarding indication status list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCfisList
{
internal int Count;
/// <summary>
/// Profile count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int ProfileCount
{
get
/// <summary>
/// List of CFIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimCfis> CfisList
{
get
/// <summary>
/// A class which defines CPHS call forwarding status data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCphsCf
{
private int _line1;
/// <summary>
/// CallForwardUnconditionalLine 1.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Line1
{
get
/// <summary>
/// CallForwardUnconditionalLine 2.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Line2
{
get
/// <summary>
/// CallForwardUnconditional Fax.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Fax
{
get
/// <summary>
/// CallForwardUnconditional data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Data
{
get
/// <summary>
/// A class which defines call forwarding response.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCallForwardResponse
{
internal bool IsCphsCf;
/// <summary>
/// CPHS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCphs
{
get
/// <summary>
/// List of CFIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCfisList CfList
{
get
/// <summary>
/// CPHS CF.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCphsCf CphsCf
{
get
/// <summary>
/// A class which defines call forwarding request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCallForwardRequest
{
private bool _isCphs;
/// <summary>
/// CPHS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCphs
{
get
/// <summary>
/// CFIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This should be filled only if IsCphs is false.
/// </remarks>
/// <summary>
/// CPHS CF.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This should be filled only if IsCphs is true.
/// </remarks>
/// <summary>
/// A class which defines message waiting indication status data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMwis
{
private int _recIndex;
/// <summary>
/// Record index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RecIndex
{
get
/// <summary>
/// Indicator type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte IndicatorStatus
{
get
/// <summary>
/// VoiceMail count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int VoiceCount
{
get
/// <summary>
/// Fax count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int FaxCount
{
get
/// <summary>
/// Email count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int EmailCount
{
get
/// <summary>
/// Other count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int OtherCount
{
get
/// <summary>
/// VideoMail count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int VideoCount
{
get
/// <summary>
/// A class which defines message waiting indication status list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMwisList
{
internal int Count;
/// <summary>
/// Profile count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int ProfileCount
{
get
/// <summary>
/// List of MWIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimMwis> MwList
{
get
/// <summary>
/// A class which defines CPHS message waiting status data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCphsMw
{
private bool _isVoice1;
/// <summary>
/// VoiceMsgLine1 message waiting flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsVoice1
{
get
/// <summary>
/// VoiceMsgLine2 message waiting flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsVoice2
{
get
/// <summary>
/// FAX message waiting flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsFax
{
get
/// <summary>
/// Data message waiting flag.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsData
{
get
/// <summary>
/// A class which defines message waiting reponse.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMessageWaitingResponse
{
internal bool IsCphsMw;
/// <summary>
/// CPHS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCphs
{
get
/// <summary>
/// List of MWIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimMwisList MwList
{
get
/// <summary>
/// CPHS MW.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCphsMw CphsMw
{
get
/// <summary>
/// A class which defines message waiting request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMessageWaitingRequest
{
private bool _isCphs;
/// <summary>
/// CPHS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCphs
{
get
/// <summary>
/// MWIS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This should be filled only if IsCphs is false.
/// </remarks>
/// <summary>
/// CPHS MW.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This should be filled only if IsCphs is true.
/// </remarks>
/// <summary>
/// A class which defines mailbox dialing number data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMailboxNumber
{
private bool _isCphs;
/// <summary>
/// CPHS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsCphs
{
get
/// <summary>
/// Index which stands for the location where the record is saved in SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RecIndex
{
get
/// <summary>
/// SIM profile index.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int ProfileNumber
{
get
/// <summary>
/// Mailbox type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimMailboxType MbType
{
get
/// <summary>
/// Alpha max length in SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int AlphaMaxLength
{
get
/// <summary>
/// Alpha Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string AlphaId
{
get
/// <summary>
/// Type Of Number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimTypeOfNumber Ton
{
get
/// <summary>
/// Number Plan Identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimNumberPlanIdentity Npi
{
get
/// <summary>
/// Dialing Number/SSC String.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Number
{
get
/// <summary>
/// Capability/Configuration Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte CcId
{
get
/// <summary>
/// Extension 1 Record Identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte Ext1Id
{
get
/// <summary>
/// A class which defines mailbox dialing number list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMailboxList
{
internal int MbCount;
/// <summary>
/// Mailbox count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Count
{
get
/// <summary>
/// List of mailbox.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimMailboxNumber> List
{
get
/// <summary>
/// A class which defines available optional CPHS SIM files.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCphsServiceTable
{
internal int CustomerSvcProfile;
/// <summary>
/// Customer Service Profile (CSP).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CustomerServiceProfile
{
get
/// <summary>
/// Service String Table (SST).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int ServiceStringTable
{
get
/// <summary>
/// MailBoxNumbers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int MailboxNumbers
{
get
/// <summary>
/// Short form of operator name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int OperatorNameShortForm
{
get
/// <summary>
/// Information numbers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int InformationNumbers
{
get
/// <summary>
/// A class which defines CPHS information data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCphsInfo
{
internal SimCphsPhaseType Phase;
/// <summary>
/// CPHS phase type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCphsPhaseType CphsPhase
{
get
/// <summary>
/// CPHS service table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCphsServiceTable CphsServiceTable
{
get
/// <summary>
/// A class which defines CSIM service table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCst
{
internal SimCdmaServiceTable CdmaSvc;
/// <summary>
/// Cdma service table;
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCdmaServiceTable CdmaSvcTable
{
get
/// <summary>
/// Cdma service. Gives mask value of SimCdmaService enum.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This will be filled only if CdmaSvcTable is Cdma.
/// </remarks>
/// <summary>
/// Csim service. Gives mask value of SimCsimService enum.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This will be filled only if CdmaSvcTable is Csim.
/// </remarks>
/// <summary>
/// A class which defines SIM service table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimServiceTable
{
internal SimCardType Type;
/// <summary>
/// SIM card type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimCardType SimType
{
get
/// <summary>
/// SIM service table. Gives mask value of SimSstService enum.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This will be filled only if SimType is Gsm.
/// </remarks>
/// <summary>
/// USIM service table. Gives mask value of SimUstService enum.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This will be filled only if SimType is Usim.
/// </remarks>
/// <summary>
/// CSIM service table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// This will be filled only if SimType is Ruim.
/// </remarks>
/// <summary>
/// A class which defines MSISDN information of the GSM/CDMA SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimSubscriberInfo
{
internal string MsisdnNum;
/// <summary>
/// MSISDN number. If it does not exist, a null string will be returned
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Number
{
get
/// <summary>
/// MSISDN name. If it does not exist, a null string will be returned. Not applicable for CDMA.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Name
{
get
/// <summary>
/// A class which defines MSISDN list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimMsisdnList
{
internal int MsisdnCount;
/// <summary>
/// Count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Count
{
get
/// <summary>
/// List of subscriber info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimSubscriberInfo> List
{
get
/// <summary>
/// A class which defines OPLMNwACT data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimOplmnwact
{
internal string PlmnString;
/// <summary>
/// PLMN.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Plmn
{
get
/// <summary>
/// UMTS or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsUmts
{
get
/// <summary>
/// GSM or not.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool IsGsm
{
get
/// <summary>
/// A class which defines OPLMNwACT list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimOplmnwactList
{
internal int OplmnCount;
/// <summary>
/// Count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Count
{
get
/// <summary>
/// List of OPLMNWACT.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimOplmnwact> List
{
get
/// <summary>
/// A class which defines SPN(Service Provider Name).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimSpn
{
internal byte Condition;
/// <summary>
/// Display condition.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte DisplayCondition
{
get
/// <summary>
/// Service Provider Name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Spn
{
get
/// <summary>
/// A class which defines CPHS network name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimCphsNetName
{
internal string Full;
/// <summary>
/// Full name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string FullName
{
get
/// <summary>
/// Short name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ShortName
{
get
/// <summary>
/// A class which defines authentication request data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimAuthenticationData
{
private SimAuthenticationType _authType;
/// <summary>
/// A constructor to instantiate SimAuthenticationData class with necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="authType">Authentication type.</param>
/// <param name="randLength">The length of RAND.</param>
/// <param name="autnLength">The length of AUTN. It is not used in case of GSM AUTH.</param>
/// <summary>
/// A class which defines authentication result data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimAuthenticationResponse
{
internal SimAuthenticationType Type;
/// <summary>
/// Authentication type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimAuthenticationType AuthType
{
get
/// <summary>
/// Authentication result.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimAuthenticationResult AuthResult
{
get
/// <summary>
/// Response length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int ResponseLength
{
get
/// <summary>
/// Response data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ResponseData
{
get
/// <summary>
/// The length of the authentication key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int AuthKeyLength
{
get
/// <summary>
/// The data of the authentication key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string AuthKey
{
get
/// <summary>
/// The length of the cipher key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CipherLength
{
get
/// <summary>
/// Cipher key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CipherData
{
get
/// <summary>
/// The length of the integrity key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int IntegrityLength
{
get
/// <summary>
/// Integrity key.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string IntegrityData
{
get
/// <summary>
/// A class which defines information about SIM PIN data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPinData
{
private SimPinType _type;
/// <summary>
/// A constructor to instantiate SimPinData class which necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">PIN type.</param>
/// <param name="pin">PIN code.</param>
/// <param name="pinLength">PIN code length.</param>
/// <summary>
/// A class which defines PIN information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPinResult
{
internal SimPinType PinType;
/// <summary>
/// Specifies the PIN or PUK type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimPinType Type
{
get
/// <summary>
/// Number of attempts remaining for PIN/PUK verification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RetryCount
{
get
/// <summary>
/// A class which is used to used to enable/disable facility.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimFacility
{
private SimLockType _lockType;
/// <summary>
/// A constructor to instantiate SimFacility class with necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="lockType">Facility type.</param>
/// <param name="password">Password.</param>
/// <param name="passwordLength">Password length.</param>
/// <summary>
/// A class which defines facility result data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimFacilityResult
{
internal SimLockType LockType;
/// <summary>
/// Specifies the PIN or PUK type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimLockType Type
{
get
/// <summary>
/// Number of attempts remaining for PIN/PUK verification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RetryCount
{
get
/// <summary>
/// A class which defines facility info data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimFacilityInfo
{
internal SimLockType LockType;
/// <summary>
/// Lock type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimLockType Type
{
get
/// <summary>
/// Facility status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimFacilityStatus Status
{
get
/// <summary>
/// A class which defines information about lock type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimLockInfo
{
internal SimLockType LockType;
/// <summary>
/// Lock type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimLockType Type
{
get
/// <summary>
/// Lock status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimLockStatus Status
{
get
/// <summary>
/// Retry counts.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int RetryCount
{
get
/// <summary>
/// A class which defines APDU information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimApdu
{
private byte[] _apdu;
/// <summary>
/// A constructor to instantiate SimApdu class with necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="apdu">APDU.</param>
public SimApdu(byte[] apdu)
{
/// <summary>
/// A class which defines the response of sending APDU.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimApduResponse
{
internal ushort ApduLen;
/// <summary>
/// Length of response APDU.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public ushort ApduLength
{
get
/// <summary>
/// Response APDU.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte[] ApduResponse
{
get
/// <summary>
/// A class which defines the response of sending ATR.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimAtrResponse
{
internal ushort AtrRespLen;
/// <summary>
/// Length of response ATR.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public ushort AtrRespLength
{
get
/// <summary>
/// Response ATR.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte[] AtrResponse
{
get
/// <summary>
/// A class which defines ISIM IMPU list data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimImpuList
{
internal uint DataCount;
/// <summary>
/// ISIM IMPU data count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Count
{
get
/// <summary>
/// ISIM IMPU list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<string> List
{
get
/// <summary>
/// A class which defines ISIM P-CSCF data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPcscf
{
internal SimPcscfType PcscfType;
/// <summary>
/// ISIM P-CSCF type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SimPcscfType Type
{
get
/// <summary>
/// ISIM P-CSCF data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Pcscf
{
get
/// <summary>
/// A class which defines ISIM P-CSCF list data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SimPcscfList
{
internal uint DataCount;
/// <summary>
/// ISIM P-CSCF data count.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Count
{
get
/// <summary>
/// ISIM P-CSCF list.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public IEnumerable<SimPcscf> List
{
get
/// <summary>
/// Enumeration for the SIM card status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCardStatus
{
/// <summary>
/// <summary>
/// Enumeration for the SIM card type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCardType
{
/// <summary>
/// <summary>
/// Enumeration for the language preference code.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimLanguagePreference
{
/// <summary>
/// <summary>
/// Enumeration for the security lock type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimLockType
{
/// <summary>
/// <summary>
/// Enumeration for the power state of the SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimPowerState
{
/// <summary>
/// <summary>
/// Enumeration for the file ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimFileId
{
/// <summary>
/// <summary>
/// Enumeration for the SIM number type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimTypeOfNumber
{
/// <summary>
/// <summary>
/// Enumeration for the numbering plan identifier.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimNumberPlanIdentity
{
/// <summary>
/// <summary>
/// Enumeration for the emergency service type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimEccEmergencyServiceType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM app type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimAppType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM access result from the lower layers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimAccessResult
{
/// <summary>
/// <summary>
/// Enumeration for the mailbox type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimMailboxType
{
/// <summary>
/// <summary>
/// Enumeration for the current CPHS phase of the SIM card.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCphsPhaseType
{
/// <summary>
/// <summary>
/// Enumeration for CDMA service table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCdmaServiceTable
{
/// <summary>
/// <summary>
/// Enumeration for the SIM Authentication type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimAuthenticationType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM Authentication result.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimAuthenticationResult
{
/// <summary>
/// <summary>
/// Enumeration for the PIN type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimPinType
{
/// <summary>
/// <summary>
/// Enumeration for the PIN status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimFacilityStatus
{
/// <summary>
/// <summary>
/// Enumeration for the security lock key information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimLockStatus
{
/// <summary>
/// <summary>
/// Enumeration for P-CSCF type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimPcscfType
{
/// <summary>
/// <summary>
/// Enumeration for the SIM power set result from the lower layers.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimPowerSetResult
{
/// <summary>
/// <summary>
/// Enumeration for the list of IST services in the ISIM Service Table (ISIM).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimIsimService
{
/// <summary>
/// <summary>
/// Enumeration for the list of SST services in the SIM Service Table (GSM).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimSstService
{
/// <summary>
/// <summary>
/// Enumeration for the list of UST services in the SIM Service Table (USIM).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimUstService
{
/// <summary>
/// <summary>
/// Enumeration for the list of CST services in the CDMA Service Table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCdmaService
{
/// <summary>
/// <summary>
/// Enumeration for the list of CST services in the CSIM Service Table (CSIM).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SimCsimService
{
/// <summary>
/// <summary>
/// A class which defines incoming SMS message notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SmsIncomingMessageNoti
{
internal string ScaVal;
/// <summary>
/// SCA.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Sca value represented in string.</value>
public string Sca
{
/// <summary>
/// Message length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of incoming message.</value>
public int MessageLength
{
/// <summary>
/// Data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Data representing incoming message information.</value>
public string SzData
{
/// <summary>
/// SMS format.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Format of the incoming SMS.</value>
public SmsNetType Format
{
/// <summary>
/// A class which defines incoming CB message notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SmsIncomingCbMessageNoti
{
internal SmsCbMsgType CbType;
/// <summary>
/// Cell Broadcast message type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of cell broadcast message.</value>
public SmsCbMsgType Type
{
/// <summary>
/// Size of MsgData (which is the actual TPDU message).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of message data.</value>
public short Length
{
/// <summary>
/// Cell broadcast message data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Message data representing cell broadcast message.</value>
public string SzMsgData
{
/// <summary>
/// A class which defines incoming ETWS message notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SmsIncomingEtwsMessageNoti
{
internal SmsEtwsMsgType EtwsType;
/// <summary>
/// ETWS message type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of ETWS message.</value>
public SmsEtwsMsgType Type
{
/// <summary>
/// Size of MsgData (which is the actual TPDU message).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of message data.</value>
public short Length
{
/// <summary>
/// ETWS message data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Message data representing ETWS message.</value>
public string SzMsgData
{
/// <summary>
/// Enumeration for the type of sms network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsNetType
{
/// <summary>
/// <summary>
/// Enumeration for different CB message types.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsCbMsgType
{
/// <summary>
/// <summary>
/// Enumeration for different ETWS message types.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsEtwsMsgType
{
/// <summary>
/// <summary>
/// Enumeration for memory status type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsMemoryStatus
{
/// <summary>
/// <summary>
/// Enumeration for the sms ready status type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsReadyStatus
{
/// <summary>
/// <summary>
/// Enumeration for sms status type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsMessageStatus
{
/// <summary>
/// <summary>
/// Enumeration for different response types that come in the sent status acknowledgement/notification after sending a message to the network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SmsResponse
{
/// <summary>
/// <summary>
/// A class which manages Supplementary Services of the SIM.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class Ss
{
private IntPtr _handle = IntPtr.Zero;
/// <summary>
/// A constructor to instantiate Ss class using the Tapi handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="handle">An instance of TapiHandle obtained from InitTapi in TapiManager API.</param>
/// <exception cref="ArgumentNullException">Thrown when handle is passed as null.</exception>
public Ss(TapiHandle handle)
/// <summary>
/// Sends a request to activate/deactivate call barring.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="info">The information about call barring.</param>
/// <returns>A task containing an instance of SsBarringResponse which contains information about barring response.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets call barring status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="ssClass">The type of call.</param>
/// <param name="type">The barring type.</param>
/// <returns>A task containing information about barring response.</returns>
/// <summary>
/// Allows changing of the barring password in the network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="oldPassword">The old password set for Barring in the Network.</param>
/// <param name="newPassword">The new password set for Barring in the Network.</param>
/// <param name="newPasswordAgain">The new password again.</param>
/// <summary>
/// Allows to set the (register/erase/activate/deactivate) call forwarding option at the network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="info">The Call forward information such as a forward mode, a forward type, and so on.</param>
/// <returns>A task containing information about SS forward response.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Provides an option to get the call forwarding status of different calls from the Network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="ssClass">The Forward call type.</param>
/// <param name="condition">The forward condition.</param>
/// <returns>A task containing SS forward response information.</returns>
/// <summary>
/// Activates/deactivates the call waiting service.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="info">The status of call-waiting service.</param>
/// <returns>A task containing SS waiting response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets the status of the call waiting service.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="ssClass">The call types.</param>
/// <returns>A task containing information about SS waiting response.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Activates/deactivates the status of the calling line identity service.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The Cli service type.</param>
/// <param name="status">The Cli Status.</param>
/// <returns>A task indicating whether setting of CLI status is done or not.</returns>
/// <summary>
/// Gets the status of the calling line identity service.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="type">The Cli service type.</param>
/// <returns>A task containing SS CLI response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Sends a USSD string or User response to the Network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="info">The data coding scheme used</param>
/// <returns>A task containing SS USSD response information.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// A class which defines values for USSD request type. Applicable to 3GPP(GSM/UMTS/LET) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsUssdMsgInfo
{
private SsUssdType _type;
/// <summary>
/// USSD type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of USSD represented in SsUssdType enum.</value>
public SsUssdType Type
{
/// <summary>
/// DCS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Dcs value represented in byte.</value>
public byte Dcs
{
/// <summary>
/// USSD string length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of USSD string in integer.</value>
public int Length
{
/// <summary>
/// USSD string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Ussd string represented in string.</value>
public string UssdString
{
/// <summary>
/// A class which defines release complete message notification type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsReleaseCompleteMsgInfo
{
internal byte Length;
/// <summary>
/// Specifies the Release complete messageg length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Length of release complete message in byte.</value>
public byte MsgLength
{
/// <summary>
/// Specifies the release complete message.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Release complete message represented in byte array.</value>
public byte[] Message
{
/// <summary>
/// A class which defines SS forward record information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsForwardRecord
{
internal SsClass SsClass;
/// <summary>
/// SS class
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SS class type.</value>
public SsClass Class
{
/// <summary>
/// Call forwarding SS status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Status of SS call forwarding.</value>
public SsStatus Status
{
/// <summary>
/// Call forward types providing various conditions when a call can be forwarded.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Forwarding condition of SS call forward.</value>
public SsForwardCondition ForwardCondition
{
/// <summary>
/// Flag that indicates whether call forwarding number is present.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Boolean value to check the presence of call forwarding number.</value>
public bool IsForwardingNumberPresent
{
/// <summary>
/// No reply time.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Waiting time when there is no reply.</value>
public SsNoReplyTime NoReplyTime
{
/// <summary>
/// Type of number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SS call forward type of number.</value>
public SsForwardTypeOfNumber Ton
{
/// <summary>
/// Numbering Plan Identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SS call forward numbering plan identity.</value>
public SsForwardNumberingPlanIdentity Npi
{
/// <summary>
/// Forwarded number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Call forwarding number.</value>
public string ForwardingNumber
{
/// <summary>
/// A class which defines values for SS call forwarding record. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsForwardResponse
{
internal int RecordNum;
/// <summary>
/// Record number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Record value represented in integer.</value>
public int RecordNumber
{
/// <summary>
/// Specifies the maximum of SS forward records.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of instances of SsForwardRecord.</value>
public IEnumerable<SsForwardRecord> Record
{
/// <summary>
/// A class which defines SS call barring record information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsBarringRecord
{
internal SsClass SsClass;
/// <summary>
/// SS class
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SS class type.</value>
public SsClass Class
{
/// <summary>
/// SS status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Status of SS call barring.</value>
public SsStatus Status
{
/// <summary>
/// Call barring types providing various barring conditions on which calls are barred.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Type of SS call barring.</value>
public SsBarringType BarringType
{
/// <summary>
/// A class which defines values for SS call barring record. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsBarringResponse
{
internal int RecordNum;
/// <summary>
/// Record number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Record value represented in integer.</value>
public int RecordNumber
{
/// <summary>
/// Specifies the maximum of SS barring records.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of instances of SsBarringRecord.</value>
public IEnumerable<SsBarringRecord> Record
{
/// <summary>
/// A class which defines SS waiting record information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsWaitingRecord
{
internal SsClass SsClass;
/// <summary>
/// SS class
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>SS class type.</value>
public SsClass Class
{
/// <summary>
/// SS status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Status of SS call waiting.</value>
public SsStatus Status
{
/// <summary>
/// A class which defines values for SS call waiting record. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsWaitingResponse
{
internal int RecordNum;
/// <summary>
/// Record number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Record value represented in integer.</value>
public int RecordNumber
{
/// <summary>
/// Specifies the maximum of SS waiting records.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>A list of instances of SsWaitingRecord.</value>
public IEnumerable<SsWaitingRecord> Record
{
/// <summary>
/// A class which defines SUPS information message notification type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsInfo
{
internal SsCause Cse;
/// <summary>
/// SS error cause.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Ss request result.</value>
public SsCause Cause
{
/// <summary>
/// SUPS information.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Ss information type.</value>
public SsInfoType SsType
{
/// <summary>
/// A class which defines parameters related to call barring.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsBarringInfo
{
private SsClass _class;
/// <summary>
/// A constructor for instantiating SsBarringInfo class with the necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="classType">Call type.</param>
/// <param name="mode">Barring mode.</param>
/// <param name="type">Barring type.</param>
/// <summary>
/// A class which defines the parameters related to forward info.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsForwardInfo
{
private SsClass _class;
/// <summary>
/// A constructor for instantiating SsForwardInfo class with the necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="classType">SS Class.</param>
/// <param name="mode">Forward Mode.</param>
/// <param name="condition">Forward Condition.</param>
/// <summary>
/// A class which defines parameters related to call waiting.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsWaitingInfo
{
private SsClass _class;
/// <summary>
/// A constructor for instantiating SsWaitingInfo class with necessary parameters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="ssClass">Call type.</param>
/// <param name="mode">Call waiting mode.</param>
public SsWaitingInfo(SsClass ssClass, SsCallWaitingMode mode)
/// <summary>
/// A class which defines values for calling line identity service. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsCliResponse
{
internal SsLineIdentificationType LineType;
/// <summary>
/// Various line identification types.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SsLineIdentificationType Type
{
get
/// <summary>
/// Line identification status from the network.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SsCliStatus Status
{
get
/// <summary>
/// A class which defines USSD response data. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SsUssdResponse
{
internal SsUssdType UssdType;
/// <summary>
/// USSD Type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SsUssdType Type
{
get
/// <summary>
/// USSD Status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public SsUssdStatus Status
{
get
/// <summary>
/// DCS.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public byte Dcs
{
get
/// <summary>
/// USSD string length.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int Length
{
get
/// <summary>
/// USSD String.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string UssdString
{
get
/// <summary>
/// Enumeration for the SS class type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsClass
{
/// <summary>
/// <summary>
/// Enumeration for various types of call barring.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsBarringType
{
/// <summary>
/// <summary>
/// Enumeration for the CLI service type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsCliType
{
/// <summary>
/// <summary>
/// Enumeration for the CLI service status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsCliStatus
{
/// <summary>
/// <summary>
/// Enumeration for the call forwarding condition.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsForwardCondition
{
/// <summary>
/// <summary>
/// Enumeration for the USSD type. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsUssdType
{
/// <summary>
/// <summary>
/// Enumeration for the status of a supplementary service feature (e.g. call forwarding or call barring).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// These enumerated values should be used as masks.
/// </remarks>
/// <summary>
/// Enumeration for no-reply time. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsNoReplyTime
{
/// <summary>
/// <summary>
/// Enumeration for the call forwarding type of number.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsForwardTypeOfNumber
{
/// <summary>
/// <summary>
/// Enumeration for the call forward numbering plan identity.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsForwardNumberingPlanIdentity
{
/// <summary>
/// <summary>
/// Enumeration for the supplementary service request results.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsCause
{
/// <summary>
/// <summary>
/// Enumeration for SS info type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsInfoType
{
/// <summary>
/// <summary>
/// Enumeration for the call barring operation mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsBarringMode
{
/// <summary>
/// <summary>
/// Enumeration for the forward mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsForwardMode
{
/// <summary>
/// <summary>
/// Enumeration for the call waiting mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsCallWaitingMode
{
/// <summary>
/// <summary>
/// Enumeration for the types of identity presentation / restriction services.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsLineIdentificationType
{
/// <summary>
/// <summary>
/// Enumeration for the USSD indication type. Applicable to 3GPP(GSM/UMTS/LTE) only.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SsUssdStatus
{
/// <summary>
/// <summary>
/// Enumerations for the types of Notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum Notification
{
/// <summary>
/// <summary>
/// Enumerations for the types of property definition.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum Property
{
/// <summary>
/// <summary>
/// An extended EventArgs class which contains changed tapi state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class StateChangedEventArgs : EventArgs
{
private int _state;
/// <summary>
/// Tapi ready state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int State
{
get
/// <summary>
/// An extended EventArgs class which contains changed TAPI notification.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NotificationChangedEventArgs : EventArgs
{
private Notification _id;
/// <summary>
/// Notification Id.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Notification Id
{
get
/// <summary>
/// Notification data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public object Data
{
get
/// <summary>
/// An extended EventArgs class which contains changed TAPI property.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PropertyChangedEventArgs : EventArgs
{
private Property _property;
/// <summary>
/// Property definition type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Property Property
{
get
/// <summary>
/// Property data.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public object Data
{
get
/// <summary>
/// This class is used for managing event callbacks for notifications and properties.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class TapiHandle
{
internal IntPtr _handle = IntPtr.Zero;
/// <summary>
/// This event is called for the TAPI notification change.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<NotificationChangedEventArgs> NotificationChanged
{
add
/// <summary>
/// This event is called for the TAPI property change.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<PropertyChangedEventArgs> PropertyChanged
{
add
/// <summary>
/// Registers a notification callback for notification change events on DBus interface.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="id">Notification id for which a callback has to be registered.</param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <summary>
/// Registers a notification callback for property change events on DBus interface.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="property">Property definition for which a callback has to be registered.</param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <summary>
/// Deregisters notification callback for notification change events on DBus interface.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="id">Notification id for which the callback has to be de-registered.</param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <summary>
/// Deregisters notification callback for property change events on DBus interface.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="property">Property definition for which the callback has to be de-registered.</param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <summary>
/// Gets the property value in an integer format for the given property.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="property">The property to be retrieved from Dbus.</param>
/// <returns>The property value in integer format.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Gets the property value in a string format for the given property.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="property">The property to be retrieved from Dbus.</param>
/// <returns>The property value in string format.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// This class is used for initializing/deinitializing Tapi and manages the state of it.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class TapiManager
{
private static event EventHandler<StateChangedEventArgs> s_stateChanged;
/// <summary>
/// Gets the state value if tapi is ready.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>The State value in integer format - 0 is False and 1 is True. Returns -1 in case of error.</value>
public static int State
{
/// <summary>
/// This event is raised when Tapi ready state changes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static event EventHandler<StateChangedEventArgs> StateChanged
{
add
/// <summary>
/// Fetches a list of available CPs.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>List of available CPs in case of success. Null in case of failure.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
public static IEnumerable<string> GetCpNames()
/// <summary>
/// Acquires a TAPI Handle for the specified CP name.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="cpName">The CP Name against which a TAPI handle is required (A NULL CP Name will return a #TapiHandle bound to the first CP in the list of available CPs).</param>
/// <returns>Instance of TapiHandle on success, null on failure.</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <summary>
/// Deinitializes the TAPI Handle.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">Thrown when telephony feature is not supported.</exception>
/// <exception cref="ArgumentException">Thrown when it is failed due to invalid parameter.</exception>
namespace ElmSharp.Wearable
{
/// <summary>
- /// The Circle DateTime Selector is a widget to display and handle datetime value by the Rotary event.
- /// Inherits <see cref="DateTimeSelector"/>.
+ /// The Circle DateTime Selector is a widget to display and handle datetime value by rotary event
+ /// Inherits <see cref="DateTimeSelector"/>
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleDateTimeSelector : DateTimeSelector, IRotaryActionWidget
CircleSurface _surface;
/// <summary>
- /// Creates and initializes a new instance of the Circle DateTime class.
+ /// Creates and initializes a new instance of the Circle DateTime class
/// </summary>
- /// <param name="parent">The parent of the new Circle DateTime instance.</param>
+ /// <param name="parent">The parent of new Circle DateTime instance</param>
/// <param name="surface">The surface for drawing circle features for this widget.</param>
/// <since_tizen> preview </since_tizen>
public CircleDateTimeSelector(EvasObject parent, CircleSurface surface) : base()
/// <summary>
/// Creates and initializes a new instance of the Circle DateTimeSelector class.
/// </summary>
- /// <param name="parent">The parent of the new Circle DateTimeSelector instance.</param>
+ /// <param name="parent">The parent of new Circle CircleDateTimeSelector instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => _circleHandle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the color of the marker.
+ /// Sets or gets the color of the marker
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color MarkerColor
}
/// <summary>
- /// Sets or gets the line width of the marker.
+ /// Sets or gets the line width of the marker
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MarkerLineWidth
}
/// <summary>
- /// Sets or gets the radius at which the center of the marker lies.
+ /// Sets or gets the radius at which the center of the marker lies
/// </summary>
/// <since_tizen> preview </since_tizen>
public double MarkerRadius
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp.Wearable
{
/// <summary>
- /// The Circle GenList Selector is a widget to display and handle the genlist items by the Rotary event.
- /// Inherits <see cref="GenList"/>.
+ /// The Circle GenList Selector is a widget to display and handle genlist items by rotary event
+ /// Inherits <see cref="GenList"/>
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleGenList : GenList, IRotaryActionWidget
CircleSurface _surface;
/// <summary>
- /// Creates and initializes a new instance of the Circle GenList class.
+ /// Creates and initializes a new instance of the Circle GenList class
/// </summary>
- /// <param name="parent">The parent of the new Circle GenList instance.</param>
- /// <param name="surface">The surface for drawing the circle features for this widget.</param>
+ /// <param name="parent">The parent of new Circle GenList instance</param>
+ /// <param name="surface">The surface for drawing circle features for this widget.</param>
/// <since_tizen> preview </since_tizen>
public CircleGenList(EvasObject parent, CircleSurface surface) : base()
{
/// <summary>
/// Creates and initializes a new instance of the Circle GenList class.
/// </summary>
- /// <param name="parent">The parent of the new Circle CircleGenList instance.</param>
+ /// <param name="parent">The parent of new Circle CircleGenList instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => _circleHandle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the color of the scroll background.
+ /// Sets or gets the color of the scroll background
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color VerticalScrollBackgroundColor
}
/// <summary>
- /// Sets or gets the line width of the scroll background.
+ /// Sets or gets the line width of the scroll background
/// </summary>
/// <since_tizen> preview </since_tizen>
public int VerticalScrollBackgroundLineWidth
}
/// <summary>
- /// Sets or gets the radius of the scroll background.
+ /// Sets or gets the redius of the scroll background
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalScrollBackgroundRadius
}
/// <summary>
- /// Sets or gets the color of the scrollbar.
+ /// Sets or gets the color of the scroll bar
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color VerticalScrollBarColor
}
/// <summary>
- /// Sets or gets the line width of the scrollbar.
+ /// Sets or gets the line width of the scroll bar
/// </summary>
/// <since_tizen> preview </since_tizen>
public int VerticalScrollBarLineWidth
}
/// <summary>
- /// Sets or gets the radius of the scrollbar.
+ /// Sets or gets the redius of the scroll bar
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalScrollBarRadius
}
/// <summary>
- /// Sets or gets the policy if the scrollbar is visible.
+ /// Sets or gets the policy if the scroll bar is visible
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, or otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
- /// The Circle ProgressBar is a widget for visually representing the progress status of a given job or task with the circular design.
+ /// The Circle ProgressBar is a widget for visually representing the progress status of a given job/task with the circular design.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleProgressBar : Widget, ICircleWidget
/// <summary>
/// Creates and initializes a new instance of the Circle Progressbar class.
/// </summary>
- /// <param name="parent">The parent of the new Circle Progressbar instance.</param>
+ /// <param name="parent">The parent of new Circle Progressbar instance</param>
/// <param name="surface">The surface for drawing circle features for this widget.</param>
/// <since_tizen> preview </since_tizen>
public CircleProgressBar(EvasObject parent, CircleSurface surface) : base()
/// <summary>
/// Creates and initializes a new instance of the Circle Progressbar class.
/// </summary>
- /// <param name="parent">The parent of the new Circle Progressbar instance.</param>
+ /// <param name="parent">The parent of new Circle Progressbar instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => Handle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the value of the ProgressBar.
+ /// Sets or gets the value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Value
}
/// <summary>
- /// Sets or gets the maximum value of the ProgressBar.
+ /// Sets or gets the maximum value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Maximum
}
/// <summary>
- /// Sets or gets the minimum value of the ProgressBar.
+ /// Sets or gets the minimum value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Minimum
}
/// <summary>
- /// Sets or gets the angle value of the ProgressBar.
+ /// Sets or gets the angle value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarAngle
}
/// <summary>
- /// Sets or gets the angle value of the Background ProgressBar.
+ /// Sets or gets the angle value of Background ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BackgroundAngle
}
/// <summary>
- /// Sets or gets the angle offset value of the ProgressBar.
+ /// Sets or gets the angle offset value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarAngleOffset
}
/// <summary>
- /// Sets or gets the angle offset value of the Background ProgressBar.
+ /// Sets or gets the angle offset value of Background ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BackgroundAngleOffset
}
/// <summary>
- /// Sets or gets the maximum angle value of the ProgressBar.
+ /// Sets or gets the maximum angle value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarAngleMaximum
}
/// <summary>
- /// Sets or gets the minimum angle value of the ProgressBar.
+ /// Sets or gets the minimum angle value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarAngleMinimum
}
/// <summary>
- /// Sets or gets the color of the ProgressBar.
+ /// Sets or gets color of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color BarColor
}
/// <summary>
- /// Sets or gets the color of the Background ProgressBar.
+ /// Sets or gets color of Background ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
}
/// <summary>
- /// Sets or gets the line width of the ProgressBar.
+ /// Sets or gets line width of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BarLineWidth
}
/// <summary>
- /// Sets or gets the line width of the Background ProgressBar.
+ /// Sets or gets line width of Background ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BackgroundLineWidth
}
/// <summary>
- /// Sets or gets the radius of the ProgressBar.
+ /// Sets or gets radius of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarRadius
}
/// <summary>
- /// Sets or gets the radius of the Background ProgressBar.
+ /// Sets or gets radius of Background ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BackgroundRadius
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp.Wearable
{
/// <summary>
- /// Circle scroller provides the scrollbar with a circular movement, and is scrolled by the Rotary event.
+ /// Circle scroller provides scrollbar with circular movement and is scrolled by rotary event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleScroller : Scroller, IRotaryActionWidget
/// <summary>
/// Creates and initializes a new instance of the Circle Scroller class.
/// </summary>
- /// <param name="parent">The parent of the new Circle CircleScroller instance.</param>
+ /// <param name="parent">The parent of new Circle CircleScroller instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => _circleHandle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy.
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the color of the vertical scroll bar.
+ /// Sets or gets color of the vertical scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color VerticalScrollBarColor
}
/// <summary>
- /// Sets or gets the color of the horizontal scroll bar.
+ /// Sets or gets color of the horizontal scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color HorizontalScrollBarColor
}
/// <summary>
- /// Sets or gets the color of the vertical scroll background.
+ /// Sets or gets color of the vertical scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color VerticalScrollBackgroundColor
}
/// <summary>
- /// Sets or gets the color of the horizontal scroll background.
+ /// Sets or gets color of the horizontal scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color HorizontalScrollBackgroundColor
}
/// <summary>
- /// Sets or gets the line width of the vertical scroll bar.
+ /// Sets or gets line width of the vertical scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int VerticalScrollBarLineWidth
}
/// <summary>
- /// Sets or gets the line width of the horizontal scroll bar.
+ /// Sets or gets line width of the horizontal scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int HorizontalScrollBarLineWidth
}
/// <summary>
- /// Sets or gets the line width of the vertical scroll background.
+ /// Sets or gets line width of the vertical scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int VerticalScrollBackgroundLineWidth
}
/// <summary>
- /// Sets or gets the line width of the horizontal scroll background.
+ /// Sets or gets line width of the horizontal scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int HorizontalScrollBackgroundLineWidth
}
/// <summary>
- /// Sets or gets the radius of the vertical scroll bar.
+ /// Sets or gets radius of the vertical scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalScrollBarRadius
}
/// <summary>
- /// Sets or gets the radius of the horizontal scroll bar.
+ /// Sets or gets radius of the horizontal scroll bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double HorizontalScrollBarRadius
}
/// <summary>
- /// Sets or gets the radius of the vertical scroll background.
+ /// Sets or gets radius of the vertical scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalScrollBackgroundRadius
}
/// <summary>
- /// Sets or gets the radius of the horizontal scroll background.
+ /// Sets or gets radius of the horizontal scroll background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double HorizontalScrollBackgroundRadius
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp.Wearable
{
/// <summary>
- /// Circle slider is a circular designed widget used to select a value in a range by the Rotary event.
+ /// Circle slider is circular designed widget to select a value in a range by rotary event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleSlider : Widget, IRotaryActionWidget
/// Creates and initializes a new instance of the CircleSlider class.
/// </summary>
/// <param name="parent">The EvasObject to which the new CircleSlider will be attached as a child.</param>
- /// <param name="surface">The surface for drawing the circle features for this widget.</param>
+ /// <param name="surface">The surface for drawing circle features for this widget.</param>
/// <since_tizen> preview </since_tizen>
public CircleSlider(EvasObject parent, CircleSurface surface) : base()
{
/// <summary>
/// Creates and initializes a new instance of the Circle Slider class.
/// </summary>
- /// <param name="parent">The parent of the new Circle CircleSlider instance.</param>
+ /// <param name="parent">The parent of new Circle CircleSlider instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ValueChanged;
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => RealHandle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
/// Sets or gets the step by which the circle slider bar moves.
/// </summary>
/// <remarks>
- /// This value is used when the circle slider value is changed by a drag or the Rotary event.
+ /// This value is used when circle slider value is changed by an drag or rotary event
/// The value of the slider is increased/decreased by the step value.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the color of the circle slider bar.
+ /// Sets or gets color of the circle slider bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color BarColor
}
/// <summary>
- /// Sets or gets the color of the circle slider background.
+ /// Sets or gets color of the circle slider background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
}
/// <summary>
- /// Sets or gets the line width of the circle slider bar.
+ /// Sets or gets the line with of the circle slider bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BarLineWidth
}
/// <summary>
- /// Sets or gets the line width of the circle slider background.
+ /// Sets or gets the line with of the circle slider background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BackgroundLineWidth
/// <summary>
/// Sets or gets the angle offset for the slider bar.
- /// Offset value means start position of the slider bar.
+ /// offset value means start position of the slider bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BarAngleOffset
/// <summary>
/// Sets or gets the angle offset for the circle slider background.
- /// Offset value means start position of the slider background.
+ /// offset value means start position of the slider background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BackgroundAngleOffset
/// </summary>
/// <remarks>
/// This defines the allowed minimum values to be selected by the user.
- /// If the actual value is less than the minimum value, it is updated to the minimum value.
- /// Actual value can be obtained with Value. By default, minimum value is equal to 0.0.
+ /// If the actual value is less than min, it is updated to min.
+ /// Actual value can be obtained with Value.By default, min is equal to 0.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Minimum
/// </summary>
/// <remarks>
/// This defines the allowed maximum values to be selected by the user.
- /// If the actual value is bigger than the maximum value, it is updated to the maximum value.
- /// Actual value can be obtained with Value. By default, the minimum value is equal to 0.0, and the maximum value is equal to 1.0.
+ /// If the actual value is bigger then max, it is updated to max.
+ /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0.
/// Maximum must be greater than minimum, otherwise the behavior is undefined.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// Gets or sets the value displayed by the circle slider.
/// </summary>
/// <remarks>
- /// The value must be between minimum and maximum.
+ /// The value must to be between Minimum and Maximum values.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Value
}
/// <summary>
- /// The callback of the Realized event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
- /// The Circle Spinner is a widget to display and handle the spinner value by the Rotary event.
+ /// The Circle Spinner is a widget to display and handle spinner value by rotary event
/// Inherits <see cref="Spinner"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the Circle Spinner class.
/// </summary>
- /// <param name="parent">The parent of the new Circle Spinner instance.</param>
+ /// <param name="parent">The parent of new Circle Spinner instance</param>
/// <param name="surface">The surface for drawing circle features for this widget.</param>
/// <since_tizen> preview </since_tizen>
public CircleSpinner(EvasObject parent, CircleSurface surface) : base()
/// <summary>
/// Creates and initializes a new instance of the Circle Spinner class.
/// </summary>
- /// <param name="parent">The parent of the new Circle Spinner instance.</param>
+ /// <param name="parent">The parent of new Circle CircleSpinner instance</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")]
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the handle for Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual IntPtr CircleHandle => _circleHandle;
/// <summary>
- /// Gets the handle for the circle surface used in this widget.
+ /// Gets the handle for Circle Surface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual CircleSurface CircleSurface => _surface;
}
/// <summary>
- /// Sets or gets the disabled state of this widget.
+ /// Sets or gets disabled state of this widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Use IsEnabled")]
}
/// <summary>
- /// Sets or gets the line width of the marker.
+ /// Sets or gets the line width of the marker
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MarkerLineWidth
}
/// <summary>
- /// Sets or gets the color of the marker.
+ /// Sets or gets the color of the marker
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color MarkerColor
}
/// <summary>
- /// Sets or gets the radius at which the center of the marker lies.
+ /// Sets or gets the radius at which the center of the marker lies
/// </summary>
/// <since_tizen> preview </since_tizen>
public double MarkerRadius
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp.Wearable
{
/// <summary>
- /// The CircleSurface presents a surface for drawing the circular feature of circle widgets.
+ /// The CircleSurface presents a surface for drawing circular feature of circle widgets
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CircleSurface
IntPtr _handle;
/// <summary>
- /// Creates and initializes a new instance of the CircleSurface class with a surface on the Conformant widget.
+ /// Creates and initializes a new instance of the CircleSurface class with surface on the Conformant widget.
/// </summary>
- /// <param name="conformant">The Conformant widget to create a surface.</param>
+ /// <param name="conformant">Conformant widget to create a surface.</param>
/// <since_tizen> preview </since_tizen>
public CircleSurface(Conformant conformant)
{
}
/// <summary>
- /// Creates and initializes a new instance of the CircleSurface class with a surface on the Layout widget.
+ /// Creates and initializes a new instance of the CircleSurface class with surface on the Layout widget.
/// </summary>
- /// <param name="layout">The Layout widget to create a surface.</param>
+ /// <param name="layout">Layout widget to create a surface.</param>
/// <since_tizen> preview </since_tizen>
public CircleSurface(Layout layout)
{
}
/// <summary>
- /// Creates and initializes a new instance of the CircleSurface class with a surface on the Naviframe widget.
+ /// Creates and initializes a new instance of the CircleSurface class with surface on the Naviframe widget.
/// </summary>
- /// <param name="naviframe">The Naviframe widget to create a surface.</param>
+ /// <param name="naviframe">Naviframe widget to create a surface.</param>
/// <since_tizen> preview </since_tizen>
public CircleSurface(Naviframe naviframe)
{
}
/// <summary>
- /// Creates and initializes a new instance of the CircleSurface class with no surface.
+ /// Creates and initializes a new instance of the CircleSurface class with no surface
/// </summary>
/// <since_tizen> preview </since_tizen>
public CircleSurface()
}
/// <summary>
- /// Gets the handle for CircleSurface.
+ /// Gets the handle for CircleSurface
/// </summary>
/// <since_tizen> preview </since_tizen>
public IntPtr Handle => _handle;
/// <summary>
- /// Deletes the given CircleSurface.
+ /// Delete the given CirclrSurface
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Delete()
namespace ElmSharp.Wearable
{
/// <summary>
- /// The ICircleWidget is the interface for a widget to display and handle with the CircleSurface.
+ /// The ICircleWidget is the interface for a widget to display and handle with circle surface
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface ICircleWidget
{
/// <summary>
- /// Gets the handle for the Circle widget.
+ /// Gets the handle for Circle Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
IntPtr CircleHandle { get; }
/// <summary>
- /// Gets the CircleSurface used in this widget.
+ /// Gets the CircleSurface used in this widget
/// </summary>
/// <since_tizen> preview </since_tizen>
CircleSurface CircleSurface { get; }
}
/// <summary>
- /// The IRotaryActionWidget is the interface for a widget that has action by the Rotary event.
+ /// The IRotaryActionWidget is the interface for a widget has action by rotary event
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IRotaryActionWidget : ICircleWidget
namespace ElmSharp.Wearable
{
/// <summary>
- /// The MoreOption is a widget composed of the toggle (cue button) and more option view that can change a visibility through the toggle.
+ /// The MoreOption is a widget composed of the toggle(cue button) and more option view, and MoreOption can change a visibility through the toggle.
/// Inherits Layout
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MoreOption : Layout
{
/// <summary>
- /// Sets or gets the list of the more option item.
+ /// Sets or gets the list of more option item
/// </summary>
/// <since_tizen> preview </since_tizen>
public IList<MoreOptionItem> Items { get; private set; }
/// <since_tizen> preview </since_tizen>
public event EventHandler<MoreOptionItemEventArgs> Clicked;
/// <summary>
- /// Opened will be triggered when the more option view is shown.
+ /// Opened will be triggered when more option view is shown.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Opened;
/// <summary>
- /// Closed will be triggered when the more option view is hidden.
+ /// Closed will be triggered when more option view is hidden.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Closed;
SmartEvent _closedEvent;
/// <summary>
- /// Creates and initializes a new instance of the MoreOption class.
+ /// Creates and initializes a new instance of MoreOption class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the MoreOption as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by MoreOption as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public MoreOption(EvasObject parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Sets or gets the visibility of the more option view.
+ /// Sets or gets the visibility of more option view.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsOpened
}
/// <summary>
- /// Enumeration for the more option direction types.
+ /// Enumeration for More Option Direction type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum MoreOptionDirection
{
/// <summary>
- /// Top direction.
+ /// Top direction
/// </summary>
Top,
/// <summary>
- /// Bottom direction.
+ /// Bottom direction
/// </summary>
Bottom,
/// <summary>
- /// Left direction.
+ /// Left direction
/// </summary>
Left,
/// <summary>
- /// Right direction.
+ /// Right direction
/// </summary>
Right
}
namespace ElmSharp.Wearable
{
/// <summary>
- /// The MoreOptionItem is an item of the MoreOption widget.
+ /// The MoreOptionItem is a item of MoreOption widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MoreOptionItem
}
/// <summary>
- /// Creates and initializes a new instance of the MoreOptionItem class.
+ /// Creates and initializes a new instance of MoreOptionItem class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MoreOptionItem()
}
/// <summary>
- /// Sets or gets the main text of the more option object.
+ /// Sets or gets the main text of a more option object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string MainText
}
/// <summary>
- /// Sets or gets the subtext of the more option object.
+ /// Sets or gets the sub text of a more option object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string SubText
}
/// <summary>
- /// Sets or gets the icon image.
+ /// Sets or gets the icon image
/// </summary>
/// <since_tizen> preview </since_tizen>
public Image Icon
namespace ElmSharp.Wearable
{
/// <summary>
- /// The MoreOptionItemEventArgs is an event arguments class for the MoreOptionItem.
+ /// The MoreOptionItemEventArgs is a event args class for MoreOptionItem.
/// Inherits EventArgs
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MoreOptionItemEventArgs : EventArgs
{
/// <summary>
- /// Sets or gets the more option item.
+ /// Sets or gets the more option item
/// </summary>
/// <since_tizen> preview </since_tizen>
public MoreOptionItem Item { get; set; }
List<MoreOptionItem> Items { get; set; }
/// <summary>
- /// Sets or gets the count of items.
+ /// Sets or gets the count of Items
/// </summary>
public int Count => Items.Count;
/// <summary>
- /// Sets or gets whether it is read-only.
+ /// Sets or gets whether it is read only
/// </summary>
public bool IsReadOnly => false;
/// <summary>
- /// Sets or gets the item with the index.
+ /// Sets or gets the item with the index
/// </summary>
- /// <param name="index">The position of item in items.</param>
- /// <returns>MoreOptionItem object on the index.</returns>
+ /// <param name="index">the position of item in items</param>
+ /// <returns></returns>
public MoreOptionItem this[int index]
{
get
}
/// <summary>
- /// Creates and initializes a new instance of the MoreOptionList class.
+ /// Creates and initializes a new instance of MoreOptionList class.
/// </summary>
- /// <param name="owner">The object of more option.</param>
+ /// <param name="owner">the object of more option</param>
public MoreOptionList(MoreOption owner)
{
Owner = owner;
}
/// <summary>
- /// Appends a new item to the more option.
+ /// Append a new item to a more option.
/// </summary>
- /// <param name="item">The more option item.</param>
+ /// <param name="item">The more option item</param>
public void Add(MoreOptionItem item)
{
item.Handle = Interop.Eext.eext_more_option_item_append(Owner);
}
/// <summary>
- /// Adds a new item to the more option at the first.
+ /// add a new item to a more option at the first.
/// </summary>
- /// <param name="item">The more option item.</param>
+ /// <param name="item">The more option item</param>
public void AddFirst(MoreOptionItem item)
{
item.Handle = Interop.Eext.eext_more_option_item_prepend(Owner);
}
/// <summary>
- /// Adds a new item to the more option at the last.
+ /// add a new item to a more option at the last.
/// </summary>
- /// <param name="item">The more option item.</param>
+ /// <param name="item">The more option item</param>
public void AddLast(MoreOptionItem item)
{
Add(item);
}
/// <summary>
- /// Get the index of an item.
+ /// Get the index of item
/// </summary>
- /// <param name="item">The more option item.</param>
- /// <returns>The index of an item.</returns>
+ /// <param name="item">The more option item</param>
+ /// <returns>the index of item</returns>
public int IndexOf(MoreOptionItem item)
{
return Items.IndexOf(item);
}
/// <summary>
- /// Inserts a new item into the more option, after the more option item with the index.
+ /// Insert a new item into the more option after more option item with the index.
/// </summary>
- /// <param name="index">The index of an item, which is inserted after.</param>
- /// <param name="item">The more option item.</param>
+ /// <param name="index">the index of item which is insert after</param>
+ /// <param name="item">The more option item</param>
public void Insert(int index, MoreOptionItem item)
{
if (Items.Count < index + 1 || index < 0)
}
/// <summary>
- /// Deletes an item, which is the given item index.
+ /// Delete an item which is the given item index
/// </summary>
/// <param name="index">the item index which will be deleted</param>
public void RemoveAt(int index)
}
/// <summary>
- /// Removes all the items from a given more option list object.
+ /// Remove all items from a given more option list object.
/// </summary>
public void Clear()
{
}
/// <summary>
- /// Checks the item whether it is contained.
+ /// Check the item whether is contained
/// </summary>
- /// <param name="item">The more option item.</param>
- /// <returns>If contained return true, otherwise false.</returns>
+ /// <param name="item">The more option item</param>
+ /// <returns>If contain return true, otherwise false</returns>
public bool Contains(MoreOptionItem item)
{
return Items.Contains(item);
}
/// <summary>
- /// Copies the items.
+ /// Copy Items
/// </summary>
- /// <param name="array">The target array.</param>
- /// <param name="arrayIndex">The index to which the item will be copied.</param>
+ /// <param name="array">the target array</param>
+ /// <param name="arrayIndex">which index the item will copy to</param>
public void CopyTo(MoreOptionItem[] array, int arrayIndex)
{
Items.CopyTo(array, arrayIndex);
}
/// <summary>
- /// Removes the item.
+ /// Remove a item
/// </summary>
- /// <param name="item">The item will be removed.</param>
- /// <returns>If removed is successful return true, otherwise false.</returns>
+ /// <param name="item">the item will be removed</param>
+ /// <returns>if remove success return true, otherwise false</returns>
public bool Remove(MoreOptionItem item)
{
if (Items.Contains(item))
}
/// <summary>
- /// Returns an enumerator that iterates through IEnumerator.
+ /// Return an enumerator that iterates through IEnumerator
/// </summary>
/// <returns></returns>
public IEnumerator<MoreOptionItem> GetEnumerator()
namespace ElmSharp.Wearable
{
/// <summary>
- /// The RotaryEventManager serves functions for the global Rotary event like Galaxy Gear.
+ /// RotaryEventManager serve functions for global Rotary event like Galaxy Gear.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class RotaryEventManager
static Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb> s_rotaryEventHandlers = new Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb>();
/// <summary>
- /// Rotated will be triggered when the rotatable device like the Galaxy Gear Bezel is rotated.
+ /// Rotated will triggered when rotatable device like Galaxy Gear Bezel is rotated.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static event RotaryEventHandler Rotated
/// <summary>
- /// The RotaryEventManager serves extension functions for the Rotary event to EvasObject on a device like Galaxy Gear.
+ /// RotaryEventManager serve extension functions for Rotary event to EvasObject on device like Galaxy Gear.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class RotaryEventExtensions
static Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb> s_rotaryObjectEventMap = new Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb>();
/// <summary>
- /// Adds a handler for the Rotary event on a specific EvasObject.
+ /// Add a handler for Rotary event on specific EvasObject.
/// </summary>
- /// <param name="obj">Target EvasObject.</param>
- /// <param name="handler">Event handler for the Rotary event.</param>
+ /// <param name="obj">Target EvasObject</param>
+ /// <param name="handler">Event handler for Rotary event</param>
/// <since_tizen> preview </since_tizen>
public static void AddRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
{
}
/// <summary>
- /// Removes a handler on a specific EvasObject for the Rotary event.
+ /// Remove a handler on specific EvasObject for Rotary event.
/// </summary>
- /// <param name="obj">Target EvasObject.</param>
- /// <param name="handler">Event handler for Rotary event.</param>
+ /// <param name="obj">Target EvasObject</param>
+ /// <param name="handler">Event handler for Rotary event</param>
/// <since_tizen> preview </since_tizen>
public static void RemoveRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
{
}
/// <summary>
- /// Activates this Circle widget that can take the Rotary event.
+ /// Activate this circle widget can take Rotary event.
/// </summary>
- /// <param name="widget">Target the Circle widget.</param>
+ /// <param name="widget">Target circle widget</param>
/// <since_tizen> preview </since_tizen>
public static void Activate(this IRotaryActionWidget widget)
{
}
/// <summary>
- /// Deactivates this circle widget that is blocked from the Rotary event.
+ /// Deactivate this circle widget is blocked from Rotary event.
/// </summary>
- /// <param name="widget">Target the Circle widget.</param>
+ /// <param name="widget">Target circle widget</param>
/// <since_tizen> preview </since_tizen>
public static void Deactivate(this IRotaryActionWidget widget)
{
}
/// <summary>
- /// Activates this object that can take the Rotary event.
+ /// Activate this object can take Rotary event.
/// </summary>
- /// <param name="obj">Target object.</param>
+ /// <param name="obj">Target object</param>
/// <since_tizen> preview </since_tizen>
public static void Activate(this EvasObject obj)
{
}
/// <summary>
- /// Deactivates this object that is blocked from the Rotary event.
+ /// Deactivate this object is blocked from Rotary event.
/// </summary>
- /// <param name="obj">Target object.</param>
+ /// <param name="obj">Target object</param>
/// <since_tizen> preview </since_tizen>
public static void Deactivate(this EvasObject obj)
{
}
/// <summary>
- /// Handler for the Rotary event.
+ /// Handler for Rotary event
/// </summary>
- /// <param name="args">The Rotary event information.</param>
+ /// <param name="args">Rotary event information</param>
/// <since_tizen> preview </since_tizen>
public delegate void RotaryEventHandler(RotaryEventArgs args);
/// <summary>
- /// The RotaryEventArgs serves information for the triggered Rotary event.
+ /// RotaryEventArgs serve information for triggered rotary event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class RotaryEventArgs : EventArgs
{
/// <summary>
- /// IsClockwise is true when the Rotary device rotated in the clockwise direction, or false on counter clockwise.
+ /// IsClockwise is true when Rotary device rotated clockwise direction or false on counter clockwise.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsClockwise { get; set; }
/// <summary>
- /// Timestamp of the Rotary event.
+ /// Timestamp of rotary event
/// </summary>
/// <since_tizen> preview </since_tizen>
public uint Timestamp { get; set; }
namespace ElmSharp.Wearable
{
/// <summary>
- /// The RotarySelector is a widget to display a selector and multiple items surrounding the selector.
- /// An item can be selected by the Rotary event or user item click.
+ /// The Rotary Selector is a widget to display a selector and multiple items surrounding the selector.
+ /// And an item can be selected by rotary event or user item click.
/// Inherits <see cref="Layout"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
const string ItemClickedEventName = "item,clicked";
/// <summary>
- /// Selected will be triggered when selecting an item.
+ /// Selected will be triggered when selected an item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<RotarySelectorItemEventArgs> Selected;
/// <summary>
- /// Clicked will be triggered when selecting again the already selected item or selecting a selector.
+ /// Clicked will be triggered when selecting again the alredy selected item or selecting a selector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<RotarySelectorItemEventArgs> Clicked;
/// <summary>
/// Creates and initializes a new instance of the Rotary Selector class.
/// </summary>
- /// <param name="parent">The parent of the new Rotary Selector instance.</param>
+ /// <param name="parent">The parent of new Rotary Selector instance</param>
/// <since_tizen> preview </since_tizen>
public RotarySelector(EvasObject parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp.Wearable
{
/// <summary>
- /// An instance to the Rotary Selector item is added. An item can be selected by the Rotary event or user item click.
+ /// A instance to the Rotary Selector Item added. And an item can be selected by rotary event or user item click.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class RotarySelectorItem
public string MainText { set => setPart(ref _mainText, MainTextPartName, value); get => _mainText; }
/// <summary>
- /// Sets or gets the subtext of a rotary selector item object.
+ /// Sets or gets the sub text of a rotary selector item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string SubText { set => setPart(ref _subText, SubTextPartName, value); get => _subText; }
/// <summary>
- /// Sets or gets the subtext color of a rotary selector item object.
+ /// Sets or gets the sub text color of a rotary selector item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color MainTextColor { set => setPart(ref _mainTextColor, MainTextPartName, ItemState.Normal, value); get => _mainTextColor; }
/// <summary>
- /// Sets or gets the subtext color of a rotary selector item object.
+ /// Sets or gets the sub text color of a rotary selector item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color SubTextColor { set => setPart(ref _subTextColor, SubTextPartName, ItemState.Normal, value); get => _subTextColor; }
public Image NormalIconImage { set => setPart(ref _normalIconImage, IconPartName, ItemState.Normal, value); get => _normalIconImage; }
/// <summary>
- /// Sets or gets the pressed icon image of a rotary selector item object.
+ /// Sets or gets the press icon image of a rotary selector item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Image PressedIconImage { set => setPart(ref _pressedIconImage, IconPartName, ItemState.Pressed, value); get => _pressedIconImage; }
/// <summary>
- /// Sets or gets the disabled icon image of a rotary selector item object.
+ /// Sets or gets the disable icon image of a rotary selector item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Image DisabledIconImage { set => setPart(ref _disabledIconImage, IconPartName, ItemState.Disabled, value); get => _disabledIconImage; }
namespace ElmSharp.Wearable
{
/// <summary>
- /// <see cref="RotarySelector.Selected"/> and <see cref="RotarySelector.Clicked"/> events of the RotarySelector contain the RotarySelectorItemEventArgs as a parameter.
+ /// <see cref="RotarySelector.Selected"/> and <see cref="RotarySelector.Clicked"/> events of RotarySelector contain RotarySelectorItemEventArgs as a parameter.
/// Inherits <see cref="EventArgs"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
namespace ElmSharp.Accessible
{
/// <summary>
- /// Enumeration for the AccessRole.
+ /// Enumeration for AccessRole.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AccessRole
{
/// <summary>
- /// Invalid.
+ /// Invalid
/// </summary>
Invalid,
/// <summary>
- /// AcceleratorLabel role.
+ /// AcceleratorLabel role
/// </summary>
AcceleratorLabel,
/// <summary>
- /// Alert role.
+ /// Alert role
/// </summary>
Alert,
/// <summary>
- /// Animation role.
+ /// Animation role
/// </summary>
Animation,
/// <summary>
- /// Arrow role.
+ /// Arrow role
/// </summary>
Arrow,
/// <summary>
- /// Calendar role.
+ /// Calendar role
/// </summary>
Calendar,
/// <summary>
- /// Canvas role.
+ /// Canvas role
/// </summary>
Canvas,
/// <summary>
- /// CheckBox role.
+ /// CheckBox role
/// </summary>
CheckBox,
/// <summary>
- /// CheckMenuItem role.
+ /// CheckMenuItem role
/// </summary>
CheckMenuItem,
/// <summary>
- /// ColorChooser role.
+ /// ColorChooser role
/// </summary>
ColorChooser,
/// <summary>
- /// ColumnHeader role.
+ /// ColumnHeader role
/// </summary>
ColumnHeader,
/// <summary>
- /// ComboBox role.
+ /// ComboBox role
/// </summary>
ComboBox,
/// <summary>
- /// DateEditor role.
+ /// DateEditor role
/// </summary>
DateEditor,
/// <summary>
- /// DesktopIcon role.
+ /// DesktopIcon role
/// </summary>
DesktopIcon,
/// <summary>
- /// DesktopFrame role.
+ /// DesktopFrame role
/// </summary>
DesktopFrame,
/// <summary>
- /// Dial role.
+ /// Dial role
/// </summary>
Dial,
/// <summary>
- /// Dialog role.
+ /// Dialog role
/// </summary>
Dialog,
/// <summary>
- /// DirectoryPane role.
+ /// DirectoryPane role
/// </summary>
DirectoryPane,
/// <summary>
- /// DrawingArea role.
+ /// DrawingArea role
/// </summary>
DrawingArea,
/// <summary>
- /// FileChooser role.
+ /// FileChooser role
/// </summary>
FileChooser,
/// <summary>
/// </summary>
Filler,
/// <summary>
- /// FocusTraversable role.
+ /// FocusTraversable role
/// </summary>
FocusTraversable,
/// <summary>
- /// FontChooser role.
+ /// FontChooser role
/// </summary>
FontChooser,
/// <summary>
- /// Frame role.
+ /// Frame role
/// </summary>
Frame,
/// <summary>
- /// GlassPane role.
+ /// GlassPane role
/// </summary>
GlassPane,
/// <summary>
- /// HtmlContainer role.
+ /// HtmlContainer role
/// </summary>
HtmlContainer,
/// <summary>
- /// Icon role.
+ /// Icon role
/// </summary>
Icon,
/// <summary>
- /// Image role.
+ /// Image role
/// </summary>
Image,
/// <summary>
- /// InternalFrame role.
+ /// InternalFrame role
/// </summary>
InternalFrame,
/// <summary>
/// </summary>
Label,
/// <summary>
- /// LayeredPane role.
+ /// LayeredPane role
/// </summary>
LayeredPane,
/// <summary>
- /// List role.
+ /// List role
/// </summary>
List,
/// <summary>
- /// ListItem role.
+ /// ListItem role
/// </summary>
ListItem,
/// <summary>
- /// Menu role.
+ /// Menu role
/// </summary>
Menu,
/// <summary>
- /// MenuBar role.
+ /// MenuBar role
/// </summary>
MenuBar,
/// <summary>
- /// MenuItem role.
+ /// MenuItem role
/// </summary>
MenuItem,
/// <summary>
- /// OptionPane role.
+ /// OptionPane role
/// </summary>
OptionPane,
/// <summary>
- /// PageTab role.
+ /// PageTab role
/// </summary>
PageTab,
/// <summary>
- /// PageTabList role.
+ /// PageTabList role
/// </summary>
PageTabList,
/// <summary>
- /// Panel role.
+ /// Panel role
/// </summary>
Panel,
/// <summary>
- /// PasswordText role.
+ /// PasswordText role
/// </summary>
PasswordText,
/// <summary>
- /// PopupMenu role.
+ /// PopupMenu role
/// </summary>
PopupMenu,
/// <summary>
- /// ProgressBar role.
+ /// ProgressBar role
/// </summary>
ProgressBar,
/// <summary>
- /// PushButton role.
+ /// PushButton role
/// </summary>
PushButton,
/// <summary>
- /// RadioButton role.
+ /// RadioButton role
/// </summary>
RadioButton,
/// <summary>
- /// RadioMenuItem role.
+ /// RadioMenuItem role
/// </summary>
RadioMenuItem,
/// <summary>
- /// RootPane role.
+ /// RootPane role
/// </summary>
RootPane,
/// <summary>
- /// RowHeader role.
+ /// RowHeader role
/// </summary>
RowHeader,
/// <summary>
- /// ScrollBar role.
+ /// ScrollBar role
/// </summary>
ScrollBar,
/// <summary>
- /// ScrollPane role.
+ /// ScrollPane role
/// </summary>
ScrollPane,
/// <summary>
- /// Separator role.
+ /// Separator role
/// </summary>
Separator,
/// <summary>
- /// Slider role.
+ /// Slider role
/// </summary>
Slider,
/// <summary>
- /// SpinButton role.
+ /// SpinButton role
/// </summary>
SpinButton,
/// <summary>
- /// SplitPane role.
+ /// SplitPane role
/// </summary>
SplitPane,
/// <summary>
- /// StatusBar role.
+ /// StatusBar role
/// </summary>
StatusBar,
/// <summary>
- /// Table role.
+ /// Table role
/// </summary>
Table,
/// <summary>
- /// TableCell role.
+ /// TableCell role
/// </summary>
TableCell,
/// <summary>
- /// TableColumnHeader role.
+ /// TableColumnHeader role
/// </summary>
TableColumnHeader,
/// <summary>
- /// TableRowHeader role.
+ /// TableRowHeader role
/// </summary>
TableRowHeader,
/// <summary>
- /// TearoffMenuItem role.
+ /// TearoffMenuItem role
/// </summary>
TearoffMenuItem,
/// <summary>
- /// Terminal role.
+ /// Terminal role
/// </summary>
Terminal,
/// <summary>
- /// Text role.
+ /// Text role
/// </summary>
Text,
/// <summary>
- /// ToggleButton role.
+ /// ToggleButton role
/// </summary>
ToggleButton,
/// <summary>
- /// ToolBar role.
+ /// ToolBar role
/// </summary>
ToolBar,
/// <summary>
- /// ToolTip role.
+ /// ToolTip role
/// </summary>
ToolTip,
/// <summary>
- /// Tree role.
+ /// Tree role
/// </summary>
Tree,
/// <summary>
- /// TreeTable role.
+ /// TreeTable role
/// </summary>
TreeTable,
/// <summary>
- /// Unknown role.
+ /// Unknown
/// </summary>
Unknown,
/// <summary>
- /// Viewport role.
+ /// Viewport role
/// </summary>
Viewport,
/// <summary>
- /// Window role.
+ /// Window role
/// </summary>
Window,
/// <summary>
- /// Extended role.
+ /// Extended role
/// </summary>
Extended,
/// <summary>
- /// Header role.
+ /// Header role
/// </summary>
Header,
/// <summary>
- /// Footer role.
+ /// Footer role
/// </summary>
Footer,
/// <summary>
- /// Paragraph role.
+ /// Paragraph
/// </summary>
Paragraph,
/// <summary>
- /// Ruler role.
+ /// Ruler role
/// </summary>
Ruler,
/// <summary>
- /// Application role.
+ /// Application role
/// </summary>
Application,
/// <summary>
- /// Autocomplete role.
+ /// Autocomplete role
/// </summary>
Autocomplete,
/// <summary>
- /// Editbar role.
+ /// Editbar role
/// </summary>
Editbar,
/// <summary>
- /// Embedded role.
+ /// Embedded role
/// </summary>
Embedded,
/// <summary>
- /// Entry role.
+ /// Entry role
/// </summary>
Entry,
/// <summary>
- /// Chart role.
+ /// Chart role
/// </summary>
Chart,
/// <summary>
- /// Caption role.
+ /// Caption role
/// </summary>
Caption,
/// <summary>
- /// DocumentFrame role.
+ /// DocumentFrame role
/// </summary>
DocumentFrame,
/// <summary>
- /// Heading role.
+ /// Heading role
/// </summary>
Heading,
/// <summary>
- /// Page role.
+ /// Page role
/// </summary>
Page,
/// <summary>
- /// Section role.
+ /// Section role
/// </summary>
Section,
/// <summary>
- /// RedundantObject role.
+ /// RedundantObject role
/// </summary>
RedundantObject,
/// <summary>
- /// Form role.
+ /// Form role
/// </summary>
Form,
/// <summary>
- /// Link role.
+ /// Link role
/// </summary>
Link,
/// <summary>
- /// InputMethodWindow role.
+ /// InputMethodWindow role
/// </summary>
InputMethodWindow,
/// <summary>
- /// TableRow role.
+ /// TableRow role
/// </summary>
TableRow,
/// <summary>
- /// TreeItem role.
+ /// TreeItem role
/// </summary>
TreeItem,
/// <summary>
- /// DocumentSpreadsheet role.
+ /// DocumentSpreadsheet role
/// </summary>
DocumentSpreadsheet,
/// <summary>
- /// DocumentPresentation role.
+ /// DocumentPresentation role
/// </summary>
DocumentPresentation,
/// <summary>
- /// DocumentText role.
+ /// DocumentText role
/// </summary>
DocumentText,
/// <summary>
- /// DocumentWeb role.
+ /// DocumentWeb role
/// </summary>
DocumentWeb,
/// <summary>
- /// DocumentEmail role.
+ /// DocumentEmail role
/// </summary>
DocumentEmail,
/// <summary>
- /// Comment role.
+ /// Comment role
/// </summary>
Comment,
/// <summary>
- /// ListBox role.
+ /// ListBox role
/// </summary>
ListBox,
/// <summary>
- /// Grouping role.
+ /// Grouping role
/// </summary>
Grouping,
/// <summary>
- /// ImageMap role.
+ /// ImageMap role
/// </summary>
ImageMap,
/// <summary>
- /// Notification role.
+ /// Notification role
/// </summary>
Notification,
/// <summary>
- /// InfoBar role.
+ /// InfoBar role
/// </summary>
InfoBar
}
namespace ElmSharp.Accessible
{
/// <summary>
- /// The delegate to define how to provide information for <see cref="IAccessibleObject.Name"/> or <see cref="IAccessibleObject.Description"/>.
+ /// The delegate to define how to provide informations for <see cref="IAccessibleObject.Name"/> or <see cref="IAccessibleObject.Description"/>.
/// </summary>
/// <param name="obj">The sender obj.</param>
- /// <returns>Return information for name or description.</returns>
+ /// <returns>Return information for Name or Description.</returns>
/// <since_tizen> preview </since_tizen>
public delegate string AccessibleInfoProvider (AccessibleObject obj);
/// <summary>
/// It's a base abstract class for <see cref="Widget"/>.
- /// It provides the available definitions for the screen reader, such as <see cref="IAccessibleObject.Name"/>, <see cref="IAccessibleObject.Description"/>, <see cref="IAccessibleObject.ReadingInfoType"/>, etc.
- /// There are many relationships between two accessible objects, like <see cref="ChildOf"/>, <see cref="ParentOf"/>, <see cref="FlowsTo"/>, <see cref="FlowsFrom"/>, etc.
+ /// It provides available definitions for the screen reader, such as <see cref="IAccessibleObject.Name"/>, <see cref="IAccessibleObject.Description"/>, <see cref="IAccessibleObject.ReadingInfoType"/>, etc.
+ /// There's many the relationship between two accessible objects, like <see cref="ChildOf"/>, <see cref="ParentOf"/>, <see cref="FlowsTo"/>, <see cref="FlowsFrom"/>, etc.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class AccessibleObject : EvasObject, IAccessibleObject
}
/// <summary>
- /// Gets or sets the role of the object in an accessibility domain.
+ /// Gets or sets the role of the object in accessibility domain.
/// </summary>
AccessRole IAccessibleObject.Role
{
}
/// <summary>
- /// Gets or sets the highlightable of a given widget.
+ /// Gets or sets highlightable of given widget.
/// </summary>
bool IAccessibleObject.CanHighlight
{
}
/// <summary>
- /// Gets or sets the translation domain of the "name" and "description" properties.
- /// The translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties.
- /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter.
- /// It is the application developers responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.
+ /// 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 IAccessibleObject.TranslationDomain
{
}
/// <summary>
- /// Gets or sets the contextual information about an object.
+ /// Gets or sets contextual information about object.
/// </summary>
string IAccessibleObject.Description
{
}
/// <summary>
- /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description"/>.
+ /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
/// </summary>
AccessibleInfoProvider IAccessibleObject.DescriptionProvider
{
}
/// <summary>
- /// Creates and initializes a new instance of the AccessibleObject class with the parent EvasObject class parameter.
+ /// Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter.
/// </summary>
- /// <param name="parent">Parent EvasObject class.</param>
+ /// <param name="parent">Parent EvasObject class </param>
/// <since_tizen> preview </since_tizen>
public AccessibleObject(EvasObject parent) : base(parent)
{
/// <summary>
/// Defines the relationship between two accessible objects.
- /// Relationships can be queried by the Assistive Technology clients to provide customized feedback, and improving overall user experience.
- /// AppendRelation API is asymmetric, which means that appending, for example, relation <see cref="FlowsTo"/> from object A to B, does not append the relation <see cref="FlowsFrom"/> from object B to object A.
+ /// 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 the source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
void IAccessibleObject.AppendRelation(IAccessibleRelation relation)
{
if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null");
/// <summary>
/// Removes the relationship between two accessible objects.
/// </summary>
- /// <param name="relation">The relationship between the source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
void IAccessibleObject.RemoveRelation(IAccessibleRelation relation)
{
if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null");
}
/// <summary>
- /// Highlights the accessible widget.
+ /// Highlights accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Highlight()
}
/// <summary>
- /// Clears the highlight of the accessible widget.
+ /// Clears highlight of accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Unhighlight()
namespace ElmSharp.Accessible
{
/// <summary>
- /// IAccessibleRelation is an interface, which defines the relationship between two accessible objects.
+ /// IAccessibleRelation is a interface which defines the relationship between two accessible objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAccessibleRelation
}
/// <summary>
- /// To define the label info for an accessible object.
+ /// To define label info for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LabelledBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is LabelledBy.
+ /// Gets or sets the target object which is LabelledBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the label info for an accessible object.
+ /// To define label info for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LabelFor : IAccessibleRelation
}
/// <summary>
- /// To define the control relationship for an accessible object.
+ /// To define control relationship for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ControllerFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is ControllerFor.
+ /// Gets or sets the target object which is ControllerFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the control relationship for an accessible object.
+ /// To define control relationship for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ControlledBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is ControlledBy.
+ /// Gets or sets the target object which is ControlledBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the member relationship for an accessible object.
+ /// To define member relationship for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MemberOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is MemberOf.
+ /// Gets or sets the target object which is MemberOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the tooltip for an accessible object.
+ /// To define tooltip for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class TooltipFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is TooltipFor.
+ /// Gets or sets the target object which is TooltipFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the child for an accessible object.
+ /// To define child for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ChildOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is ChildOf.
+ /// Gets or sets the target object which is ChildOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the parent for an accessible object.
+ /// To define parent for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ParentOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is ParentOf.
+ /// Gets or sets the target object which is ParentOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the extend for an accessible object.
+ /// To define extend for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Extended : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is Extended.
+ /// Gets or sets the target object which is Extended.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
/// <summary>
- /// Gets the extended type.
+ /// Gets the Extended type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Type
public class FlowsTo : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is FlowsTo.
+ /// Gets or sets the target object which is FlowsTo.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
public class FlowsFrom : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is FlowsFrom.
+ /// Gets or sets the target object which is FlowsFrom.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the subwindow for an accessible object.
+ /// To define subwindow for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SubwindowOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is SubwindowOf.
+ /// Gets or sets the target object which is SubwindowOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the embed for an accessible object.
+ /// To define embed for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Embeds : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object ,which is Embeds.
+ /// Gets or sets the target object which is Embeds.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the embed for an accessible object.
+ /// To define embed for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EmbeddedBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is EmbeddedBy.
+ /// Gets or sets the target object which is EmbeddedBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the popup for an accessible object.
+ /// To define popup for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class PopupFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is PopupFor.
+ /// Gets or sets the target object which is PopupFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the parent window for an accessible object.
+ /// To define parent window for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ParentWindowOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is ParentWindowOf.
+ /// Gets or sets the target object which is ParentWindowOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the description for an accessible object.
+ /// To define description for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DescriptionFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is DescriptionFor.
+ /// Gets or sets the target object which is DescriptionFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define the description for an accessible object.
+ /// To define description for accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DescribedBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object, which is DescribedBy.
+ /// Gets or sets the target object which is DescribedBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
namespace ElmSharp.Accessible
{
/// <summary>
- /// Enumeration for the ReadingStatus.
+ /// Enumeration for ReadingStatus.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ReadingStatus
{
/// <summary>
- /// Unknown status.
+ /// Unknown status
/// </summary>
Unknown,
/// <summary>
- /// Cancelled status.
+ /// Cancelled status
/// </summary>
Cancelled,
/// <summary>
- /// Stopped status.
+ /// Stopped status
/// </summary>
Stoppped,
/// <summary>
- /// Skipped status.
+ /// Skipped status
/// </summary>
Skipped
}
}
/// <summary>
- /// Reads the given text by a screen reader.
+ /// Reads given text by screen reader.
/// </summary>
/// <param name="text">The reading text.</param>
- /// <param name="discardable">If true, reading can be discarded by subsequent reading requests. If false, reading must be finished before the next reading request can be started.</param>
- /// <returns>Return a task with the reading status.</returns>
+ /// <param name="discardable">If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started.</param>
+ /// <returns>Return a task with reading status.</returns>
/// <since_tizen> preview </since_tizen>
public static Task<ReadingStatus> Say(string text, bool discardable)
{
/// <summary>
/// Creates and initializes a new instance of the Background class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new background will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new Background will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Background(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets the color to the background.
+ /// Sets or gets color to Background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color Color
}
/// <summary>
- /// Sets or gets the image to the background.
+ /// Sets or gets image to Background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string File
/// </summary>
/// <remarks>
/// This sets how the background widget will display its image.
- /// This will only work if the file was previously set with an image file on object.
- /// The image can be display tiled, scaled, centered, or stretched. Scaled by default.
+ /// This will only work if the File was previously set with an image file on obj.
+ /// The image can be display tiled, scaled, centered or stretched. scaled by default.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public BackgroundOptions BackgroundOption
}
/// <summary>
- /// Sets the size of the pixmap representation of the image set on a given background widget.
+ /// Set the size of the pixmap representation of the image set on a given background widget.
/// This method just makes sense if an image file was set.
/// This is just a hint for the underlying system.
/// The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested.
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the background types.
+ /// Enumeration for the background type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum BackgroundOptions
{
/// <summary>
- /// Centers the background image.
+ /// Centers the background image
/// </summary>
Center,
/// <summary>
- /// Scales the background image, retaining the aspect ratio.
+ /// Scales the background image, retaining the aspect ratio
/// </summary>
Scale,
Stretch,
/// <summary>
- /// Tiles the background image at its original size.
+ /// Tiles the background image at its original size
/// </summary>
Tile
}
namespace ElmSharp
{
/// <summary>
- /// The Box is a container that is used to arrange UI components in a linear order.
+ /// The Box is a container used to arranges UI components in a linear order.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Box : Container
}
/// <summary>
- /// Sets or gets the IsHorizontal value, which describe the pack direction. Vertical is default.
+ /// Sets or gets IsHorizontal value which describe pack direction, vertical is default.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets whether the box has to arrange its children homogeneously.
+ /// Sets or gets whether the box to arrange its children homogeneously.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHomogeneous
/// Adds an object at the end of the pack list.
/// </summary>
/// <remarks>
- /// Packs the "content" object into the Box, placing it last in the list of children objects.
- /// The actual position of the object will get on the screen depending on the layout used.
+ /// Packs "content" object into the Box, placing it last in the list of children objects.
+ /// The actual position the object will get on screen depends on the layout used.
/// If no custom layout is set, it will be at the bottom or right,
/// depending if the Box is vertical or horizontal, respectively.
/// </remarks>
- /// <param name="content">The oject to be packed.</param>
+ /// <param name="content">The oject be packed</param>
/// <since_tizen> preview </since_tizen>
public void PackEnd(EvasObject content)
{
}
/// <summary>
- /// Adds a "content" object to the beginning of the pack list.
+ /// Adds an "content" object to the beginning of the pack list.
/// </summary>
/// <remarks>
- /// Packs the "content" object into the box object, placing it first in the list of children objects.
- /// The actual position of the object will get on the screen depending on the layout used.
+ /// Pack "content" object into the Box obj, placing it first in the list of children objects.
+ /// The actual position the object will get on screen depends on the layout used.
/// If no custom layout is set, it will be at the top or left,
/// depending if the Box is vertical or horizontal, respectively.
/// </remarks>
}
/// <summary>
- /// Adds a "content" object to the box after the "after" object.
+ /// Adds an "content "object to the Box after the "after" object.
/// </summary>
/// <remarks>
- /// This will add the "content" to the box indicated after the object indicated with "after".
- /// If "after" is not already in the box, the results are undefined.
- /// After means either to the right of the "after" object or below it, depending on orientation.
+ /// This will add the "content" to the Box indicated after the object indicated with "after".
+ /// If "after" is not already in the Box, results are undefined.
+ /// After means either to the right of the "after" object or below it depending on orientation.
/// </remarks>
- /// <param name="content">The object will be added in the box.</param>
- /// <param name="after">The object has been added in the box.</param>
+ /// <param name="content">The object will be added in Box</param>
+ /// <param name="after">The object has been added in Box</param>
/// <since_tizen> preview </since_tizen>
public void PackAfter(EvasObject content, EvasObject after)
{
}
/// <summary>
- /// Adds a "content" object to the box before the "before" object.
+ /// Adds an "content "object to the Box before the "before" object.
/// </summary>
/// <remarks>
- /// This will add the "content" to the box indicated before the object indicated with "before".
- /// If "before" is not already in the box, the results are undefined.
- /// Before means either to the left of the "before" object or below it, depending on orientation.
+ /// This will add the "content" to the Box indicated before the object indicated with "before".
+ /// If "before" is not already in the Box, results are undefined.
+ /// before means either to the left of the "before" object or below it depending on orientation.
/// </remarks>
- /// <param name="content">The object will be added in the box.</param>
- /// <param name="before">The object has been added in the box.</param>
+ /// <param name="content">The object will be added in Box</param>
+ /// <param name="before">The object has been added in Box</param>
/// <since_tizen> preview </since_tizen>
public void PackBefore(EvasObject content, EvasObject before)
{
}
/// <summary>
- /// Removes the "content" object from the box without deleting it.
+ /// Remove the "content" oject from Box without deleting it.
/// </summary>
- /// <param name="content">The object to unpack.</param>
+ /// <param name="content">The object to unpack</param>
/// <since_tizen> preview </since_tizen>
public void UnPack(EvasObject content)
{
}
/// <summary>
- /// Removes all the objects from the Box container.
+ /// Removes all objects from Box container.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void UnPackAll()
}
/// <summary>
- /// Whenever any changes that requires the box in object to recalculate the size and position of its elements,
+ /// Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements,
/// the function cb will be called to determine what the layout of the children will be.
/// </summary>
- /// <param name="action">The callback function used for layout.</param>
+ /// <param name="action">The callback function used for layout </param>
/// <since_tizen> preview </since_tizen>
public void SetLayoutCallback(Action action)
{
}
/// <summary>
- /// Sets the color of the exact part to the box's layout parent.
+ /// Sets the color of exact part to Box's layout parent.
/// </summary>
/// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
/// <param name="color">The color value.</param>
}
/// <summary>
- /// Gets the color of the exact part of the box's layout parent.
+ /// Gets the color of exact part of Box's layout parent.
/// </summary>
/// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
/// <returns></returns>
}
/// <summary>
- /// Forces the box to recalculate its children packing.
- /// If any children were added or removed, the box will not calculate the values immediately, rather leaving it to the next main loop iteration.
- /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item, you must force recalculate before doing so.
+ /// Force the box to recalculate its children packing.
+ /// If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration.
+ /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Recalculate()
}
/// <summary>
- /// Clears the box's of all the children.
+ /// Clear the box of all children.
/// Remove all the elements contained by the box, deleting the respective objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets or gets the alignment of the whole bounding box of contents.
/// </summary>
- /// <param name="horizontal">Horizontal alignment.</param>
- /// <param name="vertical">Vertical alignment.</param>
+ /// <param name="horizontal">Horizontal alignment</param>
+ /// <param name="vertical">Vertical alignment</param>
/// <since_tizen> preview </since_tizen>
public void SetBoxAlignment(double horizontal, double vertical)
{
}
/// <summary>
- /// Sets or gets the space (padding) between the box's elements.
+ /// Sets or gets the space(padding) between the box's elements.
/// </summary>
- /// <param name="horizontal">Horizontal padding.</param>
- /// <param name="vertical">Vertical padding.</param>
+ /// <param name="horizontal">Horizontal padding</param>
+ /// <param name="vertical">vertical padding</param>
/// <since_tizen> preview </since_tizen>
public void SetPadding(int horizontal, int vertical)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Button is a widget that works as a clickable input element to trigger events.
+ /// The Button is a widget works as a clickable input element to trigger events.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Button : Layout
}
/// <summary>
- /// Clicked will be triggered when the button is clicked.
+ /// Clicked will be triggered when Button is clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Repeated will be triggered when the button is pressed without releasing it.
+ /// Repeated will be triggered when Button is pressed without releasing it.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Repeated;
/// <summary>
- /// Pressed will be triggered when the button is pressed.
+ /// Pressed will be triggered when the Button is pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Pressed;
/// <summary>
- /// Released will be triggered when the button is released after being pressed.
+ /// Released will be triggered when the Button is released after being pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Released;
/// <summary>
- /// Sets or gets the autorepeat feature of a given Bbutton.
+ /// Sets or gets the autorepeat feature of a given Button.
/// </summary>
/// <remarks>
- /// Autorepeat feature means the autorepeat event is generated when the button is kept pressed.
- /// When set to false, no autorepeat is performed and the buttons will trigger the Clicked event when they are clicked.
- /// When set to true, keeping a button pressed continuously will trigger the Repeated event until the button is released.
- /// The time it takes until it starts triggering, repeated is given by AutoRepeatInitialTime,
+ /// Autorepeat feature means autorepeat event generated when the button is kept pressed.
+ /// When set AutoRepeat to false, no autorepeat is performed and buttons will trigger Clicked event when they are clicked.
+ /// When set to true, keeping a button pressed continuously trigger Repeated event until the button is released.
+ /// The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime,
/// and the time between each new emission is given by AutoRepeatGapTimeout.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Deletes the object Color class.
+ /// Delete the object color class.
/// </summary>
- /// <param name="part">The Color class to be deleted.</param>
+ /// <param name="part">The color class to be deleted.</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")]
public void DeleteColorClass(string part)
}
/// <summary>
- /// Sets or gets the BackgroundColor of a given button in the normal and pressed status.
+ /// Sets or gets the BackgroundColor of a given Button in normal and pressed status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for event periodicity, used to define if a mark should be repeated beyond the event's day. It's set when a mark is added.
+ /// Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CalendarMarkRepeatType
{
/// <summary>
- /// Default value. Marks will be displayed only on the event day.
+ /// Default value. Marks will be displayed only on event day.
/// </summary>
Unique,
/// <summary>
- /// Marks will be displayed every day after the event day.
+ /// Marks will be displayed every day after event day.
/// </summary>
Daily,
/// <summary>
- /// Marks will be displayed every week after the event day.
+ /// Marks will be displayed every week after event day.
/// </summary>
Weekly,
/// <summary>
- /// Marks will be displayed every month that coincides to the event day.
+ /// Marks will be displayed every month day that coincides to event day.
/// </summary>
Monthly,
/// <summary>
- /// Marks will be displayed every year that coincides to the event day.
+ /// Marks will be displayed every year that coincides to event day.
/// </summary>
Annually,
/// <summary>
- /// Marks will be displayed every last day of month after the event day.
+ /// Marks will be displayed every last day of month after event day.
/// </summary>
LastDayOfMonth
}
/// <summary>
- /// Enumeration for the mode, which determines how a user could select a day.
+ /// Enumeration for the mode, which determine how user could select a day.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CalendarSelectMode
{
/// <summary>
- /// Default value. A day is always selected.
+ /// Default value. a day is always selected.
/// </summary>
Default,
None,
/// <summary>
- /// User may have selected a day.
+ /// User may have selected a day or not.
/// </summary>
OnDemand
}
/// <summary>
- /// Enumeration for defining which fields of a tm struct will be taken into account.
+ /// Enumeration used to define which fields of a tm struct will be taken into account
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
public enum CalendarSelectable
{
/// <summary>
- /// None will be taken into account.
+ /// None will be taken into account
/// </summary>
None = 0,
/// <summary>
- /// Year will be taken into account.
+ /// Year will be taken into account
/// </summary>
Year = 1 << 0,
/// <summary>
- /// Month will be taken into account.
+ /// Month will be taken into account
/// </summary>
Month = 1 << 1,
/// <summary>
- /// Day will be taken into account.
+ /// Day will be taken into account
/// </summary>
Day = 1 << 2
}
/// <summary>
- /// The CalendarMark is an item for marking a Calendar's type, date, and repeat type.
+ /// The CalendarMark is a Item for marking a Calendar's type,date and repeat type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CalendarMark
public DateTime Date;
/// <summary>
- /// Repeats the event following this periodicity.
+ /// Repeat the event following this periodicity.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CalendarMarkRepeatType Repeat;
/// <summary>
/// Creates and initializes a new instance of the CalendarMark class.
/// </summary>
- /// <param name="type">Type of mark.</param>
- /// <param name="date">Date of inclusion of the mark.</param>
- /// <param name="repeat">Repeat type.</param>
+ /// <param name="type">Type of mark</param>
+ /// <param name="date">Date of inclusion of the mark</param>
+ /// <param name="repeat">Repeat type</param>
/// <since_tizen> preview </since_tizen>
public CalendarMark(string type, DateTime date, CalendarMarkRepeatType repeat)
{
}
/// <summary>
- /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year, and month.
+ /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Calendar : Layout
/// Creates and initializes a new instance of the Calendar class.
/// </summary>
/// <param name="parent">
- /// The EvasObject to which the new calendar will be attached as a child.
+ /// The EvasObject to which the new Calendar will be attached as a child.
/// </param>
/// <since_tizen> preview </since_tizen>
public Calendar(EvasObject parent) : base(parent)
}
/// <summary>
- /// Sets or gets the first day of the week, which is used on the calendar.
+ /// Sets or gets the first day of week, who are used on Calendar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime DisplayedTime
}
/// <summary>
- /// Sets or gets the first day of the week, which is used on the calendar.
+ /// Sets or gets the first day of week, who are used on Calendar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DayOfWeek FirstDayOfWeek
}
/// <summary>
- /// Sets or gets the weekdays name to be displayed by the calendar.
+ /// Sets or gets the weekdays names to be displayed by the Calendar.
/// </summary>
/// <remarks>
- /// The usage should be like this:
+ /// The usage should be like this;
/// <![CDATA[List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };]]>
/// Calendar.WeekDayNames = weekDayNames;
/// </remarks>
/// Sets or gets the selected date.
/// </summary>
/// <remarks>
- /// The selected date changes when the user goes to the next/previous month or selects a day pressing over it on the calendar.
+ /// Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public DateTime SelectedDate
}
/// <summary>
- /// Sets or gets the interval on time updates for a user mouse button
- /// hold, on the calendar widgets' month/year selection.
+ /// Sets or gets the interval on time updates for an user mouse button
+ /// hold on calendar widgets' month/year selection.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
}
/// <summary>
- /// Gets or sets the fields of a datetime that will be taken into account, when SelectedDate set is invoked.
+ /// Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CalendarSelectable Selectable
}
/// <summary>
- /// Gets or sets the date format of the string that will be used to display month and year.
+ /// Gets or sets date format the string that will be used to display month and year.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateFormatDelegate DateFormat
}
/// <summary>
- /// Adds a new mark to the calendar.
+ /// Add a new mark to the calendar.
/// </summary>
- /// <param name="type">A string used to define the type of mark. It will be emitted to the theme that should display a related modification on these day's representation.</param>
- /// <param name="date">A time struct to represent the date of inclusion of the mark. For marks that repeat, it will just be displayed after the inclusion date in the calendar.</param>
- /// <param name="repeat">Repeat the event following this periodicity. Can be a unique mark (that doesn't repeat), daily, weekly, monthly, or annually.</param>
+ /// <param name="type">A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation.</param>
+ /// <param name="date">A time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar.</param>
+ /// <param name="repeat">Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually.</param>
/// <returns>Item for a calendar mark.</returns>
/// <since_tizen> preview </since_tizen>
public CalendarMark AddMark(string type, DateTime date, CalendarMarkRepeatType repeat)
}
/// <summary>
- /// Deletes a mark from the calendar.
+ /// Delete mark from the calendar.
/// </summary>
- /// <param name="mark">Item for a calendar mark.</param>
+ /// <param name="mark">Item for a calendar mark</param>
/// <since_tizen> preview </since_tizen>
public void DeleteMark(CalendarMark mark)
{
}
/// <summary>
- /// Draws the calendar marks.
+ /// Draw calendar marks.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void DrawMarks()
}
/// <summary>
- /// Removes all the calendar's marks.
+ /// Remove all calendar's marks.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearMarks()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Check is a widget that allows for toggling a value between true and false.
+ /// The check is a widget allows for toggling a value between true and false.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Check : Layout
/// Creates and initializes a new instance of the Check class.
/// </summary>
/// <param name="parent">
- /// The EvasObject to which the new check will be attached as a child.
+ /// The EvasObject to which the new Check will be attached as a child.
/// </param>
/// <since_tizen> preview </since_tizen>
public Check(EvasObject parent) : base(parent)
}
/// <summary>
- /// StateChanged will be triggered when the IsChecked in the check is changed.
+ /// StateChanged will be triggered when the IsChecked in the Check is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<CheckStateChangedEventArgs> StateChanged;
/// <summary>
- /// Sets or gets whether the given check is checked or not.
+ /// Sets or gets whether the given Check is checked or not.
/// </summary>
/// <remarks>
- /// When an object is checked, the value will be set to true. Conversely, will be set to false.
+ /// When object is checked, the value will set to true, Conversely will set to false.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsChecked
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits System.EventArgs.
- /// The CheckStateChangedEventArgs is an EventArgs to record the check's state.
- /// Include the old state and the new state.
+ /// The CheckStateChangedEventArgs is EventArgs to record Check's state.
+ /// Include old state and new state.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CheckStateChangedEventArgs : EventArgs
{
/// <summary>
- /// Gets the OldState property. The return type is bool.
+ /// Gets the OldState property.The return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool OldState { get; private set; }
/// <summary>
- /// Gets the NewState property. The return type is bool.
+ /// Gets the NewState property.The return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool NewState { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the CheckStateChangedEventArgs class.
/// </summary>
- /// <param name="oldState">Old state of check to use this CheckStateChangedEventArgs.</param>
- /// <param name="newState">New state of check to use this CheckStateChangedEventArgs.</param>
+ /// <param name="oldState">Old state of Check which to use this CheckStateChangedEventArgs.</param>
+ /// <param name="newState">New state of Check which to use this CheckStateChangedEventArgs.</param>
/// <since_tizen> preview </since_tizen>
public CheckStateChangedEventArgs(bool oldState, bool newState)
{
namespace ElmSharp
{
/// <summary>
- /// The Color is a struct to record the check's state.
+ /// The Color is a struct to record Check's state.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Color
/// Gets a default Color instance.
/// </summary>
/// <remarks>
- /// In the default Color instance, the mode type is default with RGBA all set as -1.
+ /// In default Color instance,Mode type is Default,RGBA all set as -1.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public static Color Default
/// <summary>
/// Gets whether the Color instance's mode is default or not.
- /// The return type is bool.
+ /// Return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsDefault
}
/// <summary>
- /// Gets the A value of RGBA.
+ /// Gets A value of RGBA.
/// A means the Alpha in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the R value of RGBA.
+ /// Gets R value of RGBA.
/// R means the Red in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the G value of RGBA.
+ /// Gets G value of RGBA.
/// G means the Green in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the B value of RGBA.
+ /// Gets B value of RGBA.
/// B means the Blue in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Creates and initializes a new instance of the Color class
- /// with RGB parameters.
+ /// Creates and initializes a new instance of the Color class.
+ /// With RGB parameters.
/// </summary>
- /// <param name="r">Red of RGB.</param>
- /// <param name="g">Green of RGB.</param>
- /// <param name="b">Blue of RGB.</param>
+ /// <param name="r">Red of RGB</param>
+ /// <param name="g">Green of RGB</param>
+ /// <param name="b">Blue of RGB</param>
/// <since_tizen> preview </since_tizen>
public Color(int r, int g, int b) : this(r, g, b, 255)
{
}
/// <summary>
- /// Creates and initializes a new instance of the Color class
- /// with RGBA parameters.
+ /// Creates and initializes a new instance of the Color class.
+ /// 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="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>
/// <since_tizen> preview </since_tizen>
public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb)
{
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value.
+ /// true if obj and this instance are the same type and represent the same value.
/// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Compares whether the two Color instances are same or not.
+ /// Compare whether two Color instance is same or not.
/// </summary>
/// <param name="a">A Color instance.</param>
/// <param name="b">A Color instance.</param>
- /// <returns>The result whether the two instances are the same or not.
- /// Return type is bool. If they are same, return true.
+ /// <returns>The result whether two instance is same or not.
+ /// Return type is bool.If they are same, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Color a, Color b)
}
/// <summary>
- /// Compares whether the two Color instances are different or not.
+ /// Compare whether two Color instance is different or not.
/// </summary>
/// <param name="a">A Color instance.</param>
/// <param name="b">A Color instance.</param>
- /// <returns>The result whether the two instances are different or not.
- /// Return type is bool. If they are different, return true.
+ /// <returns>The result whether two instance is different or not.
+ /// Return type is bool.If they are different, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Color a, Color b)
/// Gets a Color instance with a hexadecimal string parameter.
/// </summary>
/// <param name="hex">Hexadecimal string.</param>
- /// <returns>New instance of the Color struct.</returns>
+ /// <returns>New instance of Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromHex(string hex)
{
}
/// <summary>
- /// Gets a Color instance with an unsigned integer parameter.
+ /// Gets a Color instance with a Unsigned integer parameter.
/// </summary>
/// <param name="argb">Unsigned integer indicates RGBA.</param>
- /// <returns>New instance of the Color struct.</returns>
+ /// <returns>New instance of Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromUint(uint argb)
{
/// <summary>
/// Gets a Color instance with R,G,B,A 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>
- /// <returns>New instance of the Color struct.</returns>
+ /// <param name="r">Red in RGBA.</param>
+ /// <param name="g">Green in RGBA.</param>
+ /// <param name="b">Blue in RGBA.</param>
+ /// <param name="a">Alpha in RGBA.</param>
+ /// <returns>New instance of Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromRgba(int r, int g, int b, int a)
{
}
/// <summary>
- /// Gets a Color instance with R,G,B parameters.
+ /// Gets a Color instance with R,G,B,A parameters.
/// </summary>
- /// <param name="r">Red of RGB.</param>
- /// <param name="g">Green of RGB.</param>
- /// <param name="b">Blue of RGB.</param>
- /// <returns>New instance of the Color struct.</returns>
+ /// <param name="r">Red in RGB.</param>
+ /// <param name="g">Green in RGB.</param>
+ /// <param name="b">Blue in RGB.</param>
+ /// <returns>New instance of Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromRgb(int r, int g, int b)
{
#region Color Definitions
/// <summary>
- /// The Tansparent is a predefined Color instance. It's RGBA value is (0, 0, 0, 0).
+ /// The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Transparent = FromRgba(0, 0, 0, 0);
/// <summary>
- /// The Aqua is a predefined Color instance. It's RGB value is (0, 255, 255).
+ /// The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Aqua = FromRgb(0, 255, 255);
/// <summary>
- /// The Black is a predefined Color instance. It's RGB value is (0, 0, 0).
+ /// The Black is a predefined Color instance, it's rgb value is (0, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Black = FromRgb(0, 0, 0);
/// <summary>
- /// The Blue is a predefined Color instance. It's RGB value is (0, 0, 255).
+ /// The Blue is a predefined Color instance, it's rgb value is (0, 0, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Blue = FromRgb(0, 0, 255);
/// <summary>
- /// The Fuchsia is a predefined Color instance. It's RGB value is (255, 0, 255).
+ /// The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Fuchsia = FromRgb(255, 0, 255);
/// <summary>
- /// The Gray is a predefined Color instance. It's RGB value is (128, 128, 128).
+ /// The Gray is a predefined Color instance, it's rgb value is (128, 128, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Gray = FromRgb(128, 128, 128);
/// <summary>
- /// The Green is a predefined Color instance. It's RGB value is (0, 128, 0).
+ /// The Green is a predefined Color instance, it's rgb value is (0, 128, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Green = FromRgb(0, 128, 0);
/// <summary>
- /// The Lime is a predefined Color instance. It's RGB value is (0, 255, 0).
+ /// The Lime is a predefined Color instance, it's rgb value is (0, 255, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Lime = FromRgb(0, 255, 0);
/// <summary>
- /// The Maroon is a predefined Color instance. It's RGB value is (128, 0, 0).
+ /// The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Maroon = FromRgb(128, 0, 0);
/// <summary>
- /// The Navy is a predefined Color instance. It's RGB value is (0, 0, 128).
+ /// The Navy is a predefined Color instance, it's rgb value is (0, 0, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Navy = FromRgb(0, 0, 128);
/// <summary>
- /// The Olive is a predefined Color instance. It's RGB value is (128, 128, 0).
+ /// The Olive is a predefined Color instance, it's rgb value is (128, 128, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Olive = FromRgb(128, 128, 0);
/// <summary>
- /// The Orange is a predefined Color instance. It's RGB value is (255, 165, 0).
+ /// The Orange is a predefined Color instance, it's rgb value is (255, 165, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Orange = FromRgb(255, 165, 0);
/// <summary>
- /// The Purple is a predefined Color instance. It's RGB value is (128, 0, 128).
+ /// The Purple is a predefined Color instance, it's rgb value is (128, 0, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Purple = FromRgb(128, 0, 128);
/// <summary>
- /// The Pink is a predefined Color instance. It's RGB value is (255, 102, 255).
+ /// The Pink is a predefined Color instance, it's rgb value is (255, 102, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Pink = FromRgb(255, 102, 255);
/// <summary>
- /// The Red is a predefined Color instance. It's RGB value is (255, 0, 0).
+ /// The Red is a predefined Color instance, it's rgb value is (255, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Red = FromRgb(255, 0, 0);
/// <summary>
- /// The Silver is a predefined Color instance. It's RGB value is (192, 192, 192).
+ /// The Silver is a predefined Color instance, it's rgb value is (192, 192, 192).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Silver = FromRgb(192, 192, 192);
/// <summary>
- /// The Teal is a predefined Color instance. It's RGB value is (0, 128, 128).
+ /// The Teal is a predefined Color instance, it's rgb value is (0, 128, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Teal = FromRgb(0, 128, 128);
/// <summary>
- /// The White is a predefined Color instance. It's RGB value is (255, 255, 255).
+ /// The White is a predefined Color instance, it's rgb value is (255, 255, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color White = FromRgb(255, 255, 255);
/// <summary>
- /// The Yellow is a predefined Color instance. It's RGB value is (255, 255, 0).
+ /// The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Yellow = FromRgb(255, 255, 0);
{
/// <summary>
/// It inherits System.EventArgs.
- /// Event ColorChanged of the ColorSelector contains ColorChangedEventArgs as a parameter.
+ /// Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter.
/// Refer to <see cref="ColorSelector"/>type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ColorChangedEventArgs : EventArgs
{
/// <summary>
- /// Gets an old color in the color changed event.
+ /// Gets old color in color changed event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color OldColor { get; private set; }
/// <summary>
- /// Gets a new color in the color changed event.
+ /// Gets new color in color changed event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color NewColor { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the ColorChangedEventArgs class.
/// </summary>
- /// <param name="oldColor">Old color.</param>
- /// <param name="newColor">New color.</param>
+ /// <param name="oldColor">old color</param>
+ /// <param name="newColor">new color</param>
/// <since_tizen> preview </since_tizen>
public ColorChangedEventArgs(Color oldColor, Color newColor)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the modes of ColorSelector.
+ /// Enumeration for mode of ColorSelector
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ColorSelectorMode
{
/// <summary>
- /// Only the color palette is displayed, by default.
+ /// Only color palette is displayed, default
/// </summary>
Palette,
/// <summary>
- /// Only the color selector is displayed.
+ /// Only color selector is displayed
/// </summary>
[Obsolete("Components is obsolete as of version 1.2.3 and is no longer supported.")]
Components,
/// <summary>
- /// Both the palette and the selector is displayed.
+ /// Both Palette and selector is displayed
/// </summary>
[Obsolete("Both is obsolete as of version 1.2.3 and is no longer supported.")]
Both,
/// <summary>
- /// Only the color picker is displayed.
+ /// Only color picker is displayed
/// </summary>
[Obsolete("Picker is obsolete as of version 1.2.3 and is no longer supported.")]
Picker,
/// <summary>
- /// This mode is not supported. If you use this, nothing will be shown.
+ /// This mode is not supported. If you use this, nothing will be shown
/// </summary>
[Obsolete("Plane is obsolete as of version 1.2.3 and is no longer supported.")]
Plane,
/// <summary>
- /// This mode is not supported. If you use this, it will be shown same with the Palette mode.
+ /// This mode is not supported. If you use this, it will be shown same with Palette mode
/// </summary>
[Obsolete("PallettePlane is obsolete as of version 1.2.3 and is no longer supported.")]
PallettePlane,
/// <summary>
- /// This mode is not supported. If you use this, it will be shown same with the Palette mode.
+ /// This mode is not supported. If you use this, it will be shown same with Palette mode
/// </summary>
[Obsolete("All is obsolete as of version 1.2.3 and is no longer supported.")]
All
/// <summary>
/// The ColorSelector is a widget to set a series of colors.
- /// It also allows to load/save colors from/to the configuration with a unique identifier.
+ /// It also allows to load/save colors from/to config with a unique identifier.
/// </summary>
/// <remarks>
- /// By default, the colors are loaded/saved from/to configuration using the "default" identifier.
- /// The colors can be picked by the user from the color set by clicking on individual
- /// color items on the palette, or by selecting it from the selector.
+ /// By default, the colors are loaded/saved from/to config using "default" identifier.
+ /// The colors can be picked by user from the color set by clicking on individual
+ /// color item on the palette or by selecting it from selector.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public class ColorSelector : Layout
}
/// <summary>
- /// ColorChanged will be triggered when the SelectedColor is changed.
+ /// ColorChanged will be triggered when the SelectedColor changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ColorChangedEventArgs> ColorChanged
}
/// <summary>
- /// Gets or sets the color of colorselector.
+ /// Gets or sets color of colorselector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color SelectedColor
}
/// <summary>
- /// Gets the Alpha of a default Color class (value is -1).
+ /// Gets Alpha of a default Color Class(Value is -1).
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Gets or sets the Colorselector's mode.
+ /// Gets or sets Colorselector's mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ColorSelectorMode Mode
}
/// <summary>
- /// Gets or sets the current palette's name.
+ /// Get or set current palette's name.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string PaletteName
}
/// <summary>
- /// Adds a new color item to the palette.
+ /// Adds a new color item to palette.
/// </summary>
- /// <param name="color">The color item to add.</param>
+ /// <param name="color">Color item to add</param>
/// <returns>A new color palette Item.</returns>
/// <since_tizen> preview </since_tizen>
public ColorSelectorItem AddPaletteColor(Color color)
}
/// <summary>
- /// Clears the palette items.
+ /// Clear the palette items.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearPalette()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// An instance to the ColorSelector item gets added.
+ /// A instance to the ColorSelector item added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ColorSelectorItem : ItemObject
}
/// <summary>
- /// Gets or sets the palette item's color.
+ /// Gets or sets the Palette item's color
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color Color
namespace ElmSharp
{
/// <summary>
- /// The Conformant is a widget that can be used in elementary applications
+ /// 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.
/// </summary>
/// <summary>
/// Creates and initializes a new instance of the Conformant class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by Conformant
- /// as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Conformant
+ /// as a child.It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Conformant(Window parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="Widget"/>.
- /// The Container is an abstract class.
- /// The other class inherits it to elementary, which is about displaying
+ /// The Container is a abstract class.
+ /// Other class inherits it to Elementary is about displaying
/// its widgets in a nice layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
HashSet<EvasObject> _children = new HashSet<EvasObject>();
/// <summary>
- /// Creates and initializes a new instance of the class, which inherit from the Container.
+ /// Creates and initializes a new instance of class which inherit from Container.
/// </summary>
- /// <param name="parent">The parent is a given object, which will be attached by the Container
- /// as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given object which will be attached by Container
+ /// as a child.It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Container(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of the Container class.
+ /// Creates and initializes a new instance of Container class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Container() : base()
}
/// <summary>
- /// Gets the collection of a child EvasObject of the Container.
+ /// Gets the collection of child EvasObject of the Container.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected IEnumerable<EvasObject> Children => _children;
/// <summary>
- /// Add the EvasObject object as a child of the Container.
+ /// Add an EvasObject object as a child of Container.
/// </summary>
- /// <param name="obj">The EvasObject object to be added.</param>
+ /// <param name="obj">The EvasObject object to be added</param>
/// <since_tizen> preview </since_tizen>
protected void AddChild(EvasObject obj)
{
}
/// <summary>
- /// Removes the EvasObject object as a child of the Container.
+ /// Remove an EvasObject object as a child of Container.
/// </summary>
- /// <param name="obj">The EvasObject object to be removed.</param>
+ /// <param name="obj">The EvasObject object to be removed</param>
/// <since_tizen> preview </since_tizen>
protected void RemoveChild(EvasObject obj)
{
}
/// <summary>
- /// Clears all the children of the Container.
+ /// Clear all children of the Container.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected void ClearChildren()
}
/// <summary>
- /// The Container callback that is invoked when a child is removed.
+ /// The Container Callback that is invoked when a child is removed.
/// </summary>
- /// <param name="sender">The called Container.</param>
+ /// <param name="sender">The called Container</param>
/// <param name="a"><see cref="EventArgs"/></param>
void OnChildDeleted(object sender, EventArgs a)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the ContextPopup direction types.
+ /// Enumeration of ContextPopup direction type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ContextPopupDirection
{
/// <summary>
- /// The ContextPopup appears below the clicked area.
+ /// ContextPopup show appear below clicked area
/// /// </summary>
Down,
/// <summary>
- /// The ContextPopup appears to the right of the clicked area.
+ /// ContextPopup show appear to the right of the clicked area
/// </summary>
Right,
/// <summary>
- /// The ContextPopup appears to the left of the clicked area.
+ /// ContextPopup show appear to the left of the clicked area
/// </summary>
Left,
/// <summary>
- /// The ContextPopup appears above the clicked area.
+ /// ContextPopup show appear above the clicked area
/// </summary>
Up,
/// <summary>
- /// The ContextPopup does not determine it's direction yet.
+ /// ContextPopup does not determine it's direction yet
/// </summary>
Unknown
}
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The ContextPopup is a widget that when shown, pops up a list of items.
+ /// The ContextPopup is a widget that when it shown, pops up a list of items.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ContextPopup : Layout
/// <summary>
/// Creates and initializes a new instance of the ContextPopup class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by ContextPopup
- /// as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by ContextPopup
+ /// as a child.It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public ContextPopup(EvasObject parent) : base(parent)
{
/// Dismissed is raised when the ContextPopup item is dismissed.
/// </summary>
/// <remarks>
- /// Outside of ContextPopup is clicked or it's parent area is changed or the language is changed, and then ContextPopup is dismissed.
+ /// Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
/// Gets the current direction of a ContextPopup.
/// </summary>
/// <remarks>
- /// Once the ContextPopup shows up, the direction would be determined.
+ /// Once the ContextPopup showed up, the direction would be determined.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public ContextPopupDirection Direction
}
/// <summary>
- /// Gets or sets the value of the current ContextPopup object's orientation.
- /// True for horizontal mode, False for vertical mode (or errors).
+ /// Gets or sets the value of current ContextPopup object's orientation.
+ /// True for horizontal mode, False for vertical mode (or errors)
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Gets or sets whether the ContextPopup hides automatically
- /// or not when the parent of the ContextPopup is resized.
+ /// Gets or sets whether ContextPopup hide automatically
+ /// or not when parent of ContextPopup is resized.
/// </summary>
/// <remarks>
/// Default value of AutoHide is False.
}
/// <summary>
- /// Clears all the items in a given ContextPopup object.
+ /// Clears all items in the given ContextPopup object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
/// <summary>
/// Sets the direction priority of a ContextPopup.
/// </summary>
- /// <param name="first">1st priority of the direction.</param>
- /// <param name="second">2nd priority of the direction.</param>
- /// <param name="third">3th priority of the direction.</param>
- /// <param name="fourth">4th priority of the direction.</param>
+ /// <param name="first">1st priority of direction </param>
+ /// <param name="second">2nd priority of direction </param>
+ /// <param name="third">3th priority of direction </param>
+ /// <param name="fourth">4th priority of direction</param>
/// <since_tizen> preview </since_tizen>
public void SetDirectionPriorty(ContextPopupDirection first, ContextPopupDirection second, ContextPopupDirection third, ContextPopupDirection fourth)
{
/// <summary>
/// Gets the direction priority of a ContextPopup.
/// </summary>
- /// <param name="first">1st priority of the direction to be returned.</param>
- /// <param name="second">2nd priority of the direction to be returned.</param>
- /// <param name="third">2nd priority of the direction to be returned.</param>
- /// <param name="fourth">4th priority of the direction to be returned.</param>
+ /// <param name="first">1st priority of direction to be returned</param>
+ /// <param name="second">2nd priority of direction to be returned</param>
+ /// <param name="third">2nd priority of direction to be returned </param>
+ /// <param name="fourth">4th priority of direction to be returned</param>
/// <since_tizen> preview </since_tizen>
public void GetDirectionPriority(out ContextPopupDirection first, out ContextPopupDirection second, out ContextPopupDirection third, out ContextPopupDirection fourth)
{
}
/// <summary>
- /// Adds a new item to a ContextPopup object with the label.
+ /// Adds a new item to a ContextPopup object with label.
/// </summary>
- /// <param name="label">Label of the new item.</param>
+ /// <param name="label">The Label of the new item</param>
/// <returns>
- /// A ContextPopupItem added, or null on errors.
+ /// A ContextPopupItem added or NULL, on errors
/// </returns>
/// <since_tizen> preview </since_tizen>
public ContextPopupItem Append(string label)
}
/// <summary>
- /// Adds a new item to a ContextPopup object with the label and icon.
+ /// Adds a new item to a ContextPopup object with label and icon.
/// </summary>
- /// <param name="label">Label of the new item.</param>
- /// <param name="icon">Icon to be set on the new item.</param>
- /// <returns>A ContextPopupItem added, or null on errors.</returns>
+ /// <param name="label">The Label of the new item</param>
+ /// <param name="icon">Icon to be set on new item</param>
+ /// <returns>A ContextPopupItem added or NULL, on errors</returns>
/// <since_tizen> preview </since_tizen>
public ContextPopupItem Append(string label, EvasObject icon)
{
}
/// <summary>
- /// Dismisses a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
+ /// Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dismiss()
}
/// <summary>
- /// Gets the possibility that the direction would be available.
+ /// Gets the possibility that the direction would be available
/// </summary>
- /// <param name="direction">A direction that the user wants to check.</param>
+ /// <param name="direction">A direction user wants to check</param>
/// <returns>
- /// Get false if you cannot put it in the direction. Get true if it's possible.
+ /// Get false if you cannot put it in the direction. Gets true if it's possible.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool IsAvailableDirection(ContextPopupDirection direction)
}
/// <summary>
- /// Gets the Alpha of a default Color class.
+ /// Gets Alpha of a default Color Class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// An instance to the ContextPopup item is added.
+ /// A instance to the ContextPopup item added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ContextPopupItem : ItemObject
public string Text { get; internal set; }
/// <summary>
- /// Gets the Icon (type is <see cref="EvasObject"/>) property of the given ContextPopupItem.
+ /// Gets the Icon(type is <see cref="EvasObject"/>) property of the given ContextPopupItem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Icon { get; internal set; }
/// <summary>
- /// Selected will be triggered when the ContextPopupItem is selected.
+ /// Selected will be triggered when the ContextPopupItem is Selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
{
/// <summary>
/// It inherits System.EventArgs.
- /// The DateChanged event in the Calendar and the DateTimeChanged event in DateTimeSelector
- /// contain the DateChangedEventArgs as a parameter.
+ /// The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector.
+ /// contain DateChangedEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DateChangedEventArgs : EventArgs
/// Creates and initializes a new instance of the DateChangedEventArgs class.
/// </summary>
/// <param name="oldDate">
- /// Old date when the DateChanged event or DateTimeChanged event triggered.
+ /// Old date when DateChanged event or DateTimeChanged event triggered
/// </param>
/// <param name="newDate">
- /// New date when the DateChanged event or DateTimeChanged event triggered.
+ /// New date when DateChanged event or DateTimeChanged event triggered
/// </param>
/// <since_tizen> preview </since_tizen>
public DateChangedEventArgs(DateTime oldDate, DateTime newDate)
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the datetime field types for DateTimeSelector.
+ /// Enumeration of datetime field types for DateTimeSelector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum DateTimeFieldType
{
/// <summary>
- /// Indicates the Year field.
+ /// Indicates Year field.
/// </summary>
Year,
/// <summary>
- /// Indicates the Month field.
+ /// Indicates Month field.
/// </summary>
Month,
/// <summary>
- /// Indicates the Date field.
+ /// Indicates Date field.
/// </summary>
Date,
/// <summary>
- /// Indicates the Hour field.
+ /// Indicates Hour field.
/// </summary>
Hour,
/// <summary>
- /// Indicates the Minute field.
+ /// Indicates Minute field.
/// </summary>
Minute,
/// <summary>
- /// Indicates the AM/PM field.
+ /// Indicates AM/PM field.
/// </summary>
AmPm
}
/// <summary>
- /// It inherits <see cref="Layout"/>.
- /// The DateTimeSelector is a widget to display and input the date & time values.
- /// This widget displays the date and time as per the system's locale settings
- /// (Date includes Day, Month & Year) along with the defined separators and time including hour, minute & AM/PM fields. Separator for the AM/PM field is ignored.
+ /// It inherits <see cref="Layout"/>
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DateTimeSelector : Layout
/// <summary>
/// Creates and initializes a new instance of the DateTimeSelector class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the DateTimeSelector
- /// as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by DateTimeSelector
+ ///as a child.It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public DateTimeSelector(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of the DateTimeSelector class.
+ /// Creates and initializes a new instance of DateTimeSelector class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected DateTimeSelector() : base()
}
/// <summary>
- /// ItemSelected is raised when the DateTime field value is changed.
+ /// ItemSelected is raised when Datetime field value changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<DateChangedEventArgs> DateTimeChanged;
/// Gets or sets the datetime format.
/// </summary>
/// <remarks>
- /// Format is a combination of the allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p".
+ /// format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p".
/// </remarks>
/// <since_tizen> preview </since_tizen>
public string Format
}
/// <summary>
- /// Gets or sets the upper boundary of the DateTime field.
+ /// Gets or sets the upper boundary of DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime MaximumDateTime
}
/// <summary>
- /// Gets or sets the lower boundary of the DateTime field.
+ /// Gets or sets the lower boundary of DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime MinimumDateTime
}
/// <summary>
- /// Gets or sets the current value of the DateTime field.
+ /// Gets or sets the current value of DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime DateTime
/// <summary>
/// Gets whether a field can be visible.
/// </summary>
- /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
+ /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
/// <returns>
/// The field is visible or not.
- /// Type is bool. If visible, return true.
+ /// Type is bool.If visible, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool IsFieldVisible(DateTimeFieldType type)
/// <summary>
/// Sets the field limits of a field.
/// </summary>
- /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
- /// <param name="minimum">The minimum limit.</param>
- /// <param name="maximum">The maximum limit.</param>
+ /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
+ /// <param name="minimum">minimum limit</param>
+ /// <param name="maximum">maximum limit</param>
/// <since_tizen> preview </since_tizen>
public void SetFieldLimit(DateTimeFieldType type, int minimum, int maximum)
{
/// <summary>
/// Gets whether a field can be visible.
/// </summary>
- /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
- /// <param name="visible">When set as true, the field type is visible.</param>
+ /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
+ /// <param name="visible">When set as true, the field type visible.</param>
/// <since_tizen> preview </since_tizen>
public void SetFieldVisible(DateTimeFieldType type, bool visible)
{
}
/// <summary>
- /// The callback of the Realized event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits System.EventArgs.
- /// The DisplayedMonthChangedEvent in a calendar contains the
+ /// The DisplayedMonthChangedEvent in Calendar contain
/// DisplayedMonthChangedEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// Creates and initializes a new instance of the DisplayedMonthChangedEventArgs class.
/// </summary>
/// <param name="oldMonth">
- /// Old month of the date when the DisplayedMonthChangedEvent triggered.
+ /// old month of date when DisplayedMonthChangedEvent triggered.
/// </param>
/// <param name="newMonth">
- /// New month of the date when the DisplayedMonthChangedEvent triggered.
+ /// new month of date when DisplayedMonthChangedEvent triggered.
/// </param>
/// <since_tizen> preview </since_tizen>
public DisplayedMonthChangedEventArgs(int oldMonth, int newMonth)
namespace ElmSharp
{
/// <summary>
- /// EcoreAnimator is a helper class. It provides the functions to manage animations.
+ /// EcoreAnimator is a helper class, it provides functions to manager animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class EcoreAnimator
}
/// <summary>
- /// Gets the current system time as a floating point value in seconds.
+ /// Gets current system time as a floating point value in seconds.
/// </summary>
/// <returns>Current system time</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Adds an animator to call <paramref name="handler"/> at every animation tick during the main loop execution.
+ /// Adds an animator to call <paramref name="handler"/> at every animation tick during main loop execution.
/// </summary>
- /// <param name="handler">The function to call when it ticks off.</param>
- /// <returns>A handle to the new animator.</returns>
+ /// <param name="handler">The function to call when it ticks off</param>
+ /// <returns>A handle to the new animator</returns>
/// <since_tizen> preview </since_tizen>
public static IntPtr AddAnimator(Func<bool> handler)
{
/// <summary>
/// Removes the specified animator from the animator list.
/// </summary>
- /// <param name="anim">The specified animator handle.</param>
+ /// <param name="anim">The specified animator handle</param>
/// <since_tizen> preview </since_tizen>
public static void RemoveAnimator(IntPtr anim)
{
namespace ElmSharp
{
/// <summary>
- /// The EcoreEventType is a type of EcoreEvent.
+ /// The EcoreEventType is type of EcoreEvent.
/// It includes some predefined instance.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// The EcoreEvent is a class to help create events that are being notified of events.
+ /// The EcoreEvent is a class to help to create events are being notified of events.
/// </summary>
- /// <typeparam name="TEventArgs">Kinds of EventArgs.</typeparam>
+ /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
/// <since_tizen> preview </since_tizen>
public class EcoreEvent<TEventArgs> : IDisposable where TEventArgs : EventArgs
{
/// <summary>
- /// EventInfoParser delegate of the EcoreEvent class.
+ /// EventInfoParser delegate of EcoreEvent class
/// </summary>
/// <param name="data">IntPtr</param>
/// <param name="type">EcoreEventType</param>
}
/// <summary>
- /// Destructor for the EcoreEvent class.
+ /// Destructor for EcoreEvent class.
/// </summary>
~EcoreEvent()
{
}
/// <summary>
- /// On Event Handler of the EcoreEvent.
+ /// On Event Handler of EcoreEvent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed,
- /// otherwise false.
+ /// true if managed resources should be disposed
+ /// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// The event class for EcoreEvent.
+ /// Event class for EcoreEvent
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreEvent : EcoreEvent<EventArgs>
{
/// <summary>
/// It inherits System.EventArgs.
- /// The EcoreKeyEventArgs is an EventArgs to record the Ecore event's key name and key code.
+ /// The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreKeyEventArgs : EventArgs
{
/// <summary>
- /// Gets the KeyName property. The return type is string.
+ /// Gets the KeyName property.The return type is string.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string KeyName { get; private set; }
/// <summary>
- /// Gets the KeyCode property. The return type is int.
+ /// Gets the KeyCode property.The return type is int.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int KeyCode { get; private set; }
/// </summary>
/// <param name="data">data</param>
/// <param name="type">type</param>
- /// <param name="info">information</param>
- /// <returns>New instance of the EcoreKeyEventArgs class.</returns>
+ /// <param name="info">information </param>
+ /// <returns>new instance of the EcoreKeyEventArgs class</returns>
/// <since_tizen> preview </since_tizen>
public static EcoreKeyEventArgs Create(IntPtr data, EcoreEventType type, IntPtr info)
{
namespace ElmSharp
{
/// <summary>
- /// EcoreMainloop is a helper class, which provides the functions relative to Ecore's main loop.
+ /// EcoreMainloop is a helper class, it provide functions relative Ecore's main loop.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class EcoreMainloop
/// <summary>
/// Checks if you are calling this function from the main thread.
/// </summary>
- /// <remarks>True if the calling function is the same thread, false otherwise.</remarks>
+ /// <remarks>True is the calling function is the same thread, false otherwise.</remarks>
/// <since_tizen> preview </since_tizen>
public static bool IsMainThread => Interop.Eina.eina_main_loop_is();
}
/// <summary>
- /// Quits the main loop, once all the events currently on the queue have been processed.
+ /// Quits the main loop once all the events currently on the queue have been processed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void Quit()
/// <summary>
/// Adds an idler handler.
/// </summary>
- /// <param name="task">The action to call when idle.</param>
+ /// <param name="task">The action to call when idling</param>
/// <since_tizen> preview </since_tizen>
public static void Post(Action task)
{
}
/// <summary>
- /// Calls the callback asynchronously in the main loop.
+ /// Calls callback asynchronously in the main loop.
/// </summary>
- /// <param name="task">The action wanted to be called.</param>
+ /// <param name="task">The action wanted to be called</param>
/// <since_tizen> preview </since_tizen>
public static void PostAndWakeUp(Action task)
{
}
/// <summary>
- /// Calls the callback synchronously in the main loop.
+ /// Calls callback synchronously in the main loop.
/// </summary>
- /// <param name="task">The action wanted to be called.</param>
+ /// <param name="task">The action wanted to be called</param>
/// <since_tizen> preview </since_tizen>
public static void Send(Action task)
{
/// </summary>
/// <param name="interval">The interval in seconds.</param>
/// <param name="handler">The given function.</param>
- /// <returns>A timer object handler on success, or null on failure.</returns>
+ /// <returns>A timer object handler on success, NULL on failure.</returns>
/// <since_tizen> preview </since_tizen>
public static IntPtr AddTimer(double interval, Func<bool> handler)
{
{
/// <summary>
- /// Provides a synchronization context for the EFL application.
+ /// Provides a synchronization context for the efl application.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreSynchronizationContext : SynchronizationContext
}
/// <summary>
- /// Initilizes a new EcoreSynchronizationContext and installs into the current thread.
+ /// Initilizes a new EcoreSynchronizationContext and install into current thread
/// </summary>
/// <remarks>
/// It is equivalent
}
/// <summary>
- /// Dispatches an synchronous message to a Ecore main loop.
+ /// Dispatches a synchronous message to a Ecore main loop
/// </summary>
/// <param name="d"><see cref="System.Threading.SendOrPostCallback"/>The SendOrPostCallback delegate to call.</param>
/// <param name="state"><see cref="System.Object"/>The object passed to the delegate.</param>
namespace ElmSharp
{
/// <summary>
- /// EcoreTimelineAnimator is a helper class, which provides the functions to manage animations.
+ /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreTimelineAnimator
/// <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>
+ /// <param name="runtime">The time to run in seconds</param>
+ /// <param name="timelineCallback">Functions called at each time line</param>
/// <since_tizen> preview </since_tizen>
public EcoreTimelineAnimator(double runtime, Action timelineCallback)
{
public double Position => _position;
/// <summary>
- /// Starts an animator that runs for a limited time.
+ /// Starts an animator that runs for a limited time.for a limited time.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Start()
}
/// <summary>
- /// Stops an animator that is running.
+ /// Stops an animator that running.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Stop()
}
/// <summary>
- /// Callback is called when it ticks off.
+ /// Callback that is called when ticks off
/// </summary>
/// <since_tizen> preview </since_tizen>
protected void OnTimeline()
namespace ElmSharp
{
/// <summary>
- /// The EdjeObject is a class that the evas object exists in.
+ /// The EdjeObject is a class that evas object exist in
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EdjeObject
/// Checks whether an edje part exists in a given edje object's group definition.
/// This function returns if a given part exists in the edje group bound to object obj
/// </summary>
- /// <remarks>This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to object.</remarks>
- /// <param name="part">The part's name to check for existence in object's group.</param>
- /// <returns>TRUE, if the edje part exists in the object's group, otherwise FALSE.</returns>
+ /// <remarks>This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj.</remarks>
+ /// <param name="part">The part's name to check for existence in obj's group</param>
+ /// <returns>TRUE, if the edje part exists in obj's group, otherwise FALSE</returns>
/// <since_tizen> preview </since_tizen>
public EdjeTextPartObject this[string part]
{
}
/// <summary>
- /// Sends or emits an edje signal to a given edje object.
+ /// Sends/emits an edje signal to a given edje object.
/// </summary>
/// <param name="emission">The signal's "emission" string</param>
/// <param name="source">The signal's "source" string</param>
}
/// <summary>
- /// Deletes the object Color class.
- /// This function deletes any values at the object level for the specified object and Color class.
+ /// Deletes the object color class.
+ /// This function deletes any values at the object level for the specified object and color class.
/// </summary>
- /// <remarks>Deleting the Color class defined in the theme file.</remarks>
- /// <param name="part">The Color class to be deleted.</param>
+ /// <remarks>Deleting the color class defined in the theme file.</remarks>
+ /// <param name="part">The color class to be deleted</param>
/// <since_tizen> preview </since_tizen>
public void DeleteColorClass(string part)
{
}
/// <summary>
- /// Sets the object Color class.
+ /// Sets the object color class.
/// </summary>
- /// <param name="colorClass">The Color class name.</param>
- /// <param name="red">The object red value.</param>
- /// <param name="green">The object green value.</param>
- /// <param name="blue">The object blue value.</param>
- /// <param name="alpha">The object alpha value.</param>
- /// <param name="outlineRed">The outline red value.</param>
- /// <param name="outlineGreen">The outline green value.</param>
- /// <param name="outlineBlue">The outline blue value.</param>
- /// <param name="outlineAlpha">The outline alpha value.</param>
- /// <param name="shadowRed">The shadow red value.</param>
- /// <param name="shadowGreen">The shadow green value.</param>
- /// <param name="shadowBlue">The shadow blue value.</param>
- /// <param name="shadowAlpha">The shadow alpha value.</param>
- /// <returns>True if succeeds, otherwise False.</returns>
+ /// <param name="colorClass">The color class name.</param>
+ /// <param name="red">The object Red value.</param>
+ /// <param name="green">The object Green value.</param>
+ /// <param name="blue">The object Blue value.</param>
+ /// <param name="alpha">The object Alpha value.</param>
+ /// <param name="outlineRed">The outline Red value.</param>
+ /// <param name="outlineGreen">The outline Green value.</param>
+ /// <param name="outlineBlue">The outline Blue value.</param>
+ /// <param name="outlineAlpha">The outline Alpha value.</param>
+ /// <param name="shadowRed">The shadow Red value.</param>
+ /// <param name="shadowGreen">The shadow Green value.</param>
+ /// <param name="shadowBlue">The shadow Blue value.</param>
+ /// <param name="shadowAlpha">The shadow Alpha value.</param>
+ /// <returns>True if succeed, otherwise False</returns>
/// <since_tizen> preview </since_tizen>
public bool SetColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha)
}
/// <summary>
- /// Gets the object Color class.
+ /// Gets the object color class.
/// </summary>
- /// <param name="colorClass">The Color class name.</param>
- /// <param name="red">The object red value.</param>
- /// <param name="green">The object green value.</param>
- /// <param name="blue">The object blue value.</param>
- /// <param name="alpha">The object alpha value.</param>
- /// <param name="outlineRed">The outline red value.</param>
- /// <param name="outlineGreen">The outline green value.</param>
- /// <param name="outlineBlue">The outline blue value.</param>
- /// <param name="outlineAlpha">The outline alpha value.</param>
- /// <param name="shadowRed">The shadow red value.</param>
- /// <param name="shadowGreen">The shadow green value.</param>
- /// <param name="shadowBlue">The shadow blue value.</param>
- /// <param name="shadowAlpha">The shadow alpha value.</param>
- /// <returns>True if succeeds, otherwise False.</returns>
+ /// <param name="colorClass">The color class name.</param>
+ /// <param name="red">The object Red value.</param>
+ /// <param name="green">The object Green value.</param>
+ /// <param name="blue">The object Blue value.</param>
+ /// <param name="alpha">The object Alpha value.</param>
+ /// <param name="outlineRed">The outline Red value.</param>
+ /// <param name="outlineGreen">The outline Green value.</param>
+ /// <param name="outlineBlue">The outline Blue value.</param>
+ /// <param name="outlineAlpha">The outline Alpha value.</param>
+ /// <param name="shadowRed">The shadow Red value.</param>
+ /// <param name="shadowGreen">The shadow Green value.</param>
+ /// <param name="shadowBlue">The shadow Blue value.</param>
+ /// <param name="shadowAlpha">The shadow Alpha value.</param>
+ /// <returns>True if succeed, otherwise False</returns>
/// <since_tizen> preview </since_tizen>
public bool GetColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue, out int outlineAlpha,
out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha)
}
/// <summary>
- /// Sets the Edje text class.
+ /// Sets Edje text class.
/// </summary>
/// <param name="textClass">The text class name.</param>
- /// <param name="font">Font name.</param>
+ /// <param name="font"> Font name.</param>
/// <param name="fontSize">Font size.</param>
- /// <returns>True if succeeds, otherwise False.</returns>
+ /// <returns>True if succeed, otherwise False</returns>
/// <since_tizen> preview </since_tizen>
public bool SetTextClass(string textClass, string font, int fontSize)
{
}
/// <summary>
- /// Gets the Edje text class.
+ /// Gets Edje text class.
/// </summary>
/// <param name="textClass">The text class name.</param>
/// <param name="font">Font name.</param>
/// <param name="fontSize">Font size.</param>
- /// <returns>True if succeeds, otherwise False.</returns>
+ /// <returns>True if succeed, otherwise False</returns>
/// <since_tizen> preview </since_tizen>
public bool GetTextClass(string textClass, out string font, out int fontSize)
{
/// <summary>
/// Adds Action for an arriving edje signal, emitted by a given Ejde object.
/// </summary>
- /// <param name="emission">The signal's "emission" string.</param>
- /// <param name="source">The signal's "source" string.</param>
- /// <param name="action">The action to be executed when the signal is emitted.</param>
+ /// <param name="emission">The signal's "emission" string</param>
+ /// <param name="source">The signal's "source" string</param>
+ /// <param name="action">The action to be executed when the signal is emitted</param>
/// <since_tizen> preview </since_tizen>
public void AddSignalAction(string emission, string source, Action<string, string> action)
{
/// <summary>
/// Deletes a signal-triggered action from an object.
/// </summary>
- /// <param name="emission">The signal's "emission" string.</param>
- /// <param name="source">The signal's "source" string.</param>
- /// <param name="action">The action to be executed when the signal is emitted.</param>
+ /// <param name="emission">The signal's "emission" string</param>
+ /// <param name="source">The signal's "source" string</param>
+ /// <param name="action">The action to be executed when the signal is emitted</param>
/// <since_tizen> preview </since_tizen>
public void DeleteSignalAction(string emission, string source, Action<string, string> action)
{
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value.
+ /// true if obj and this instance are the same type and represent the same value.
/// otherwise, false.
/// </returns>
public override bool Equals(object obj)
}
/// <summary>
- /// The EdjeTextPartObject is a class dealing with parts of type text.
+ /// An EdjeTextPartObject is a class dealing with parts of type text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EdjeTextPartObject
}
/// <summary>
- /// Gets the name of the EdjeTextPartObject.
+ /// Gets the name of the EdjeTextPartObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Name { get { return _part; } }
namespace ElmSharp
{
/// <summary>
- /// The EffectBase class for TransitEffect.
+ /// EffectBase class for the TransitEffect
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class EffectBase
{
/// <summary>
- /// EffectEnded event will be triggered when the effect has ended.
+ /// EffectEneded event will be triggered when be effect ended.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler EffectEnded;
namespace ElmSharp
{
/// <summary>
- /// Focus Autoscroll mode.
+ /// Focus Autoscroll Mode
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FocusAutoScrollMode
{
/// <summary>
- /// Directly show the focused region or item automatically.
+ /// Directly show the focused region or item automatically
/// </summary>
Show,
/// <summary>
- /// Do not show the focused region or item automatically.
+ /// Do not show the focused region or item automatically
/// </summary>
None,
/// <summary>
- /// Bring in the focused region or item automatically, which might involve the scrolling.
+ /// Bring in the focused region or item automatically which might invole the scrolling
/// </summary>
BringIn
}
/// <summary>
- /// The Elementary is a general elementary, a VERY SIMPLE toolkit.
+ /// The Elementary is a General Elementary,a VERY SIMPLE toolkit.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class Elementary
}
/// <summary>
- /// Gets or sets the enable status of the focus highlight animation.
+ /// Gets or sets the enable status of the focus highlight animation
/// </summary>
/// <since_tizen> preview </since_tizen>
public static bool IsFocusHighlightAnimation
}
/// <summary>
- /// Gets or sets the amount of inertia, a scroller imposes during a region to bring animations.
+ /// Gets or sets the amount of inertia a scroller imposes during region bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double BringInScrollFriction
}
/// <summary>
- /// Gets or sets the focus on autoscroll mode.
+ /// Gets of sets focus auto scroll mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static FocusAutoScrollMode FocusAutoScrollMode
}
/// <summary>
- /// Runs the elementary's main loop.
+ /// Runs Elementary's main loop.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void Run()
}
/// <summary>
- /// Prepends a theme overlay to the list of overlays.
+ /// Prepends a theme overlay to the list of overlays
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Prepends a theme overlay to the list of overlays.
+ /// Prepends a theme overlay to the list of overlays
/// </summary>
- /// <param name="filePath">The edje file path to be used.</param>
+ /// <param name="filePath">The Edje file path to be used.</param>
/// <since_tizen> preview </since_tizen>
public static void AddThemeOverlay(string filePath)
{
}
/// <summary>
- /// Deletes a theme overlay from the list of overlays.
+ /// Delete a theme overlay from the list of overlays
/// </summary>
/// <param name="filePath">The name of the theme overlay.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Frees a theme.
+ /// Free a theme
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FreeTheme()
}
/// <summary>
- /// Sets the theme search order for the given theme.
+ /// Set the theme search order for the given theme
/// </summary>
- /// <param name="theme">Theme search string.</param>
- /// <remarks>This sets the search string for the theme in path-notation from the first theme to search, to last, delimited by the : character. For example, "shiny:/path/to/file.edj:default".</remarks>
+ /// <param name="theme">Theme search string</param>
+ /// <remarks>This sets the search string for the theme in path-notation from first theme to search, to last, delimited by the : character. Example:"shiny:/path/to/file.edj:default"</remarks>
/// <since_tizen> preview </since_tizen>
public static void SetTheme(string theme)
{
}
/// <summary>
- /// Flushes the current theme.
+ /// Flush the current theme.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushTheme()
}
/// <summary>
- /// This flushes all the themes (default and specific ones).
+ /// This flushes all themes (default and specific ones).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllThemes()
}
/// <summary>
- /// Gets the amount of inertia that a scroller imposes during region to bring animations.
+ /// Gets the amount of inertia a scroller imposes during region bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets the amount of inertia that a scroller imposes during the region bring animations.
+ /// Sets the amount of inertia a scroller imposes during region bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the elementary's profile in use.
+ /// Get Elementary's profile in use
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets the global scaling factor.
+ /// Set the global scaling factor
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the global scaling factor.
+ /// Get the global scaling factor
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Flushes all the cache.
- /// Frees all data that was in cache and is not currently being used, to reduce memory usage. This frees Edje's, Evas', and Eet's cache.
+ /// Flush all caches.
+ /// Frees all data that was in cache and is not currently being used to reduce memory usage. This frees Edje's, Evas' and Eet's cache.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllCache()
/// <summary>
/// Changes the language of the current application.
/// </summary>
- /// <param name="language">The language to set must be the full name of the locale.</param>
+ /// <param name="language">The language to set, must be the full name of the locale.</param>
/// <since_tizen> preview </since_tizen>
public static void SetLanguage(string language)
{
/// <summary>
/// Sets a new policy's value (for a given policy group/identifier).
/// </summary>
- /// <param name="policy">The policy identifier.</param>
- /// <param name="value">The policy value, which depends on the identifier.</param>
+ /// <param name="policy">The policy identifier</param>
+ /// <param name="value">The policy value, which depends on the identifier</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public static bool SetPolicy(uint policy, int value)
}
/// <summary>
- /// Reloads the elementary's configuration, bounded to the current selected profile.
+ /// Reload Elementary's configuration, bounded to current selected profile.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Flushes all the configuration settings, and then applies those settings to all applications using elementary on the current display.
+ /// Flushes all config settings and then applies those settings to all applications using elementary on the current display.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllConfig()
namespace ElmSharp
{
/// <summary>
- /// The ElmScrollConfig is a scrollable views's configuration.
+ /// The ElmScrollConfig is a scrollable views's config
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class ElmScrollConfig
{
/// <summary>
- /// Gets or sets the amount of inertia that a scroller imposes during the region to bring animations.
+ /// Gets or sets the amount of inertia a scroller imposes during region bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
namespace ElmSharp
{
/// <summary>
- /// Enumeration for describing the InputPanel layout types.
+ /// Enumeration for describing InputPanel layout type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelLayout
{
/// <summary>
- /// The InputPanel layout type default.
+ /// InputPanel layout type default.
/// </summary>
Normal,
/// <summary>
- /// The InputPanel layout type number.
+ /// InputPanel layout type number.
/// </summary>
Number,
/// <summary>
- /// The InputPanel layout type email.
+ /// InputPanel layout type email.
/// </summary>
Email,
/// <summary>
- /// The InputPanel layout type URL.
+ /// InputPanel layout type url.
/// </summary>
Url,
/// <summary>
- /// The InputPanel layout type phone.
+ /// InputPanel layout type phone.
/// </summary>
PhoneNumber,
/// <summary>
- /// The InputPanel layout type IP.
+ /// InputPanel layout type ip.
/// </summary>
Ip,
/// <summary>
- /// The InputPanel layout type month.
+ /// InputPanel layout type month.
/// </summary>
Month,
/// <summary>
- /// The InputPanel layout type number.
+ /// InputPanel layout type number.
/// </summary>
NumberOnly,
/// <summary>
- /// The InputPanel layout type error type. Do not use it directly!
+ /// InputPanel layout type error type. Do not use it directly!
/// </summary>
Invalid,
/// <summary>
- /// The InputPanel layout type hexadecimal.
+ /// InputPanel layout type hexadecimal.
/// </summary>
Hex,
/// <summary>
- /// The InputPanel layout type terminal type: Esc, Alt, Ctrl, etc.
+ /// InputPanel layout type terminal type, esc, alt, ctrl, etc.
/// </summary>
Terminal,
/// <summary>
- /// The InputPanel layout type password.
+ /// InputPanel layout type password.
/// </summary>
Password,
/// <summary>
- /// The keyboard layout type date and time.
+ /// Keyboard layout type date and time.
/// </summary>
DateTime,
/// <summary>
- /// The InputPanel layout type emoticons.
+ /// InputPanel layout type emoticons.
/// </summary>
Emoticon
}
/// <summary>
- /// Enumeration for defining the "Return" key types on the input panel (virtual keyboard).
+ /// Enumeration that defines the "Return" key types on the input panel (virtual keyboard).
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelReturnKeyType
{
/// <summary>
- /// The Default key type.
+ /// Default key type
/// </summary>
Default,
/// <summary>
- /// The Done key type.
+ /// Done key type
/// </summary>
Done,
/// <summary>
- /// The Go key type.
+ /// Go key type
/// </summary>
Go,
/// <summary>
- /// The Join key type.
+ /// Join key type
/// </summary>
Join,
/// <summary>
- /// The Login key type.
+ /// Login key type
/// </summary>
Login,
/// <summary>
- /// The Next key type.
+ /// Next key type
/// </summary>
Next,
/// <summary>
- /// The Search string or magnifier icon key type.
+ /// Search string or magnifier icon key type
/// </summary>
Search,
/// <summary>
- /// The Send key type.
+ /// Send key type
/// </summary>
Send,
/// <summary>
- /// The Sign-in key type.
+ /// Sign-in key type
/// </summary>
Signin
}
/// <summary>
- /// Enumeration for defining the autocapitalization types.
+ /// Enumeration that defines the autocapitalization types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AutoCapital
{
/// <summary>
- /// No autocapitalization when typing.
+ /// No autocapitalization when typing
/// </summary>
None,
/// <summary>
- /// Autocapitalize each of the typed word.
+ /// Autocapitalize each typed word
/// </summary>
Word,
/// <summary>
- /// Autocapitalize the start of each sentence.
+ /// Autocapitalize the start of each sentence
/// </summary>
Sentence,
/// <summary>
- /// Autocapitalize all the letters.
+ /// Autocapitalize all letters
/// </summary>
All
}
/// <summary>
- /// Enumeration for defining the entry's copy and paste policy.
+ /// Enumeration that defines the entry's copy and paste policy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CopyAndPasteMode
{
/// <summary>
- /// Copy and paste text with a markup tag.
+ /// Copy and paste text with markup tag
/// </summary>
Markup,
/// <summary>
- /// Copy and paste text without an item (image) tag.
+ /// Copy and paste text without item(image) tag
/// </summary>
NoImage,
/// <summary>
- /// Copy and paste text without a markup tag.
+ /// Copy and paste text without markup tag
/// </summary>
PlainText
}
/// <summary>
- /// Enumeration for the text format types.
+ /// Enumeration that defines the text format types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TextFormat
{
/// <summary>
- /// Plain type.
+ /// Plain type
/// </summary>
Plain,
/// <summary>
- /// Markup type.
+ /// Markup type
/// </summary>
Markup
}
public enum InputHints
{
/// <summary>
- /// No active hints.
+ /// No active hints
/// </summary>
None,
/// <summary>
- /// Suggest word auto-completion.
+ /// suggest word auto completion
/// </summary>
AutoComplete,
/// <summary>
- /// The typed text should not be stored.
+ /// typed text should not be stored.
/// </summary>
SensitiveData,
}
/// <summary>
- /// Enumeration for defining the input panel (virtual keyboard) language modes.
+ /// Enumeration that defines the input panel (virtual keyboard) language modes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelLanguage
{
/// <summary>
- /// Automatic language mode.
+ /// Automatic language mode
/// </summary>
Automatic,
/// <summary>
- /// Alphabet language mode.
+ /// Alphabet language mode
/// </summary>
Alphabet,
}
/// <summary>
- /// The Entry is a convenience widget that shows a box in which the user can enter text.
+ /// The entry is a convenience widget that shows a box in which the user can enter text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Entry : Layout
}
/// <summary>
- /// Activated will be triggered when the entry is activated.
+ /// Activated will be triggered when the entry in Activated stated.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Activated;
public event EventHandler Clicked;
/// <summary>
- /// ChangedByUser will be triggered when the entry is changed by user.
+ /// ChangedByUser will be triggered when the entry changed by user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ChangedByUser;
/// <summary>
- /// CursorChanged will be triggered when the cursor in the entry is changed.
+ /// CursorChanged will be triggered when the Cursor in the entry is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler CursorChanged;
}
/// <summary>
- /// Sets or gets the text currently shown in the object entry.
+ /// Sets or gets text currently shown in the object entry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string Text
}
/// <summary>
- /// Sets or gets the style on top of the user style stack.
+ /// Sets or gets the style on the top of the user style stack.
/// </summary>
- /// <remarks>If there are styles in the user style stack, the properties in the top style of the user style stack will replace the properties in current theme. The input style is specified in the format, tag='property=value' (i.e., DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').</remarks>
+ /// <remarks>If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').</remarks>
/// <since_tizen> preview </since_tizen>
public string TextStyle
{
}
/// <summary>
- /// Sets or gets the autocapitalization type on the immodule.
+ /// Sets or Gets the autocapitalization type on the immodule.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AutoCapital AutoCapital
}
/// <summary>
- /// Sets or gets the entry object's 'autosave' status.
+ /// Sets or Gets the entry object's 'autosave' status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsAutoSave
}
/// <summary>
- /// Sets or gets the entry text paste/drop mode.
+ /// Sets or Gets entry text paste/drop mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CopyAndPasteMode CopyAndPasteMode
}
/// <summary>
- /// Sets or gets the value of the input hint.
+ /// Sets or Gets the value of input hint.
/// </summary>
/// <since_tizen> preview </since_tizen>
public InputHints InputHint
}
/// <summary>
- /// Sets or gets the line wrap type to use on multiline entries.
+ /// Sets or gets the line wrap type to use on multi-line entries.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WrapType LineWrapType
}
/// <summary>
- /// Sets or gets the attribute to show the input panel, in case of only an user's explicit Mouse Up event.
+ /// Sets or gets the attribute to show the input panel in case of only an user's explicit Mouse Up event.
/// It doesn't request to show the input panel even though it has focus.
- /// If true, the input panel will be shown only in case of the Mouse up event (Focus event will be ignored).
+ /// If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool InputPanelShowByOnDemand
/// <summary>
/// Sets the file (and implicitly loads it) for the text to display and then edit.
/// </summary>
- /// <param name="file">The path to the file to load and save.</param>
- /// <param name="textFormat">The file format.</param>
+ /// <param name="file">The path to the file to load and save</param>
+ /// <param name="textFormat">The file format</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, TextFormat textFormat)
{
/// <summary>
/// Converts a markup (HTML-like) string into UTF-8.
/// </summary>
- /// <param name="markup">The string (in markup) to be converted.</param>
- /// <returns>The converted string (in UTF-8).</returns>
+ /// <param name="markup">The string (in markup) to be converted</param>
+ /// <returns>The converted string (in UTF-8) </returns>
/// <since_tizen> preview </since_tizen>
public static string ConvertMarkupToUtf8(string markup)
{
/// <summary>
/// Moves the cursor one place to the left within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorPrev()
{
/// <summary>
/// Moves the cursor one line up within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorUp()
{
/// <summary>
/// Moves the cursor one line down within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorDown()
{
/// <summary>
/// Sets the input panel layout of the entry.
/// </summary>
- /// <param name="layout">The layout type.</param>
+ /// <param name="layout">The layout type</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelLayout(InputPanelLayout layout)
{
/// <summary>
/// Sets the attribute to show the input panel automatically.
/// </summary>
- /// <param name="enabled">If true, the input panel appears when the entry is clicked or has focus, otherwise false.</param>
+ /// <param name="enabled">If true the input panel appears when the entry is clicked or has focus, otherwise false</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelEnabled(bool enabled)
{
/// <summary>
/// Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel.
/// </summary>
- /// <param name="keyType">The type of "return" key on the input panel.</param>
+ /// <param name="keyType">The type of "return" key on the input panel</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType)
{
}
/// <summary>
- /// Forces calculation of the entry size and text layout.
+ /// Forces calculation of the entry size and text layouting.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ForceCalculation()
}
/// <summary>
- /// Begins a selection within the entry, as though the user was holding down the mouse button to make a selection.
+ /// Begins a selection within the entry as though the user were holding down the mouse button to make a selection.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void BeginCursorSelection()
/// <summary>
/// Appends the text of the entry.
/// </summary>
- /// <param name="text">The text to be displayed.</param>
+ /// <param name="text">The text to be displayed</param>
/// <since_tizen> preview </since_tizen>
public void AppendText(string text)
{
}
/// <summary>
- /// Sets or gets the value of the HorizontalScrollBarVisiblePolicy.
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means that the horizontal scrollbar is made visible if it is needed, or otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means that the vertical scrollbar is made visible if it is needed, or otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the vertical bounce behavior.
+ /// Sets or gets the vertical bounce behaviour.
/// When scrolling, the scroller may "bounce" when reaching an edge of the content object.
- /// This is a visual way to indicate that the end has reached.
- /// This is enabled by default for both the axis.
- /// This API will be set if it is enabled for the given axis with boolean parameters for each axis.
+ /// This is a visual way to indicate the end has been reached.
+ /// This is enabled by default for both axis.
+ /// This API will set if it is enabled for the given axis with the boolean parameters for each axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool VerticalBounce
}
/// <summary>
- /// Sets or gets the horizontal bounce behavior.
+ /// Sets or gets the horizontal bounce behaviour.
/// When scrolling, the scroller may "bounce" when reaching an edge of the content object.
- /// This is a visual way to indicate that the end has reached.
- /// This is enabled by default for both the axis.
- /// This API will be set if it is enabled for the given axis with boolean parameters for each axis.
+ /// This is a visual way to indicate the end has been reached.
+ /// This is enabled by default for both axis.
+ /// This API will set if it is enabled for the given axis with the boolean parameters for each axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool HorizontalBounce
/// <summary>
/// Inserts the given text into the entry at the current cursor position.
/// </summary>
- /// <param name="text">The text to be inserted.</param>
+ /// <param name="text"></param>
/// <since_tizen> preview </since_tizen>
public void InsertTextToCursor(string text)
{
}
/// <summary>
- /// Writes any changes made to the file that is set by a file.
+ /// Writes any changes made to the file that is set by File.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void SaveFile()
}
/// <summary>
- /// Show the input panel (virtual keyboard) based on the input panel property of the entry such as layout, autocapital types, and so on.
+ /// Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
/// </summary>
/// <remarks>
- /// Note that the input panel is shown or hidden automatically according to the focus state of the entry widget.
- /// This API can be used in the case of manual control by using the SetInputPanelEnabled(false).
+ /// Note that input panel is shown or hidden automatically according to the focus state of entry widget.
+ /// This API can be used in the case of manually controlling by using SetInputPanelEnabled(false).
/// </remarks>
/// <since_tizen> preview </since_tizen>
public void ShowInputPanel()
}
/// <summary>
- /// Appends a markup filter function for text inserted in the entry.
+ /// Append a markup filter function for text inserted in the entry.
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepends a markup filter function for text inserted in the entry.
+ /// Prepend a markup filter function for text inserted in the entry.
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes a markup filter.
+ /// Remove a markup filter
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// This disables the entry's selection.
+ /// This disabled the entry's selection.
/// </summary>
- /// <param name="disable">If true, the selection is disabled.</param>
+ /// <param name="disable">If true, the selection are disabled.</param>
/// <since_tizen> preview </since_tizen>
public void DisableSelection(bool disable)
{
}
/// <summary>
- /// Gets any selected text within the entry.
+ /// Get any selected text within the entry.
/// </summary>
- /// <returns>Selection's value.</returns>
+ /// <returns>Selection's value</returns>
/// <since_tizen> preview </since_tizen>
public string GetSelection()
{
/// <summary>
/// This selects a region of text within the entry.
/// </summary>
- /// <param name="start">The start position.</param>
+ /// <param name="start">The starting position.</param>
/// <param name="end">The end position.</param>
/// <since_tizen> preview </since_tizen>
public void SetSelectionRegion(int start, int end)
}
/// <summary>
- /// Sets the visibility of the left-side widget of the entry.
+ /// Sets the visibility of the left-side widget of the entry
/// </summary>
- /// <param name="isDisplay">true if the object should be displayed, otherwise false.</param>
+ /// <param name="isDisplay">true if the object should be displayed, false if not.</param>
/// <since_tizen> preview </since_tizen>
public void SetIconVisible(bool isDisplay)
{
}
/// <summary>
- /// Sets whether the return key on the input panel is disabled automatically, when the entry has no text.
+ /// Set whether the return key on the input panel is disabled automatically when entry has no text.
/// </summary>
/// <param name="enable">If enabled is true, the return key is automatically disabled when the entry has no text.</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though.
- /// Most of these functions deal with low-level Evas actions like:
- /// create/destroy raw canvases, not bound to any displaying engine.
- /// tell a canvas, I got focused (in a windowing context, for example).
- /// tell a canvas, a region should not be calculated anymore in rendering.
- /// tell a canvas, to render its contents immediately.
- /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you will be looking at this section only if you're building low-level stuff.
- /// The groups within, present you functions that deal with the canvas directly too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas.
+ /// Low level Evas canvas functions. Sub groups will present more high level ones, though.
+ /// Most of these functions deal with low level Evas actions, like:
+ /// create/destroy raw canvases, not bound to any displaying engine
+ /// tell a canvas i got focused(in a windowing context, for example)
+ /// tell a canvas a region should not be calculated anymore in rendering
+ /// tell a canvas to render its contents, immediately
+ /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff.
+ /// The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasCanvas
/// <summary>
/// Gets or sets the image cache.
- /// This function returns the image cache size of the canvas in bytes.
+ /// This function returns the image cache size of canvas in bytes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ImageCacheSize
}
/// <summary>
- /// Flushes the image cache of the canvas.
+ /// Flush the image cache of the canvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void FlushImageCache()
}
/// <summary>
- /// Adds a damage rectangle.
+ /// Add a damage rectangle.
/// </summary>
/// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
/// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
}
/// <summary>
- /// Adds an "obscured region" to an Evas canvas.
+ /// Add an "obscured region" to an Evas canvas.
/// </summary>
/// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
/// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
}
/// <summary>
- /// Removes all the "obscured regions" from an Evas canvas.
+ /// Remove all "obscured regions" from an Evas canvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearObscuredRectangle()
}
/// <summary>
- /// Adds or registers an event to a given canvas event.
+ /// Adds or registers a event to a given canvas event.
/// </summary>
- /// <param name="type">The type of event that triggers.</param>
- /// <param name="action">The action to be called when the event is triggered.</param>
+ /// <param name="type">The type of event that triggers</param>
+ /// <param name="action">The action to be called when the event is triggered</param>
/// <since_tizen> preview </since_tizen>
public void AddEventAction(EvasObjectCallbackType type, Action action)
{
}
/// <summary>
- /// Deletes an event to a given canvas event.
+ /// Deletes a event to a given canvas event.
/// </summary>
- /// <param name="type">The type of event that triggers.</param>
+ /// <param name="type">The type of event that triggers</param>
/// <param name="action">The action to be called when the event is triggered</param>
/// <since_tizen> preview </since_tizen>
public void DeleteEventAction(EvasObjectCallbackType type, Action action)
/// Creates an Evas canvas handle.
/// </summary>
/// <param name="evasObject">EvasObject</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <returns>Handle IntPtr</returns>
IntPtr CreateHandle(IntPtr evasObject)
{
return Interop.Evas.evas_object_evas_get(evasObject);
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
public override bool Equals(object obj)
{
namespace ElmSharp
{
/// <summary>
- /// This group provides the functions for image objects.
+ /// This group provides functions for image objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasImage : EvasObject
IntPtr _handle = IntPtr.Zero;
/// <summary>
- /// Creates and initializes a new instance of the EvasImage class.
+ /// Creates and initializes a new instance of EvasImage class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by EvasImage as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by EvasImage as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public EvasImage(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets the source file from where an image object must fetch the real image data.
+ /// Sets or gets the source file from where an image object must fetch the real image data
/// </summary>
/// <since_tizen> preview </since_tizen>
public string File
}
/// <summary>
- /// Sets or gets whether an object is clipped by the source object's clipper.
+ /// Sets or gets whether an object is clipped by source object's clipper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsSourceClipped
}
/// <summary>
- /// Sets or gets the scaling factor (multiplier) for the borders of the image object.
+ /// Sets or gets the scaling factor (multiplier) for the borders of an image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BorderScale
}
/// <summary>
- /// Sets or gets whether the alpha channel data is being used on the given image object.
+ /// Sets or gets whether alpha channel data is being used on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsOpaque
}
/// <summary>
- /// Sets or gets whether to use a high-quality image scaling algorithm on the given image object.
+ /// Sets or gets whether to use high-quality image scaling algorithm on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsSmoothScaled
/// <summary>
/// Sets how to fill an image object's drawing rectangle given the (real) image bound to it.
/// </summary>
- /// <param name="geometry">The rectangle of the given image object that the image will be drawn to.</param>
+ /// <param name="geometry"></param>
/// <since_tizen> preview </since_tizen>
public void SetFill(Rect geometry)
{
/// <summary>
/// Sets the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones).
/// </summary>
- /// <param name="file">The image file path.</param>
- /// <param name="key">The image key in file (if its an Eet one), otherwise set null.</param>
+ /// <param name="file">The image file path</param>
+ /// <param name="key">The image key in file (if its an Eet one), otherwise set null</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, string key)
{
}
/// <summary>
- /// Sets the data for an image from the memory to be loaded.
+ /// Sets the data for an image from memory to be loaded.
/// </summary>
/// <param name="stream">memory stream</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets the source object on an image object to be used as a proxy.
+ /// Sets the source object on an image object to used as a proxy.
/// </summary>
- /// <param name="source">The proxy (image) object.</param>
- /// <returns>true if the source object is set successfully, otherwise false on error.</returns>
+ /// <param name="source">The proxy (image) object</param>
+ /// <returns>true if the source object is set successfully, ortherwise false on error</returns>
/// <since_tizen> preview </since_tizen>
public bool SetSource(EvasObject source)
{
}
/// <summary>
- /// Set the native surface of a given image of the canvas.
+ /// Set the native surface of a given image of the canvas
/// </summary>
/// <param name="surface">The surface.</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever.
/// </summary>
- /// <param name="left">The border's left width.</param>
- /// <param name="right">The border's right width.</param>
- /// <param name="top">The border's top width.</param>
- /// <param name="bottom">The border's bottom width.</param>
+ /// <param name="left">The border's left width</param>
+ /// <param name="right">The border's right width</param>
+ /// <param name="top">The border's top width</param>
+ /// <param name="bottom">The border's bottom width</param>
/// <since_tizen> preview </since_tizen>
public void SetBorder(int left, int right, int top, int bottom)
{
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created.</returns>
+ /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The EvasKeyEventArgs is a EvasKey EventArgs.
+ /// The EvasKeyEventArgs is an EvasKey EventArgs
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasKeyEventArgs : EventArgs
IntPtr _nativeEventInfo;
/// <summary>
- /// BackButton name in platform.
+ /// BackButton name in Platform
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformBackButtonName = "XF86Back";
/// <summary>
- /// MenuButton name in platform.
+ /// MenuButton name in Platform
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformMenuButtonName = "XF86Menu";
/// <summary>
- /// HomeButton name in platform.
+ /// HomeButton name in Platform
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformHomeButtonName = "XF86Home";
/// <summary>
- /// Gets the name of the key.
+ /// Gets the name of Key
/// </summary>
/// <since_tizen> preview </since_tizen>
public string KeyName { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the EvasKeyEventArgs class.
/// </summary>
- /// <param name="data">The data information.</param>
- /// <param name="obj">The object.</param>
- /// <param name="info">The information.</param>
- /// <returns>EvasKey eventArgs.</returns>
+ /// <param name="data">data info</param>
+ /// <param name="obj"> object </param>
+ /// <param name="info">information </param>
+ /// <returns>EvasKey eventArgs</returns>
/// <since_tizen> preview </since_tizen>
static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info)
{
struct EvasEventKeyDown
{
/// <summary>
- /// Name string of the key pressed.
+ /// Name string of the key pressed
/// </summary>
public string keyname;
/// <summary>
- /// Data to be passed to the event.
+ /// Data to be passed to the event
/// </summary>
public IntPtr data;
/// <summary>
- /// Modifier keys pressed during the event.
+ /// Modifier keys pressed during the event
/// </summary>
public IntPtr modifiers;
/// <summary>
- /// Locks information.
+ /// Locks info
/// </summary>
public IntPtr locks;
/// <summary>
- /// Logical key: (example, shift+1 == exclamation).
+ /// Logical key: (example, shift+1 == exclamation)
/// </summary>
public string key;
/// <summary>
- /// UTF-8 string, if this keystroke has produced a visible string to be added.
+ /// UTF8 string if this keystroke has produced a visible string to be ADDED
/// </summary>
public string str;
/// <summary>
- /// UTF-8 string, if this keystroke has modified a string in the middle of being composed - this string replaces the previous one.
+ /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
/// </summary>
public string compose;
public uint timestamp;
/// <summary>
- /// Event_flags.
+ /// Event_flags
/// </summary>
public EvasEventFlag event_flags;
public IntPtr dev;
/// <summary>
- /// Keycode.
+ /// Keycode
/// </summary>
public uint keycode;
};
}
/// <summary>
- /// Flags for the events.
+ /// Flags for Events
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
public enum EvasEventFlag
{
/// <summary>
- /// No fancy flags set.
+ /// 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.
+ ///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,
}
}
/// <summary>
- /// Gets or sets the flag of the object to move synchronization for map rendering.
+ /// Gets or sets the flag of the object move synchronization for map rendering.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsMoveSync
}
/// <summary>
- /// Populates the source and destination map points to exactly match the object.
+ /// Populates source and destination map points to exactly match the object.
/// </summary>
- /// <param name="obj">The object to use unmapped geometry to populate the map coordinates.</param>
+ /// <param name="obj">The object to use unmapped geometry to populate map coordinates</param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(EvasObject obj)
{
}
/// <summary>
- /// Populates the source and destination map points to exactly match the object.
+ /// Populates source and destination map points to exactly match the object.
/// </summary>
- /// <param name="obj">The object to use unmapped geometry to populate the map coordinates.</param>
+ /// <param name="obj">The object to use unmapped geometry to populate map coordinates</param>
/// <param name="z">
- /// The point Z-coordinate hint (pre-perspective transform). This value is used for all the four points.
+ /// The point Z coordinate hint (pre-perspective transform)This value is used for all four points.
/// </param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(EvasObject obj, int z)
/// <summary>
/// Populates the source and destination map points to match the given geometry.
/// </summary>
- /// <param name="geometry">The geometry value contains X-coordinate, Y-coordinate, the width and height to use, to calculate the second and third points.</param>
- /// <param name="z">The Z-coordinate hint (pre-perspective transform) This value is used for all the four points.</param>
+ /// <param name="geometry">The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points</param>
+ /// <param name="z">The Z coordinate hint (pre-perspective transform) This value is used for all four points.</param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(Rect geometry, int z)
{
}
/// <summary>
- /// Rotates the map.
+ /// Rotate the map
/// </summary>
- /// <param name="degrees">The abount of degrees from 0.0 to 360.0 to rotate.</param>
- /// <param name="cx">The rotation's center horizontal position.</param>
- /// <param name="cy">The rotation's center vertical position.</param>
+ /// <param name="degrees">The abount of degrees from 0.0 to 360.0 to rotate</param>
+ /// <param name="cx">rotation's center horizontal position.</param>
+ /// <param name="cy">rotation's center vertical position.</param>
/// <since_tizen> preview </since_tizen>
public void Rotate(double degrees, int cx, int cy)
{
/// <summary>
/// Rotates the map around 3 axes in 3D.
/// </summary>
- /// <param name="dx">The amount of degrees from 0.0 to 360.0 to rotate around the X-axis.</param>
- /// <param name="dy">The amount of degrees from 0.0 to 360.0 to rotate around the Y-axis.</param>
- /// <param name="dz">The amount of degrees from 0.0 to 360.0 to rotate around the Z-axis.</param>
- /// <param name="cx">The rotation's center horizontal position.</param>
- /// <param name="cy">The rotation's center vertical position.</param>
- /// <param name="cz">The rotation's center depth position.</param>
+ /// <param name="dx">The amount of degrees from 0.0 to 360.0 to rotate around X axis</param>
+ /// <param name="dy">The amount of degrees from 0.0 to 360.0 to rotate around Y axis</param>
+ /// <param name="dz">The amount of degrees from 0.0 to 360.0 to rotate around Z axis</param>
+ /// <param name="cx">The rotation's center horizontal position</param>
+ /// <param name="cy">The rotation's center vertical position</param>
+ /// <param name="cz">The rotation's center depth position</param>
/// <since_tizen> preview </since_tizen>
public void Rotate3D(double dx, double dy, double dz, int cx, int cy, int cz)
{
/// <summary>
/// Changes the map point's coordinate.
/// </summary>
- /// <param name="idx">The index of point to change, this must be smaller than the map size.</param>
- /// <param name="point">The 3D point coordinate.</param>
+ /// <param name="idx">The index of point to change ,this must be smaller than map size.</param>
+ /// <param name="point">3D Point coordinate</param>
/// <since_tizen> preview </since_tizen>
public void SetPointCoordinate(int idx, Point3D point)
{
/// <summary>
/// Gets the map point's coordinate.
/// </summary>
- /// <param name="idx">The index of point to change, this must be smaller than the map size.</param>
- /// <returns>The coordinates of a given point in the map.</returns>
+ /// <param name="idx">The index of point to change ,this must be smaller than map size.</param>
+ /// <returns>The coordinates of the given point in the map.</returns>
/// <since_tizen> preview </since_tizen>
public Point3D GetPointCoordinate(int idx)
{
/// <summary>
/// Changes the map to apply the given zooming.
/// </summary>
- /// <param name="x">The horizontal zoom to use.</param>
- /// <param name="y">The vertical zoom to use.</param>
- /// <param name="cx">The zooming center horizontal position.</param>
- /// <param name="cy">The zooming center vertical position.</param>
+ /// <param name="x">The horizontal zoom to use</param>
+ /// <param name="y">The vertical zoom to use</param>
+ /// <param name="cx">The zooming center horizontal position</param>
+ /// <param name="cy">The zooming center vertical position</param>
/// <since_tizen> preview </since_tizen>
public void Zoom(double x, double y, int cx, int cy)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the Tooltip orientation.
+ /// Enumeration for tooltip orientation.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TooltipOrientation
{
/// <summary>
- /// Default value. Tooltip moves with a mouse pointer.
+ /// Default value, Tooltip moves with mouse pointer.
/// </summary>
None,
/// <summary>
- /// Tooltip should appear to the top left of the parent.
+ /// Tooltip should appear at the top left of parent.
/// </summary>
TopLeft,
/// <summary>
- /// Tooltip should appear to the left of the parent.
+ /// Tooltip should appear at the left of parent.
/// </summary>
Top,
/// <summary>
- /// Tooltip should appear to the top right of the parent.
+ /// Tooltip should appear at the top right of parent.
/// </summary>
TopRight,
/// <summary>
- /// Tooltip should appear to the left of the parent.
+ /// Tooltip should appear at the left of parent.
/// </summary>
Left,
/// <summary>
- /// Tooltip should appear to the center of the parent.
+ /// Tooltip should appear at the center of parent.
/// </summary>
Center,
/// <summary>
- /// Tooltip should appear to the right of the parent.
+ /// Tooltip should appear at the right of parent.
/// </summary>
Right,
/// <summary>
- /// Tooltip should appear to the bottom left of the parent.
+ /// Tooltip should appear at the bottom left of parent.
/// </summary>
BottomLeft,
/// <summary>
- /// Tooltip should appear to the bottom of the parent.
+ /// Tooltip should appear at the bottom of parent.
/// </summary>
Bottom,
/// <summary>
- /// Tooltip should appear to the bottom right of the parent.
+ /// Tooltip should appear at the bottom right of parent.
/// </summary>
BottomRight,
}
/// <summary>
- /// Enumeration for the aspect control.
+ /// Enumeration for aspect control.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AspectControl
{
/// <summary>
- /// Preference on the scaling unset.
+ /// Preference on scaling unset.
/// </summary>
None = 0,
/// <summary>
- /// Same effect as the unset preference on the scaling.
+ /// Same effect as unset preference on scaling.
/// </summary>
Neither = 1,
/// <summary>
- /// Use all horizontal container space to place an object using the given aspect.
+ /// 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.
+ /// Use all vertical container space to place an object, using the given aspect.
/// </summary>
Vertical = 3,
}
/// <summary>
- /// The EvasObject is a base class for other widget classes.
+ /// The EcasObject is a base class for other widget class
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class EvasObject
readonly HashSet<IInvalidatable> _eventStore = new HashSet<IInvalidatable>();
/// <summary>
- /// Creates and initializes a new instance of the EvasObject class with the parent EvasObject class parameter.
+ /// Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter.
/// </summary>
- /// <param name="parent">Parent EvasObject class.</param>
+ /// <param name="parent">Parent EvasObject class </param>
/// <since_tizen> preview </since_tizen>
protected EvasObject(EvasObject parent) : this()
{
//}
/// <summary>
- /// Deleted will be triggered when the widght is deleted.
+ /// Deleted will be triggered when widght is deleted
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// KeyUp will be triggered when the key is loose.
+ /// KeyUp will be triggered when key is loose
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<EvasKeyEventArgs> KeyUp
}
/// <summary>
- /// KeyDown will be triggered when the key is pressed down.
+ /// KeyDown will be triggered when key is preesd down
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<EvasKeyEventArgs> KeyDown
}
/// <summary>
- /// BackButtonPressed will be triggered when the Back button is pressed.
+ /// BackButtonPressed will be triggered when Back button is pressed
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler BackButtonPressed
}
/// <summary>
- /// MoreButtonPressed will be triggered when the More button is pressed.
+ /// MoreButtonPressed will be triggered when More button is pressed
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler MoreButtonPressed
}
/// <summary>
- /// Moved will be triggered when the widght is moved.
+ /// Moved will be triggered when widght is moved
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Moved
}
/// <summary>
- /// Resized Event Handler of the current widget's size.
+ /// Current widget's size Resized Event Handler
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Resized
}
/// <summary>
- /// RenderPost Event Handler of the current widget.
+ /// Current widget RenderPost Event Handler
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler RenderPost
}
/// <summary>
- /// Called when a widget's tooltip is activated and needs content.
+ /// Called back when a widget's tooltip is activated and needs content.
/// </summary>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public delegate EvasObject GetTooltipContentDelegate();
/// <summary>
- /// Gets a widget's status of realized or not.
+ /// Get widget's status of Realized or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsRealized { get { return Handle != IntPtr.Zero; } }
/// <summary>
- /// Gets EvasCanvas.
+ /// Gets EvasCanvas
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasCanvas EvasCanvas
}
/// <summary>
- /// Sets or gets the width hints for an object's minimum size.
+ /// Sets or gets the Width hints for an object's minimum size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumWidth
}
/// <summary>
- /// Sets or gets the height hints for an object's minimum size.
+ /// Sets or gets the Height hints for an object's minimum size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumHeight
}
/// <summary>
- /// Sets or gets the current object's transformation map.
+ /// Sets or gets current object transformation map.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasMap EvasMap
}
/// <summary>
- /// Sets or gets the style for this object tooltip.
+ /// Sets or Gets style for this object tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string TooltipStyle
}
/// <summary>
- /// Sets or gets the orientation of tooltip.
+ /// Sets or gets the orientation of Tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public TooltipOrientation TooltipOrientation
}
/// <summary>
- /// Gets the movement freeze by 1.
+ /// Gets the movement freeze by 1
/// This gets the movement freeze count by one.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Clips one object to another.
/// </summary>
- /// <param name="clip">The object to clip object by.</param>
+ /// <param name="clip">The object to clip object by</param>
/// <since_tizen> preview </since_tizen>
public void SetClip(EvasObject clip)
{
/// <summary>
/// Sets the hints for an object's alignment.
/// </summary>
- /// <param name="x">The horizontal alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.</param>
- /// <param name="y">The vertical alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.</param>
+ /// <param name="x">The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param>
+ /// <param name="y">The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param>
/// <since_tizen> preview </since_tizen>
public void SetAlignment(double x, double y)
{
/// <summary>
/// Sets the hints for an object's weight.
/// </summary>
- /// <param name="x">The non-negative double value to be used as horizontal weight hint.</param>
- /// <param name="y">The non-negative double value to be used as vertical weight hint.</param>
+ /// <param name="x">The non-negative double value to use as horizontal weight hint</param>
+ /// <param name="y">The non-negative double value to use as vertical weight hint</param>
/// <since_tizen> preview </since_tizen>
public void SetWeight(double x, double y)
{
/// <summary>
/// Sets the text for an object's tooltip.
/// </summary>
- /// <param name="text">The text value to display inside the tooltip.</param>
+ /// <param name="text">The text value to display inside the tooltip</param>
/// <since_tizen> preview </since_tizen>
public void SetTooltipText(string text)
{
}
/// <summary>
- /// Force hide the tooltip of the object.
+ /// Force hide tooltip of object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void HideTooltip()
}
/// <summary>
- /// Force show the tooltip of the object.
+ /// Force show tooltip of object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ShowTooltip()
/// <summary>
/// Changes the size of the current object.
/// </summary>
- /// <param name="w">The new width.</param>
- /// <param name="h">The new height.</param>
+ /// <param name="w">The new width</param>
+ /// <param name="h">The new height</param>
/// <since_tizen> preview </since_tizen>
public void Resize(int w, int h)
{
/// <summary>
/// Moves the current object to the given location.
/// </summary>
- /// <param name="x">The X position to move the object.</param>
- /// <param name="y">The Y position to move the object.</param>
+ /// <param name="x">The X position to move the object to.</param>
+ /// <param name="y">The Y position to move the object to.</param>
/// <since_tizen> preview </since_tizen>
public void Move(int x, int y)
{
}
/// <summary>
- /// Lowers the object to the bottom of its layer.
+ /// Lowers obj to the bottom of its layer.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Lower()
}
/// <summary>
- /// Define the IntPtr operator.
+ /// Define IntPtr operator
/// </summary>
- /// <param name="obj">Parent object.</param>
+ /// <param name="obj">Parent object</param>
/// <since_tizen> preview </since_tizen>
public static implicit operator IntPtr(EvasObject obj)
{
}
/// <summary>
- /// Requests the keyname key events to be directed to the current object.
+ /// Requests keyname key events be directed to current obj.
/// </summary>
- /// <param name="keyname">The key to request events for.</param>
- /// <param name="exclusive">Set TRUE to request that the obj is the only object receiving the keyname events, otherwise set to FALSE.</param>
- /// <returns>If the call succeeds then true, otherwise false.</returns>
+ /// <param name="keyname">The key to request events for</param>
+ /// <param name="exclusive">Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE</param>
+ /// <returns>If the call succeeded is true,otherwise is false</returns>
/// <since_tizen> preview </since_tizen>
public bool KeyGrab(string keyname, bool exclusive)
{
}
/// <summary>
- /// Removes the grab on the keyname key events.
+ /// Removes the grab on keyname key events.
/// </summary>
- /// <param name="keyname">The key the grab is set for.</param>
+ /// <param name="keyname">The key the grab is set for</param>
/// <since_tizen> preview </since_tizen>
public void KeyUngrab(string keyname)
{
}
/// <summary>
- /// Marks the smart object as changed.
+ /// Mark smart object as changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MarkChanged()
}
/// <summary>
- /// Calls the calculate smart function immediately.
+ /// Call the calculate smart function immediately.
/// This will force immediate calculations needed for renderization of this object.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the hints for an object's aspect ratio.
/// </summary>
- /// <param name="aspect">The policy or type of aspect ratio to apply to an object.</param>
- /// <param name="w">The integer to be used as aspect width ratio term.</param>
- /// <param name="h">The integer to be used as aspect height ratio term.</param>
+ /// <param name="aspect">The policy or type of aspect ratio to apply to object</param>
+ /// <param name="w">The integer to use as aspect width ratio term</param>
+ /// <param name="h">The integer to use as aspect height ratio term</param>
/// <since_tizen> preview </since_tizen>
public void SetSizeHintAspect(AspectControl aspect, int w, int h)
{
/// <summary>
/// Gets the hints for an object's aspect ratio.
/// </summary>
- /// <param name="aspect">The policy or type of aspect ratio to apply to an object.</param>
- /// <param name="w">The integer to be used as aspect width ratio term.</param>
- /// <param name="h">The integer to be used as aspect height ratio term.</param>
+ /// <param name="aspect">The policy or type of aspect ratio to apply to object</param>
+ /// <param name="w">The integer to use as aspect width ratio term</param>
+ /// <param name="h">The integer to use as aspect height ratio term</param>
/// <since_tizen> preview </since_tizen>
public void GetSizeHintAspect(out AspectControl aspect, out int w, out int h)
{
}
/// <summary>
- /// Stacks immediately below anchor.
+ /// Stack immediately below anchor.
/// </summary>
/// <param name="anchor">The object below which to stack.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Stacks immediately above anchor.
+ /// Stack immediately above anchor.
/// </summary>
/// <param name="anchor">The object above which to stack.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Raises to the top of its layer.
+ /// Raise to the top of its layer.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void RaiseTop()
}
/// <summary>
- /// Gets the geometry of a line number.
+ /// Get the geometry of a line number.
/// </summary>
- /// <param name="lineNumber">The line number.</param>
- /// <param name="x">x coordinate of the line.</param>
- /// <param name="y">y coordinate of the line.</param>
- /// <param name="w">w coordinate of the line.</param>
- /// <param name="h">h coordinate of the line.</param>
+ /// <param name="lineNumber">the line number.</param>
+ /// <param name="x">x coord of the line.</param>
+ /// <param name="y">y coord of the line.</param>
+ /// <param name="w">w coord of the line.</param>
+ /// <param name="h">h coord of the line.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public bool GetTextBlockGeometryByLineNumber(int lineNumber, out int x, out int y, out int w, out int h)
}
/// <summary>
- /// The callback of the Invalidate Event.
+ /// The callback of Invalidate Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInvalidate()
}
/// <summary>
- /// The callback of the Instantiated Event.
+ /// The callback of Instantiated Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInstantiated()
}
/// <summary>
- /// The callback of the Realized Event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnRealized()
}
/// <summary>
- /// The callback of the Unrealize Event.
+ /// The callback of Unrealize Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnUnrealize()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected abstract IntPtr CreateHandle(EvasObject parent);
/// <summary>
/// For this object bind Parent object.Init handle and all kinds of EvasObjectEvent.
/// </summary>
- /// <param name="parent">Parent object.</param>
+ /// <param name="parent">Parent object</param>
/// <since_tizen> preview </since_tizen>
public void Realize(EvasObject parent)
{
}
/// <summary>
- /// Removes the current object relationship with others.
+ /// Removes current object relationship with others.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Unrealize()
namespace ElmSharp
{
/// <summary>
- /// IInvalidatable is an interface, which can be overrided by its children class.
- /// Inherits IDisposable.
+ /// IInvalidatable is a interface which can be overrided by its children class.
+ /// Inherits IDisposable
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IInvalidatable : IDisposable
{
/// <summary>
- /// Makes the current instance invalidate.
+ /// Make current instance invalidate
/// </summary>
/// <since_tizen> preview </since_tizen>
void MakeInvalidate();
}
/// <summary>
- /// Enumeration for EvasObjectCallbackType.
+ /// Enumeration for EvasObjectCallbackType
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum EvasObjectCallbackType
MouseIn,
/// <summary>
- /// Mouse Out Event CallbackType.
+ /// Mouse Out Event CallbackType
/// </summary>
MouseOut,
/// <summary>
- /// Mouse Button Down Event CallbackType.
+ /// Mouse Button Down Event CallbackType
/// </summary>
MouseDown,
/// <summary>
- /// Mouse Button Up Event CallbackType.
+ /// Mouse Button Up Event CallbackType
/// </summary>
MouseUp,
/// <summary>
- /// Mouse Move Event CallbackType.
+ /// Mouse Move Event CallbackType
/// </summary>
MouseMove,
/// <summary>
- /// Mouse Wheel Event CallbackType.
+ /// Mouse Wheel Event CallbackType
/// </summary>
MouseWheel,
/// <summary>
- /// Multi-touch Down Event CallbackType.
+ /// Multi-touch Down Event CallbackType
/// </summary>
MultiDown,
/// <summary>
- /// Multi-touch Up Event CallbackType.
+ /// Multi-touch Up Event CallbackType
/// </summary>
MultiUp,
/// <summary>
- /// Multi-touch Move Event CallbackType.
+ /// Multi-touch Move Event CallbackType
/// </summary>
MultiMove,
/// <summary>
- /// Object Being Freed (Called after Del).
+ /// Object Being Freed (Called after Del)
/// </summary>
Free,
/// <summary>
- /// Key Press Event CallbackType.
+ /// Key Press Event CallbackType
/// </summary>
KeyDown,
/// <summary>
- /// Key Release Event CallbackType.
+ /// Key Release Event CallbackType
/// </summary>
KeyUp,
/// <summary>
- /// Focus In Event CallbackType.
+ /// Focus In Event CallbackType
/// </summary>
FocusIn,
/// <summary>
- /// Focus Out Event CallbackType.
+ /// Focus Out Event CallbackType
/// </summary>
FocusOut,
/// <summary>
- /// Show Event CallbackType.
+ /// Show Event CallbackType
/// </summary>
Show,
/// <summary>
- /// Hide Event CallbackType.
+ /// Hide Event CallbackType
/// </summary>
Hide,
/// <summary>
- /// Move Event CallbackType.
+ /// Move Event CallbackType
/// </summary>
Move,
/// <summary>
- /// Resize Event CallbackType.
+ /// Resize Event CallbackType
/// </summary>
Resize,
/// <summary>
- /// Restack Event CallbackType.
+ /// Restack Event CallbackType
/// </summary>
Restack,
/// <summary>
- /// Object being deleted (called before Free).
+ /// Object Being Deleted (called before Free)
/// </summary>
Del,
/// <summary>
- /// Hold Event CallbackType, Informational purpose event to indicate something.
+ /// Hold Event CallbackType, Informational purpose event to indicate something
/// </summary>
Hold,
/// <summary>
- /// Size hints changed the CallbackType event.
+ /// Size hints changed Event CallbackType
/// </summary>
ChangedSizeHints,
/// <summary>
- /// Image has been pre-loaded.
+ /// Image has been preloaded
/// </summary>
ImagePreloaded,
/// <summary>
- /// Canvas got focus as a whole.
+ /// Canvas got focus as a whole
/// </summary>
CanvasFocusIn,
/// <summary>
- /// Canvas lost focus as a whole.
+ /// Canvas lost focus as a whole
/// </summary>
CanvasFocusOut,
/// <summary>
- /// Called just before rendering is updated on the canvas target.
+ /// Called just before rendering is updated on the canvas target
/// </summary>
RenderFlushPre,
/// <summary>
- /// Called just after rendering is updated on the canvas target.
+ /// Called just after rendering is updated on the canvas target
/// </summary>
RenderFlushPost,
/// <summary>
- /// Canvas object got focus.
+ /// Canvas object got focus
/// </summary>
CanvasObjectFocusIn,
/// <summary>
- /// Canvas object lost focus.
+ /// Canvas object lost focus
/// </summary>
CanvasObjectFocusOut,
/// <summary>
- /// Image data has been unloaded (by some mechanism in Evas that throw out the original image data).
+ /// Image data has been unloaded (by some mechanism in Evas that throw out original image data)
/// </summary>
ImageUnloaded,
/// <summary>
- /// Called just before rendering starts on the canvas target.
+ /// Called just before rendering starts on the canvas target
/// </summary>
RenderPre,
/// <summary>
- /// Called just after rendering stops on the canvas target.
+ /// Called just after rendering stops on the canvas target
/// </summary>
RenderPost,
/// <summary>
- /// Image size is changed.
+ /// Image size is changed
/// </summary>
ImageResize,
/// <summary>
- /// Devices added, removed, or changed on canvas.
+ /// Devices added, removed or changed on canvas
/// </summary>
DeviceChanged,
/// <summary>
- /// Axis is changed.
+ /// Axis is changed
/// </summary>
AxisUpdate,
/// <summary>
- /// Canvas Viewport size is changed.
+ /// Canvas Viewport size is changed
/// </summary>
CanvasViewportResize
}
/// <summary>
- /// Event class for EvasObject.
+ /// Event class for EvasObject
/// </summary>
- /// <typeparam name="TEventArgs">Kinds of EventArgs.</typeparam>
+ /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
/// <since_tizen> preview </since_tizen>
public class EvasObjectEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs
{
/// <summary>
- /// SmartEventInfoParser delegate of the EvasObjectEvent class.
+ /// SmartEventInfoParser delegate of EvasObjectEvent class
/// </summary>
/// <param name="data">data</param>
/// <param name="obj">obj</param>
/// <param name="info">info</param>
- /// <returns>Delegate handle.</returns>
+ /// <returns> delegate handle</returns>
/// <since_tizen> preview </since_tizen>
public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info);
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belongs to.</param>
+ /// <param name="sender">EvasObject class belong to</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <param name="parser">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belongs to.</param>
- /// <param name="handle">EvasObject handle.</param>
+ /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="handle">EvasObject handle</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <param name="parser">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belongs to.</param>
+ /// <param name="sender">EvasObject class belong with</param>
/// <param name="type">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, type, null)
}
/// <summary>
- /// Destroys the EvasObjectEvent object.
+ /// Destroy the EvasObjectEvent object.
/// </summary>
~EvasObjectEvent()
{
}
/// <summary>
- /// On Event Handler of the EvasObjectEvent.
+ /// On Event Handler of EvasObjectEvent
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed
+ /// true if managed resources should be disposed
/// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Makes the current instance invalidate.
+ /// Make current instance invalidate
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Event class for EvasObject.
+ /// Event class for EvasObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasObjectEvent : IInvalidatable
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belongs to.</param>
+ /// <param name="sender">EvasObject class belong to</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <since_tizen> preview </since_tizen>
public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, sender.Handle, type)
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belongs to.</param>
- /// <param name="handle">EvasObject handle.</param>
+ /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="handle">EvasObject handle</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <since_tizen> preview </since_tizen>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
}
/// <summary>
- /// Destroys the EvasObjectEvent object.
+ /// Destroy the EvasObjectEvent object.
/// </summary>
~EvasObjectEvent()
{
}
/// <summary>
- /// On Event Handler of EvasObjectEvent.
+ /// On Event Handler of EvasObjectEvent
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler On
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
/// true if managed resources should be disposed
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Makes the current instance invalidate.
+ /// Make current instance invalidate
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
namespace ElmSharp
{
/// <summary>
- /// The FlipSelector is a widget to show a set of text items, one at a time, with the same sheet switching style as the clock widget when one changes the current displaying sheet.
+ /// A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FlipSelector : Layout
/// <summary>
/// Creates and initializes a new instance of the FlipSelector.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
+ /// <param name="parent">Parent EvasObject </param>
/// <since_tizen> preview </since_tizen>
public FlipSelector(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Selected will be triggered when selected.
+ /// Selected will be triggered when be Selected
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
/// <summary>
- /// Overflowed will be triggered when overflowed.
+ /// Overflowed will be triggered when Overflowed
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Overflowed;
/// <summary>
- /// Underflowed will be triggered when underflowed.
+ /// Underflowed will be triggered when be Underflowed
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Underflowed;
/// <summary>
- /// Sets or gets the interval on time updates for a user mouse button to hold on the flip selector widget.
+ /// Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
/// <summary>
- /// Gets the currently selected item in the flip selector widget.
+ /// Gets the currently selected item in a flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem SelectedItem
}
/// <summary>
- /// Appends the (text) item to the flip selector widget.
+ /// Appends a (text) item to a flip selector widget.
/// </summary>
/// <param name="text">text value</param>
/// <returns>
- /// A handle to the item added, or null on errors.
+ /// A handle to the item added or NULL, on errors
/// </returns>
/// <remarks>
- /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when the same item is selected.
+ /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem Append(string text)
}
/// <summary>
- /// Prepends the (text) item to a flip selector widget.
+ /// Prepend a (text) item to a flip selector widget.
/// </summary>
/// <param name="text">Prepend text</param>
- /// <returns>A handle to the item added, or null on errors.</returns>
+ /// <returns>A handle to the item added or NULL, on errors</returns>
/// <remarks>
- /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when the same item is selected.
+ /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem Prepend(string text)
/// <summary>
/// To remove the given item.
/// </summary>
- /// <param name="item">FlipSelector's item.</param>
+ /// <param name="item">FlipSelector's item</param>
/// <since_tizen> preview </since_tizen>
public void Remove(FlipSelectorItem item)
{
}
/// <summary>
- /// Programmatically select the next item of the flip selector widget.
+ /// Programmatically select the next item of a flip selector widget.
/// </summary>
/// <remarks>
/// The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards.
}
/// <summary>
- /// Programmatically select the previous item of the flip selector widget.
+ /// Programmatically select the previous item of a flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Prev()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The item class of FlipSelector.
+ /// Iterm class of FlipSelector
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FlipSelectorItem : ItemObject
{
/// <summary>
- /// Sets or gets the text of the FlipSelectorItem.
+ /// Sets or gets the Text of FlipSelectorItem
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; private set; }
/// <summary>
- /// Selected will be triggered when selected.
+ /// Selected will be triggered when Selected
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
namespace ElmSharp
{
/// <summary>
- /// The FloatingButton is a widget to add the floating area for buttons.
+ /// The FloatingButton is a widget that to add floating area for buttons.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FloatingButton : Layout
/// <summary>
/// Creates and initializes a new instance of the FloatingButton class.
/// </summary>
- /// <param name="parent">Created on this parent container.</param>
+ /// <param name="parent">Created on this parent container..</param>
/// <since_tizen> preview </since_tizen>
public FloatingButton(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets the floatingbutton mode.
+ /// Sets or gets floatingbutton mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FloatingButtonMode Mode
}
/// <summary>
- /// Gets the floatingbutton position.
+ /// Gets floatingbutton Position.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FloatingButtonPosition Position
}
/// <summary>
- /// Sets or gets the movability for a given FloatingButton widget.
+ /// Sets or gets movability for a given floatingbutton widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool MovementBlock
}
/// <summary>
- /// Gets the opacity's value of the given FloatingButton.
+ /// Get Opacity's value of the given FloatingButton.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Set the floatingbutton position with or without animation.
+ /// Set the floatingbutton position with animation or not.
/// </summary>
- /// <param name="position">Button position.</param>
- /// <param name="animated">Animation flag.</param>
+ /// <param name="position">Button position</param>
+ /// <param name="animated">Animat flag</param>
/// <since_tizen> preview </since_tizen>
public void SetPosition(FloatingButtonPosition position, bool animated)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the FloatingButtonMode.
+ /// Enumeration for FloatingButtonMode
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FloatingButtonMode
{
/// <summary>
- /// Allows all positions.
+ /// Allows all positions
/// </summary>
All,
/// <summary>
- /// Allows left and right positions only.
+ /// Allows LEFT and RIGHT positions only
/// </summary>
LeftRightOnly,
}
/// <summary>
- /// Enumeration for the FloatingButtonPosition.
+ /// Enumeration for FloatingButtonPosition
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FloatingButtonPosition
{
/// <summary>
- /// Hides in the left, but only the small handler will show.
+ /// Hides in the left, but small handler will show only
/// </summary>
LeftOut,
/// <summary>
- /// Shows all of the buttons, but lies on the left.
+ /// Shows all of buttons, but lies on the left
/// </summary>
Left,
/// <summary>
- /// Shows all of the buttons, but lies on the center.
+ /// Shows all of buttons, but lies on the center
/// </summary>
Center,
/// <summary>
- /// Shows all of the buttons, but lies on the right.
+ /// Shows all of buttons, but lies on the right
/// </summary>
Right,
/// <summary>
- /// Hides in the right, but only the small handler will show.
+ /// Hides in the right, but small handler will show only
/// </summary>
RightOut,
}
{
/// <summary>
/// It inherits System.EventArgs.
- /// It contains the item which is the <see cref="GenGridItem"/> type.
- /// All events of the GenGrid contain GenGridItemEventArgs as a parameter.
+ /// It contains Item which is <see cref="GenGridItem"/> type.
+ /// All events of GenGrid contain GenGridItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets the gengrid item. The return type is <see cref="GenGridItem"/>.
+ /// Gets or sets GenGrid item.The return type is <see cref="GenGridItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem Item { get; set; }
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The GenGrid is a widget that aims to position objects in a grid layout, while actually creating and rendering only the visible ones.
- /// It has two directions in which a given GenGrid widget expands while placing its items, horizontal and vertical.
- /// The gengrid items are represented through the <see cref="GenItemClass"/> definition field details.
+ /// The GenGrid is a widget that aims to position objects in a grid layout while actually creating and rendering only the visible ones.
+ /// It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical.
+ /// The GenGrid items are represented through <see cref="GenItemClass"/> definition field details.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGrid : Layout
/// <summary>
/// Creates and initializes a new instance of the GenGrid class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by GenGrid as a child. It's the <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by GenGrid as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GenGrid(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// ItemSelected is raised when a new GenGrid item is selected.
+ /// ItemSelected is raised when a new gengrid item is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when the gengrid item is unselected.
+ /// ItemUnselected is raised when the gengrid item is Unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemUnselected;
public event EventHandler<GenGridItemEventArgs> ItemReleased;
/// <summary>
- /// ItemActivated is raised when a new gengrid item is double-clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemActivated;
/// <summary>
- /// ItemDoubleClicked is raised when a new gengrid item is double-clicked.
+ /// ItemDoubleClicked is raised when a new gengrid item is double clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemDoubleClicked;
/// <summary>
- /// ItemRealized is raised when a gengrid item is implemented through <see cref="GenItemClass"/>.
+ /// ItemRealized is raised when a gengrid item is implementing through <see cref="GenItemClass"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemRealized;
public event EventHandler Changed;
/// <summary>
- /// Gets or sets the item's grid alignment along X-axis within a given GenGrid widget.
+ /// Gets or sets the item's grid alignment along x-axis within a given gengrid widget.
/// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users.
- /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along X-axis.
+ /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along x-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ItemAlignmentX
}
/// <summary>
- /// Gets or sets the item's grid alignment on Y-axis within a given GenGrid widget.
+ /// Gets or sets the item's grid alignment on y-axis within a given gengrid widget.
/// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users.
- /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along Y-axis.
+ /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ItemAlignmentY
}
/// <summary>
- /// Gets or sets the manner in which the items grid is filled within a given GenGrid widget.
- /// It is filled if true, otherwise not filled if false.
+ /// Gets or sets the manner in which the items grid is filled within a given gengrid widget.
+ /// It is filled if true, otherwise false.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool FillItems
}
/// <summary>
- /// Gets or sets whether multi-selection is enabled or disabled for a given GenGrid widget.
+ /// Gets or sets whether multi-selection is enabled or disabled for a given gengrid widget.
/// </summary>
/// <remarks>
/// Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously.
}
/// <summary>
- /// Gets or sets the width for the items of a given GenGrid widget.
+ /// Gets or sets the width for the items of a given gengrid widget.
/// </summary>
/// <remarks>
/// A gengrid, after creation, still has no information on the size to give to each of its cells.
- /// The default width and height just are one finger wide.
+ /// The default width and height just have one finger wide.
/// Use this property to force a custom width for your items, making them as big as you wish.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the height for the items of a given GenGrid widget.
+ /// Gets or sets the height for the items of a given gengrid widget.
/// </summary>
/// <remarks>
/// A gengrid, after creation, still has no information on the size to give to each of its cells.
- /// The default width and height just are one finger wide.
+ /// The default width and height just have one finger wide.
/// Use this property to force a custom height for your items, making them as big as you wish.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the direction for which a given GenGrid widget expands while placing its items.
+ /// Gets or sets the direction for which a given gengrid widget expands while placing its items.
/// </summary>
/// <remarks>
/// If true, items are placed in columns from top to bottom and when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally.
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy.
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Gets the first item in a given GenGrid widget.
+ /// Gets the first item in a given gengrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem FirstItem
}
/// <summary>
- /// Gets the last item in a given GenGrid widget.
+ /// Gets the last item in a given gengrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem LastItem
}
/// <summary>
- /// Gets the items count in a given GenGrid widget.
+ /// Gets the items count in a given gengrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public uint ItemCount
}
/// <summary>
- /// Gets the selected item in a given GenGrid widget.
+ /// Gets the selected item in a given gengrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem SelectedItem
}
/// <summary>
- /// Gets or sets whether a given GenGrid widget is able to or not able to have items reordered.
+ /// Gets or sets whether a given gengrid widget is or not able have items reordered.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ReorderMode
}
/// <summary>
- /// Appends a new item to a given GenGrid widget. This adds an item to the end of the gengrid.
+ /// Appends a new item to a given gengrid widget. This adds an item to the end of the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepends a new item to a given GenGrid widget. This adds an item to the beginning of the gengrid.
+ /// Prepends a new item to a given gengrid widget. This adds an item to the beginning of the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Inserts an item before another in a GenGrid widget. This inserts an item before another in the gengrid.
+ /// Inserts an item before another in a gengrid widget. This inserts an item before another in the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
- /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains data and itemClass./></returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Inserts an item after another in a GenGrid widget. This inserts an item after another in the gengrid.
+ /// Inserts an item before another in a gengrid widget. This inserts an item after another in the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="after">The item after which to place this new one.</param>
- /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Inserts an item in a GenGrid widget using a user-defined sort function.
+ /// Insert an item in a gengrid widget using a user-defined sort function.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="comparison">User defined comparison function that defines the sort order based on the gengrid item and its data.</param>
- /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
+ /// <param name="comparison">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
+ /// <returns>Return a gengrid item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison)
{
/// <param name="position">The position of the item in the viewport.</param>
/// <param name="animated">The type of how to show the item.</param>
/// <remarks>
- /// If animated is true, the gengrid shows the item by scrolling if it's not fully visible.
- /// If animated is false, the gengrid shows the item by jumping if it's not fully visible.
+ /// If animated is true, the gengrid shows item by scrolling if it's not fully visible.
+ /// If animated is false, the gengrid shows item by jumping if it's not fully visible.
/// </remarks>
/// <seealso cref="ScrollToPosition"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all the items from a given GenGrid widget.
- /// This removes (and deletes) all the items in the object, making it empty.
+ /// Removes all items from a given gengrid widget.
+ /// This removes(and deletes) all items in obj, making it empty.
/// </summary>
/// <remarks>
/// <see cref="ItemObject.Delete()"/> to delete just one item.
}
/// <summary>
- /// Gets the item that is at the X, Y canvas coordinates.
+ /// Get the item that is at the x, y canvas coords.
/// </summary>
- /// <param name="x">The input X coordinate.</param>
- /// <param name="y">The input Y coordinate.</param>
+ /// <param name="x">The input x coordinate</param>
+ /// <param name="y">The input y coordinate</param>
/// <param name="portionX">The position relative to the item returned here.
- /// -1, 0, or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0), or on the right part(1).
+ /// -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1).
/// </param>
- /// <param name="portionY">The position relative to the item returned here.
- /// -1, 0, or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0), or on the lower part (1).
+ /// <param name="portionY">The position relative to the item returned here
+ /// -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1).
/// </param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="GenItem"/>.
- /// An instance to the gengrid item is added.
- /// It contains the Update() method to update a gengrid item which is given.
+ /// A instance to the gengrid item added.
+ /// It contains Update() method to update a gengrid item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItem : GenItem
}
/// <summary>
- /// Sets or gets the cursor to be shown when the mouse is over the gengrid item.
+ /// Sets or gets the cursor to be shown when mouse is over the gengrid item.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets or gets, or sets the style of the given gengrid item's tooltip.
+ /// Sets or gets or sets the style of given gengrid item's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string TooltipStyle
}
/// <summary>
- /// Gets the gengrid item's select mode.
+ /// Get the gengrid item's select mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override GenItemSelectionMode SelectionMode
}
/// <summary>
- /// Gets or sets the gengrid item's row position, relative to the whole gengrid's grid area.
+ /// Gets or sets gengrid item's row position, relative to the whole gengrid's grid area.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Row
}
/// <summary>
- /// Gets or sets the gengrid item's column position, relative to the whole gengrid's grid area.
+ /// Gets or sets gengrid item's column position, relative to the whole gengrid's grid area.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Column
}
/// <summary>
- /// Sets the text to be shown in the gengrid item.
+ /// Set the text to be shown in the gengrid item.
/// </summary>
/// <param name="tooltip">The text to set.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Unsets the tooltip from item.
+ /// Unset tooltip from item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override void UnsetTooltip()
/// <summary>
/// Updates the content of a given gengrid item.
- /// This updates an item by calling all the GenItem class functions again to get the content, text, and states.
+ /// This updates an item by calling all the genitem class functions again to get the content, text, and states.
/// Use this when the original item data has changed and you want the changes to reflect.
/// </summary>
/// <remarks>
}
/// <summary>
- /// Sets the content to be shown in the tooltip item.
+ /// Set the content to be shown in the tooltip item.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void UpdateTooltipDelegate()
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the selection modes of GenItem.
+ /// Enumeration for select mode of GenItem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenItemSelectionMode
/// <summary>
/// It inherits <see cref="ItemObject"/>.
/// A base class for <see cref="GenGridItem"/> and <see cref="GenListItem"/>.
- /// It contains the GenItem class and data to display the data.
+ /// It contains genitem class and data to display data.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class GenItem : ItemObject
public GenItemClass ItemClass { get; protected set; }
/// <summary>
- /// Sets or gets the tooltip content delegate.
+ /// Sets or gets tooltip content delegate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetTooltipContentDelegate TooltipContentDelegate
}
/// <summary>
- /// It's an abstract property.
+ /// It's a abstract property.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract GenItemSelectionMode SelectionMode { get; set; }
/// <summary>
- /// Sets or gets the cursor to be shown when the mouse is over the gengrid item.
+ /// Sets or gets the cursor to be shown when mouse is over the gengrid item
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract string Cursor { get; set; }
public abstract bool IsUseEngineCursor { get; set; }
/// <summary>
- /// 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.
+ /// Gets 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public object Data { get; protected set; }
/// <summary>
- /// It's an abstract property. It's implemented by <see cref="GenGridItem.IsSelected"/> and <see cref="GenListItem.IsSelected"/>.
+ /// It's a abstract property. It's implemented by <see cref="GenGridItem.IsSelected"/> and <see cref="GenListItem.IsSelected"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract bool IsSelected { get; set; }
/// <summary>
- /// It's an abstract property. It's implemented by <see cref="GenGridItem.TooltipStyle"/> and <see cref="GenListItem.TooltipStyle"/>.
+ /// It's a abstract property. It's implemented by <see cref="GenGridItem.TooltipStyle"/> and <see cref="GenListItem.TooltipStyle"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract string TooltipStyle { get; set; }
/// <summary>
- /// Sets the tooltip text.
+ /// Set tooltip text.
/// </summary>
/// <param name="tooltip">The text to set.</param>
/// <since_tizen> preview </since_tizen>
public abstract void SetTooltipText(string tooltip);
/// <summary>
- /// Unsets the tooltip.
+ /// Unset tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract void UnsetTooltip();
/// <summary>
- /// It's an abstract method. It's implemented by <see cref="GenGridItem.Update"/> and <see cref="GenListItem.Update"/>.
+ /// It's a abstract method. It's implemented by <see cref="GenGridItem.Update"/> and <see cref="GenListItem.Update"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract void Update();
/// <summary>
- /// The override method for deleting the item class and item data. It's called when the item is deleted.
+ /// The override method for delete item class and item data. It's called when the item is deleting.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnInvalidate()
}
/// <summary>
- /// Abstract method for updating the tooltip content.
+ /// Abstract method for updating tooltip content.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected abstract void UpdateTooltipDelegate();
{
/// <summary>
/// It represents the GenGrid or GenList item class definition field details.
- /// It has some display styles, such as "default", "full", and "group_index".
+ /// It has some display styles, such as "default", "full" and "group_index".
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenItemClass : IDisposable
/// </summary>
/// <param name="data">The item data.</param>
/// <param name="part">The part where the data should be shown.</param>
- /// <param name="old">The content that has been added in gengrid.</param>
+ /// <param name="old">The content has been added in gengrid.</param>
/// <returns>Return content that should be shown.</returns>
/// <since_tizen> preview </since_tizen>
public delegate EvasObject GetReusableContentDelegate(object data, string part, EvasObject old);
}
/// <summary>
- /// Destroys the GenItemClass object.
+ /// Destroy the GenItemClass object.
/// </summary>
~GenItemClass()
{
public string ItemStyle { get { return _style; } }
/// <summary>
- /// Gets or sets the callback that defines how to display the item text.
+ /// Gets or sets the callback that defines how to display item text.
/// If get, return <see cref="GetTextDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetTextDelegate GetTextHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to display the item content.
+ /// Gets or sets the callback that defines how to display item content.
/// If get, return <see cref="GetContentDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetContentDelegate GetContentHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to delete the item text and content.
+ /// Gets or sets the callback that defines how to delete item text and content.
/// If get, return <see cref="DeleteDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DeleteDelegate DeleteHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to reuse the item content.
+ /// Gets or sets the callback that defines how to reuse item content.
/// If get, return <see cref="GetReusableContentDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed,
- /// otherwise false.
+ /// true if managed resources should be disposed
+ /// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Creates a new GenList item class in a given GenList widget.
+ /// Create a new genlist item class in a given genlist widget.
/// </summary>
/// <returns>The new item class object.</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes an item class in a given GenList widget.
+ /// Remove an item class in a given genlist widget.
/// </summary>
/// <param name="unmanagedPtr">The object to be removed.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// It represents the gengrid item class definition field details.
+ /// It represents the GenGrid item class definition field details.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItemClass : GenItemClass
}
/// <summary>
- /// Adds a new gengrid item class in a given GenGrid widget.
+ /// Add a new gengrid item class in a given gengrid widget.
/// </summary>
/// <returns>The new instance.</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes the item class in a given GenGrid widget.
+ /// Remove an item class in a given gengrid widget.
/// </summary>
/// <param name="unmanagedPtr">The object to be removed.</param>
/// <since_tizen> preview </since_tizen>
namespace ElmSharp
{
/// <summary>
- /// Enumeration for setting the genlist item types.
+ /// Enumeration for setting genlist item type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenListItemType
{
/// <summary>
- /// If Normal is set, then this item is a normal item.
+ /// if Normal is set then this item is normal item.
/// </summary>
Normal = 0,
/// <summary>
- /// If Tree is set, then this item is displayed as an item that is able to expand and have child items.
+ /// If tree is set then this item is displayed as an item that is able to expand and have child items.
/// </summary>
Tree = (1 << 0),
/// <summary>
- /// If Group is set, then this item is a group index item that is displayed at the top until the next group comes.
+ /// if Group is set then this item is group index item that is displayed at the top until the next group comes.
/// </summary>
Group = (1 << 1),
}
/// <summary>
- /// Enumeration for setting the genlist's resizing behavior, transverse axis scrolling, and items cropping.
+ /// Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenListMode
{
/// <summary>
/// The genlist won't set any of its size hints to inform how a possible container should resize it.
- /// Then, if it's not created as a "resize object", it might end up with zeroed dimensions.
- /// The genlist will respect the container's geometry,and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
+ /// Then, if it's not created as a "resize object", it might end with zeroed dimensions.
+ /// The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
/// </summary>
Compress = 0,
Limit,
/// <summary>
- /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time.
+ /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.
/// This is naturally bound by the genlist object's maximum size hints, set externally.
/// </summary>
Expand
/// <summary>
/// It inherits System.EventArgs.
- /// It contains an item which is <see cref="GenListItem"/> type.
- /// All events of the GenList contain GenListItemEventArgs as a parameter.
+ /// It contains Item which is <see cref="GenListItem"/> type.
+ /// All events of GenList contain GenListItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenListItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets the genlist item. The return type is <see cref="GenListItem"/>.
+ /// Gets or sets GenList item. The return type is <see cref="GenListItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenListItem Item { get; set; }
}
/// <summary>
- /// Enumeration for defining where to position the item in the genlist.
+ /// Enumeration that defines where to position the item in the genlist.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollToPosition
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The GenList is a widget that aims to have a more expansive list than the simple <see cref="List"/> in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage.
+ /// The GenList is a widget that aims to have more expansive list than the simple <see cref="List"/> in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage.
/// At the same time it was also made to be able to do tree structures.
- /// But the price to pay is more complex when it comes to usage.
- /// If all you want is a simple list with icons and a single text, use <see cref="List"/> widget.
+ /// But the price to pay is more complexity when it comes to usage.
+ /// If all you want is a simple list with icons and a single text, use the <see cref="List"/> widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenList : Layout
/// <summary>
/// Creates and initializes a new instance of the GenList class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by GenList as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by GenList as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GenList(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of the GenList class.
+ /// Creates and initializes a new instance of GenList class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected GenList() : base()
/// Gets or sets whether the homogeneous mode is enabled.
/// </summary>
/// <remarks>
- /// If true, the genlist items will have the same height and width.
+ /// If true, the genlist items have same height and width.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
/// <summary>
/// Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally.
- /// The default value is <see cref="GenListMode.Scroll"/>, which means that if the items are too wide to fit, the scroller scrolls horizontally.
- /// If set to <see cref="GenListMode.Compress"/>, means that the item width is fixed (restricted to a minimum) to the list width when calculating its size in order to allow the height to be calculated based on it.
- /// If set to <see cref="GenListMode.Limit"/>, means that items are expanded to the viewport width and limited to that size.
- /// If set to <see cref="GenListMode.Expand"/>, means that genlist try to reserve space to all its items to be visible at a time.
+ /// The default value is <see cref="GenListMode.Scroll"/> which means that if items are too wide to fit, the scroller scrolls horizontally.
+ /// If set <see cref="GenListMode.Compress"/> which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it.
+ /// If set <see cref="GenListMode.Limit"/> which means that items are expanded to the viewport width and limited to that size.
+ /// if set <see cref="GenListMode.Expand"/> which means that genlist try to reserve space to all its items to be visible at a time.
/// </summary>
/// <remarks>
- /// Compress makes the genlist resize slower, as it recalculates every item height again whenever the list width changes.
- /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, the genlist items are initialized fast.
- /// However, there are no subobjects in the genlist, which can be on the flying resizable (such as TEXTBLOCK).
+ /// Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes.
+ /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast.
+ /// However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK).
/// If so, then some dynamic resizable objects in the genlist would not be diplayed properly.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the maximum number of items within an item block.
+ /// Gets or set the maximum number of items within an item block.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BlockCount
}
/// <summary>
- /// Gets or sets the focus upon the items selection mode.
+ /// Gets or Sets focus upon items selection mode.
/// </summary>
/// <remarks>
- /// When enabled, every selection of an item inside <see cref="GenList"/> will automatically set focus to its first focusable widget from the left.
- /// This is true of course, if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement.
+ /// When enabled, every selection of an item inside the <see cref="GenList"/> will automatically set focus to its first focusable widget from the left.
+ /// This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement.
/// Clicking on a focusable widget inside an item will couse this particular item to get focus as usual.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets whether to enable multi-selection in the genlist.
+ /// Gets or sets whether enable multi-selection in the genlist.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsMultiSelection
}
/// <summary>
- /// Gets the selected item in a given GenList widget.
+ /// Gets the selected item in a given genlist widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenListItem SelectedItem
}
/// <summary>
- /// Gets the count of items in a this genlist widget.
+ /// Gets count of items in a this genlist widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Count
public event EventHandler<GenListItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when the genlist item is unselected.
+ /// ItemUnselected is raised when the genlist item is Unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemUnselected;
public event EventHandler<GenListItemEventArgs> ItemReleased;
/// <summary>
- /// ItemActivated is raised when a new genlist item is double-clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemActivated;
/// <summary>
- /// ItemDoubleClicked is raised when a new genlist item is double-clicked.
+ /// ItemDoubleClicked is raised when a new genlist item is double clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemDoubleClicked;
/// <summary>
/// ItemUnrealized is raised when a new genlist item is unrealized.
- /// After calling unrealize, the item's content objects are deleted, and the item object itself is deleted or is put into a floating cache.
+ /// After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemUnrealized;
/// <summary>
- /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default, it's 1 second.
+ /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemLongPressed;
public event EventHandler<GenListItemEventArgs> ItemMovedBefore;
/// <summary>
- /// Changed is raised when the genlist has changed.
+ /// Changed is raised when genlist is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Changed
}
/// <summary>
- /// ScrollAnimationStarted is raised when the scrolling animation has started.
+ /// ScrollAnimationStarted is raised when scrolling animation has started.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ScrollAnimationStarted
}
/// <summary>
- /// ScrollAnimationStopped is raised when the scrolling animation has stopped.
+ /// ScrollAnimationStopped is raised when scrolling animation has stopped.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ScrollAnimationStopped
}
/// <summary>
- /// Appends a new item to the end of a given GenList widget.
+ /// Appends a new item to the end of a given genlist widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenListItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Appends a new item with <see cref="GenListItemType"/> to the end of a given GenList widget.
+ /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type)
{
}
/// <summary>
- /// Appends a new item with <see cref="GenListItemType"/> to the end of a given GenList widget or the end of the children list, if the parent is given.
+ /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget or the end of the children list if the parent is given.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Prepends a new item to the beginning of a given GenList widget.
+ /// Prepends a new item to the beginning of a given genlist widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data)
{
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type)
{
}
/// <summary>
- /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given GenList widget or the beginning of the children list, if the parent is given.
+ /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given genlist widget or the beginning of the children list if the parent is given.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
{
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> before another item in a GenList widget.
- /// It is the same tree level or group as the item before which it is inserted.
+ /// Inserts an item with <see cref="GenListItemType"/> before another item in a genlist widget.
+ /// It is the same tree level or group as the item before which it is inserted.????
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> before another item under a parent in a GenList widget.
+ /// Inserts an item with <see cref="GenListItemType"/> before another item under a parent in a genlist widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> after another item under a parent in a GenList widget.
+ /// Inserts an item with <see cref="GenListItemType"/> after another item under a parent in a genlist widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="after">The item after which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertAfter(GenItemClass itemClass, object data, GenListItem after, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Inserts an item in a GenList widget using a user-defined sort function.
+ /// Insert an item in a genlist widget using a user-defined sort function.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="comparison">User-defined comparison function that defines the sort order based on the genlist item and its data.</param>
+ /// <param name="comparison">User defined comparison function that defines the sort order based on genlist item and its data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a genlist item that contains the data and itemClass.</returns>
+ /// <returns>Return a genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Shows the given item with the position type in a genlist.
- /// When animated is true, the genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and take sometime.
- /// When animated is false, the genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible.
+ /// Shows the given item with position type in a genlist.
+ /// When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time.
+ /// When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible.
/// </summary>
/// <param name="item">The item to display.</param>
/// <param name="position">The position to show the given item to <see cref="ScrollToPosition"/>.</param>
/// <summary>
/// Updates the content of all the realized items.
- /// This updates all the realized items by calling all <see cref="GenItemClass"/> again to get the content, text, and states.
+ /// This updates all the realized items by calling all the <see cref="GenItemClass"/> again to get the content, text and states.
/// Use this when the original item data has changed and the changes are desired to reflect.
/// To update just one item, use <see cref="GenListItem.Update"/>.
/// </summary>
}
/// <summary>
- /// Removes all the items from a given genlist widget.
- /// This removes (and deletes) all items in the object, making it empty.
+ /// Removes all items from a given genlist widget.
+ /// This removes (and deletes) all items in obj, making it empty.
/// To delete just one item, use <see cref="ItemObject.Delete"/>.
/// </summary>
/// <seealso cref="ItemObject.Delete"/>
}
/// <summary>
- /// Gets the item that is at the X, Y canvas coordinates.
+ /// Get the item that is at the x, y canvas coords.
/// </summary>
- /// <param name="x">The input X-coordinate.</param>
- /// <param name="y">The input Y-coordinate.</param>
- /// <param name="pos">The position relative to the item returned here.
- /// -1, 0, or 1 depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1).
+ /// <param name="x">The input x coordinate</param>
+ /// <param name="y">The input y coordinate</param>
+ /// <param name="pos">The position relative to the item returned here
+ /// -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1).
/// </param>
- /// <returns>The item at the given coordinates.</returns>
+ /// <returns></returns>
/// <since_tizen> preview </since_tizen>
public GenListItem GetItemByPosition(int x, int y, out int pos)
{
/// <summary>
/// Gets the nth item in a given genlist widget, placed at position nth, in its internal items list.
/// </summary>
- /// <param name="index">The number of the item to grab (0 being the first).</param>
+ /// <param name="index">The number of the item to grab (0 being the first)</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public GenListItem GetItemByIndex(int index)
}
/// <summary>
- /// The callback of the Unrealized event.
+ /// The callback of Unrealize Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The type of the item's part types.
+ /// The type of item's part type.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
All = 0,
/// <summary>
- /// The Text part type.
+ /// The text part type.
/// </summary>
Text = (1 << 0),
Content = (1 << 1),
/// <summary>
- /// The State part type.
+ /// The state of part.
/// </summary>
State = (1 << 2),
/// <summary>
/// It inherits <see cref="GenItem"/>.
- /// A instance to the genlist item is added.
- /// It contains the Update() method to update a genlist item which is given.
+ /// A instance to the genlist item added.
+ /// It contains Update() method to update a genlist item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenListItem : GenItem
/// <summary>
/// Updates the content of an item.
- /// This updates an item by calling all <see cref="GenItemClass"/> again to get the content, text, and states.
+ /// This updates an item by calling all the <see cref="GenItemClass"/> again to get the content, text, and states.
/// Use this when the original item data has changed and the changes are desired to reflect.
- /// To update the already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
+ /// To update already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
/// </summary>
/// <seealso cref="GenList.UpdateRealizedItems"/>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Updates the part of an item.
- /// This updates an item's part by calling the item's fetching functions again to get the contents, texts, and states.
+ /// This updates an item's part by calling item's fetching functions again to get the contents, texts and states.
/// Use this when the original item data has changed and the changes are desired to be reflected.
/// To update an item's all property, use <see cref="GenList.UpdateRealizedItems"/>.
/// </summary>
- /// <param name="part">The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content", and so on. It is also used for globbing to match '*', '?', and '.'. It can be used for updating multi-fields.</param>
- /// <param name="type">The type of the item's part type.</param>
+ /// <param name="part">The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields.</param>
+ /// <param name="type">The type of item's part type.</param>
/// <seealso cref="GenList.UpdateRealizedItems"/>
/// <since_tizen> preview </since_tizen>
public void UpdateField(string part, GenListItemFieldType type)
}
/// <summary>
- /// Demotes an item to the end of the list.
+ /// Demote an item to the end of the list.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void DemoteItem()
}
/// <summary>
- /// Gets the previous item in a genlist widget's internal list of items.
+ /// Get the previous item in a genlist widget's internal list of items.
/// </summary>
/// <seealso cref="Next"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the content to be shown in the tooltip item.
+ /// Sets or gets the content to be shown in the tooltip item
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets the text to be shown in the genlist item.
+ /// Set the text to be shown in the genlist item.
/// </summary>
/// <param name="tooltip">The text to set in the content.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Unsets the tooltip from the item.
+ /// Unset tooltip from item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override void UnsetTooltip()
}
/// <summary>
- /// Gets or sets the style of the given genlist item's tooltip.
+ /// Gets or sets the style of given genlist item's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string TooltipStyle
}
/// <summary>
- /// Gets or sets the disable size restrictions on an object's tooltip.
+ /// Gets or sets whether disable size restrictions on an object's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsTooltipWindowMode
}
/// <summary>
- /// Gets the index of the item. It is only valid, once displayed.
+ /// Gets the index of the item. It is only valid once displayed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Index
}
/// <summary>
- /// Gets the depth of the expanded item.
+ /// Gets the depth of expanded item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ExpandedItemDepth
}
/// <summary>
- /// Remove all the subitems (children) of the given item.
+ /// Remove all sub-items (children) of the given item.
/// </summary>
/// <remarks>
- /// This removes the items that are the children (and their descendants) of the given item.
+ /// This removes all items that are children (and their descendants) of the given item it.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public void ClearSubitems()
}
/// <summary>
- /// Updates the item class of the item.
+ /// Update the item class of an item.
/// This sets another class of the item, changing the way that it is displayed. After changing the item class, <see cref="Update"/> is called on the item.
/// </summary>
/// <param name="itemClass">The item class for the item.</param>
}
/// <summary>
- /// Sets the content to be shown in the tooltip item.
+ /// Set the content to be shown in the tooltip item.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void UpdateTooltipDelegate()
{
/// <summary>
/// The GestureLayer is used to detect gestures.
- /// Inherits Widget.
+ /// Inherits Widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GestureLayer : Widget
private readonly List<NativeCallback> _handlers = new List<NativeCallback>();
/// <summary>
- /// Creates and initializes a new instance of the GestureLayer class.
+ /// Creates and initializes a new instance of GestureLayer class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by the GestureLayer as a child. It's the <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by GestureLayer as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GestureLayer(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Enumeration for the supported gesture types.
+ /// Enumeration for supported gesture types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GestureType
{
/// <summary>
- /// N fingers single taps.
+ /// N fingers single taps
/// </summary>
Tap = 1,
/// <summary>
- /// N fingers single long-taps.
+ /// N fingers single long-taps
/// </summary>
LongTap,
/// <summary>
- /// N fingers double-single taps.
+ /// N fingers double-single taps
/// </summary>
DoubleTap,
/// <summary>
- /// N fingers triple-single taps.
+ /// N fingers triple-single taps
/// </summary>
TripleTap,
/// <summary>
- /// Reports momentum in the direction of the move.
+ /// Reports momentum in the direction of move
/// </summary>
Momentum,
/// <summary>
- /// N fingers line gesture.
+ /// N fingers line gesture
/// </summary>
Line,
/// <summary>
- /// N fingers flick gesture.
+ /// N fingers flick gesture
/// </summary>
Flick,
/// <summary>
- /// Zoom.
+ /// Zoom
/// </summary>
Zoom,
/// <summary>
- /// Rotate.
+ /// Rotate
/// </summary>
Rotate,
}
/// <summary>
- /// Enumeration for the gesture states.
+ /// Enumeration for gesture states.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GestureState
{
/// <summary>
- /// Gesture not started.
+ /// Gesture not started
/// </summary>
Undefined = -1,
/// <summary>
- /// Gesture started.
+ /// Gesture started
/// </summary>
Start,
/// <summary>
- /// Gesture is ongoing.
+ /// Gesture is ongoing
/// </summary>
Move,
/// <summary>
- /// Gesture completed.
+ /// Gesture completed
/// </summary>
End,
/// <summary>
- /// Ongoing gesture is aborted.
+ /// Ongoing gesture is aborted
/// </summary>
Abort,
}
}
/// <summary>
- /// Sets or gets the gesture layer to continue enable of an object.
+ /// Sets or gets the gesture layer continues enable of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Continues
}
/// <summary>
- /// Sets or gets the gesture layer long tap start timeout of an object.
+ /// Sets or gets the gesture layer long tap start timeout of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LongTapTimeout
}
/// <summary>
- /// Sets or gets the gesture layer double tap timeout of an object.
+ /// Sets or gets the gesture layer double tap timeout of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double DoubleTapTimeout
}
/// <summary>
- /// Sets or gets the gesture layer flick time limit (in ms) of an object.
+ /// Sets or gets the gesture layer flick time limit (in ms) of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public int FlickTimeLimit
}
/// <summary>
- /// Sets or gets the gesture layer line minimum length of an object.
+ /// Sets or gets the gesture layer line min length of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumLineLength
}
/// <summary>
- /// Sets or gets the gesture layer line angular tolerance of an object.
+ /// Sets or gets the gesture layer line angular tolerance of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LineAngularTolerance
}
/// <summary>
- /// Sets or gets the gesture layer line distance tolerance of an object.
+ /// Sets or gets the gesture layer line distance tolerance of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LineDistanceTolerance
}
/// <summary>
- /// Sets or gets the step-value for the rotate action.
+ /// Sets or gets step-value for rotate action.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RotateStep
}
/// <summary>
- /// Sets or gets the gesture layer rotate angular tolerance of an object.
+ /// Sets or gets the gesture layer rotate angular tolerance of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RotateAngularTolerance
}
/// <summary>
- /// Sets or gets the control step value for the zoom action.
+ /// Sets or gets control step value for zoom action.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomStep
}
/// <summary>
- /// Sets or gets the gesture layer zoom distance tolerance of an object.
+ /// Sets or gets the gesture layer zoom distance tolerance of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ZoomDistanceTolerance
}
/// <summary>
- /// Sets or gets the gesture layer zoom finger factor of an object.
+ /// Sets or gets the gesture layer zoom finger factor of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomFingerFactor
}
/// <summary>
- /// Sets or gets the gesture layer zoom wheel factor of an object.
+ /// Sets or gets the gesture layer zoom wheel factor of an object
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomWheelFactor
#endregion Properties
/// <summary>
- /// Attaches a gesture layer widget to an Evas object (setting the widget's target).
+ /// Attach a gesture layer widget to an Evas object (setting the widget's target).
/// A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events.
/// </summary>
/// <param name="target">The object to attach.</param>
}
/// <summary>
- /// Sets the gesture state change callback.
+ /// Set the gesture state change callback.
/// When all callbacks for the gesture are set to null, it means this gesture is disabled.
/// </summary>
/// <param name="type">The gesture you want to track state of.</param>
}
/// <summary>
- /// Clears the gesture state change callback.
+ /// clear the gesture state change callback.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearCallbacks()
// Following methods have been added for convenience, so the user will not have to convert Info structures himself
/// <summary>
- /// Sets the tap callback.
+ /// Set the tap callback.
/// </summary>
/// <param name="type">The gesture you want to track state of.</param>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
}
/// <summary>
- /// Sets the gesture state change callback with momentum gesture type.
+ /// Set the gesture state change callback with Momentum Gesture Type
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Sets the gesture state change callback with line gesture type.
+ /// Set the gesture state change callback with Line Gesture Type
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Sets the gesture state change callback with flick gesture type.
+ /// Set the gesture state change callback with Flick Gesture Type
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Sets the gesture state change callback with zoom gesture type.
+ /// Set the gesture state change callback with Zoom Gesture Type
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Sets the gesture state change callback with rotate gesture type.
+ /// Set the gesture state change callback with Rotate Gesture Type
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
#endregion Typed callback setting methods
/// <summary>
- /// Calls this function to construct a new gesture-layer object.
+ /// Call this function to construct a new gesture-layer object.
/// </summary>
/// <param name="parent">The gesture layer's parent widget.</param>
/// <returns></returns>
}
/// <summary>
- /// Clears the gesture state change callback.
+ /// clear the gesture state change callback.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnUnrealize()
#region Info structures
/// <summary>
- /// The struct of TapData.
+ /// The struct of TapData
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct TapData
{
/// <summary>
- /// The X coordinate of the center point.
+ /// The x coordinate of the center point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The Y coordinate of the center point.
+ /// The y coordinate of the center point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
}
/// <summary>
- /// The struct of MomentumData.
+ /// The struct of MomentumData
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public Int32 X2;
/// <summary>
- /// Final-swipe direction ending point on Y.
+ /// Final-swipe direction ending point on Y
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y2;
#pragma warning disable 3003
/// <summary>
- /// Timestamp of start of final X-swipe.
+ /// Timestamp of start of final x-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 HorizontalSwipeTimestamp;
/// <summary>
- /// Timestamp of start of final Y-swipe.
+ /// Timestamp of start of final y-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 VerticalSwipeTimestamp;
}
/// <summary>
- /// The struct of LineData.
+ /// The struct of LineData
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public Int32 X2;
/// <summary>
- /// Final-swipe direction ending point on Y.
+ /// Final-swipe direction ending point on Y
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y2;
#pragma warning disable 3003
/// <summary>
- /// Timestamp of start of final X-swipe.
+ /// Timestamp of start of final x-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 HorizontalSwipeTimestamp;
/// <summary>
- /// Timestamp of start of final Y-swipe.
+ /// Timestamp of start of final y-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 VerticalSwipeTimestamp;
}
/// <summary>
- /// The struct of ZoomData.
+ /// The struct of ZoomData
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct ZoomData
{
/// <summary>
- /// The X coordinate of zoom center point reported to the user.
+ /// The x coordinate of zoom center point reported to user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The Y coordinate of zoom center point reported to the user.
+ /// The y coordinate of zoom center point reported to user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
}
/// <summary>
- /// The struct of RotateData.
+ /// The struct of RotateData
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct RotateData
{
/// <summary>
- /// The X coordinate of rotation center point reported to the user.
+ /// The x coordinate of rotation center point reported to user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The Y coordinate of rotation center point reported to the user.
+ /// The y coordinate of rotation center point reported to user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
namespace ElmSharp
{
/// <summary>
- /// The HoverselItemEventArgs is a HoverselItem's EventArgs.
+ /// The HoverselItemEventArgs is an HoverselItem's EventArgs
/// </summary>
/// <since_tizen> preview </since_tizen>
public class HoverselItemEventArgs : EventArgs
{
/// <summary>
- /// The hoversel's item.
+ /// Hoversel's Item
/// </summary>
/// <since_tizen> preview </since_tizen>
public HoverselItem Item { get; set; }
/// <summary>
/// Creates and initializes a new instance of the Hoversel class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by Hoversel as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Hoversel as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Hoversel(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Clicked will be triggered when the hoversel is clicked.
+ /// Clicked will be triggered when Hoversel is clicked
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Expanded will be triggered when the hoversel is activated by clicking the hoversel, or by a function.
+ /// Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Expanded;
/// <summary>
- /// Dismissed will be triggered when the hoversel is dismissed.
+ /// Dismissed will be triggered when Hoversel Dismissed
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
/// <summary>
- /// ItemSelected will be triggered when the hoversel's item is selected.
+ /// ItemSelected will be triggered when Hoversel's Item Selected
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<HoverselItemEventArgs> ItemSelected;
}
/// <summary>
- /// Gets or sets the status of whether to update the icon and text of hoversel same to those of the selected item automatically.
+ /// Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoUpdate
}
/// <summary>
- /// This triggers the hoversel popup from the code, the same as if the user had clicked the button.
+ /// This triggers the hoversel popup from code, the same as if the user had clicked the button.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void HoverBegin()
}
/// <summary>
- /// Adds an item to the hoversel button.
+ /// Add an item to the hoversel button.
/// This adds an item to the hoversel to show when it is clicked.
/// </summary>
- /// <param name="label">Item's label.</param>
+ /// <param name="label">Item's label</param>
/// <returns>A handle to the added item.</returns>
/// <since_tizen> preview </since_tizen>
public HoverselItem AddItem(string label)
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The HoverselItem is the item of Hoversel.
+ /// The HoverselItem is the Item of Hoversel
/// </summary>
/// <since_tizen> preview </since_tizen>
public class HoverselItem : ItemObject
}
/// <summary>
- /// The HoverselItem's label.
+ /// HoverselItem's label
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Label { get; internal set; }
/// <summary>
- /// ItemSelected will be triggered when the HoverselItem is selected.
+ /// ItemSelected will be triggered when HoverselItem Selected
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ItemSelected;
namespace ElmSharp.Accessible
{
/// <summary>
- /// IAccessibleObject is an interface, which defines the properties and methods of an accessible object.
+ /// IAccessibleObject is a interface which defines properties and methods of accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAccessibleObject
ReadingInfoType ReadingInfoType { get; set; }
/// <summary>
- /// Gets or sets the role of the object in an accessibility domain.
+ /// Gets or sets the role of the object in accessibility domain.
/// </summary>
/// <since_tizen> preview </since_tizen>
AccessRole Role { get; set; }
/// <summary>
- /// Gets or sets the highlightable of the given widget.
+ /// Gets or sets highlightable of given widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
bool CanHighlight { get; set; }
/// <summary>
- /// Gets or sets the translation domain of the "name" and "description" properties.
- /// Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties.
- /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter.
- /// It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.
+ /// 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>
/// <since_tizen> preview </since_tizen>
string TranslationDomain { get; set; }
string Name { get; set; }
/// <summary>
- /// Gets or sets contextual information about the object.
+ /// Gets or sets contextual information about object.
/// </summary>
/// <since_tizen> preview </since_tizen>
string Description { get; set; }
AccessibleInfoProvider NameProvider { get; set; }
/// <summary>
- /// Gets or sets the delegate for <see cref="IAccessibleObject.Description"/>.
+ /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// 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 the source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
/// <since_tizen> preview </since_tizen>
void AppendRelation(IAccessibleRelation relation);
/// <summary>
/// Removes the relationship between two accessible objects.
/// </summary>
- /// <param name="relation">The relationship between the source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between source object and target object of a given type.</param>
/// <since_tizen> preview </since_tizen>
void RemoveRelation(IAccessibleRelation relation);
/// <summary>
- /// Highlights the accessible widget.
+ /// Highlights accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
void Highlight();
/// <summary>
- /// Clears the highlight of the accessible widget.
+ /// Clears highlight of accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
void Unhighlight();
namespace ElmSharp
{
/// <summary>
- /// The AnimatorMotionMapper interface.
+ /// The AnimatorMotionMapper interface
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
double Calculate(double position);
}
/// <summary>
- /// The LinearMotionMapper class.
+ /// The LinearMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LinearMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The AccelerateMotionMapper class.
+ /// The AccelerateMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class AccelerateMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DecelerateMotionMapper class.
+ /// The DecelerateMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DecelerateMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SinusoidalMotionMapper class.
+ /// The SinusoidalMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SinusoidalMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
}
- /// <summary>.
- /// The AccelerateFactorMotionMapper class.
+ /// <summary>
+ /// The AccelerateFactorMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class AccelerateFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of AccelerateFactorMotionMapper.
+ /// The power factor of AccelerateFactorMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DecelerateFactorMotionMapper class.
+ /// The DecelerateFactorMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DecelerateFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of DecelerateFactorMotionMapper.
+ /// The power factor of DecelerateFactorMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SinusoidalFactorMotionMapper class.
+ /// The SinusoidalFactorMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SinusoidalFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of SinusoidalFactorMotionMapper.
+ /// The power factor of SinusoidalFactorMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DivisorInterpolatedMotionMapper class.
+ /// The DivisorInterpolatedMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DivisorInterpolatedMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The Divisor of DivisorInterpolatedMotionMapper.
+ /// The Divisor of DivisorInterpolatedMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Divisor { get; set; } = 0;
/// <summary>
- /// The power of DivisorInterpolatedMotionMapper.
+ /// The power of DivisorInterpolatedMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The BounceMotionMapper class.
+ /// The BounceMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class BounceMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The bounces of BounceMotionMapper.
+ /// The bounces of BounceMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Bounces { get; set; } = 0;
/// <summary>
- /// The decay factor of BounceMotionMapper.
+ /// The decay factor of BounceMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SpringMotionMapper class.
+ /// The SpringMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SpringMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The wobbles of SpringMotionMapper.
+ /// The wobbles of SpringMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Wobbles { get; set; } = 0;
/// <summary>
- /// The decay factor of SpringMotionMapper.
+ /// The decat factir of SpringMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The CubicBezierMotionMapper class.
+ /// The CubicBezierMotionMapper class
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CubicBezierMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The X1 of CubicBezierMotionMapper.
+ /// The X1 of CubicBezierMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public double X1 { get; set; } = 0;
/// <summary>
- /// The Y1 of CubicBezierMotionMapper.
+ /// The Y1 of CubicBezierMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Y1 { get; set; } = 0;
/// <summary>
- /// The X2 of CubicBezierMotionMapper.
+ /// The X2 of CubicBezierMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
public double X2 { get; set; } = 0;
/// <summary>
- /// The Y2 of CubicBezierMotionMapper.
+ /// The Y2 of CubicBezierMotionMapper
/// </summary>
/// <since_tizen> preview </since_tizen>
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.
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
public enum IconLookupOrder
{
/// <summary>
- /// Icon look up order: freedesktop, theme.
+ /// Icon look up order: freedesktop, theme
/// </summary>
FreeDesktopFirst = 0,
/// <summary>
- /// Icon look up order: theme, freedesktop.
+ /// Icon look up order: theme, freedesktop
/// </summary>
ThemeFirst,
/// <summary>
- /// Icon look up order: freedesktop.
+ /// Icon look up order: freedesktop
/// </summary>
FreeDesktopOnly,
/// <summary>
- /// Icon look up order: theme.
+ /// Icon look up order: theme
/// </summary>
ThemeOnly
}
/// <summary>
- /// The Icon is a widget that displays the standard icon images ("delete", "edit", "arrows", etc.)
- /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on the icon context.
- /// Inherits Image.
+ /// The Icon is a widget that displays standard icon images ("delete", "edit", "arrows", etc.)
+ /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context.
+ /// Inherits Image
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Icon : Image
{
/// <summary>
- /// Creates and initializes a new instance of the Icon class.
+ /// Creates and initializes a new instance of Icon class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by Icon as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Icon as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Icon(EvasObject parent) : base(parent)
{
/// <summary>
/// Sets the file that is used, but uses a generated thumbnail.
/// </summary>
- /// <param name="file">The path to the file that is used as an icon image.</param>
- /// <param name="group">The group that the icon belongs to.</param>
+ /// <param name="file">The path to the file that is used as an icon image</param>
+ /// <param name="group">The group that the icon belongs to</param>
/// <since_tizen> preview </since_tizen>
public void SetThumb(string file, string group)
{
/// Adds a new icon object to the parent.
/// </summary>
/// <param name="parent">EvasObject</param>
- /// <returns>The new object, otherwise null if it cannot be created.</returns>
+ /// <returns>The new object, otherwise NULL if it cannot be created</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
/// <summary>
/// The Image is a widget that allows one to load and display an image file on it,
/// be it from a disk file or from a memory region.
- /// Inherits Widget.
+ /// Inherits Widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Image : Widget
EvasImage _imageObject = null;
/// <summary>
- /// Creates and initializes a new instance of the Image class.
+ /// Creates and initializes a new instance of Image class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Image(EvasObject parent) : base(parent)
{
public event EventHandler LoadingCompleted;
/// <summary>
- /// Clicked will be triggered when the image fails to load.
+ /// Clicked will be triggered when the image is fail to load.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler LoadingFailed;
}
/// <summary>
- /// Sets or gets whether the object is down resizable.
+ /// Sets or gets whether the object is down resizeable.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool CanScaleDown
}
/// <summary>
- /// Sets or gets whether the object is up resizable.
+ /// Sets or gets whether the object is up resizeable.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool CanScaleUp
}
/// <summary>
- /// Sets or gets whether the alpha channel data is being used on the given image object.
+ /// Sets or gets whether alpha channel data is being used on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsOpaque
}
/// <summary>
- /// Sets or gets the image color.
+ /// Sets or gets the image color
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color Color
}
/// <summary>
- /// Sets the background color.
+ /// Sets the background color
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
/// Gets the inlined image object of the image widget.
/// This property allows one to get the underlying EvasObject of type Image from this elementary widget. It can be useful to do things like save the image to a file, etc.
/// </summary>
- /// <remarks>Be careful not to manipulate it, as it is under the control of the widget.</remarks>
+ /// <remarks>Be careful to not manipulate it, as it is under the control of widget.</remarks>
/// <since_tizen> preview </since_tizen>
public EvasImage ImageObject
{
/// <summary>
/// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever.
/// </summary>
- /// <param name="left">The border's left width.</param>
- /// <param name="right">The border's right width.</param>
- /// <param name="top">The border's top width.</param>
- /// <param name="bottom">The border's bottom width.</param>
+ /// <param name="left">The border's left width</param>
+ /// <param name="right">The border's right width</param>
+ /// <param name="top">The border's top width</param>
+ /// <param name="bottom">The border's bottom width</param>
/// <since_tizen> preview </since_tizen>
public void SetBorder(int left, int right, int top, int bottom)
{
/// <summary>
/// Sets the file that is used as the image's source.
/// </summary>
- /// <param name="file">The path to the file that is used as an image source.</param>
+ /// <param name="file">The path to the file that is used as an image source</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(string file)
}
/// <summary>
- /// Sets the URI that is used as the image's source.
+ /// Sets the uri that is used as the image's source.
/// </summary>
- /// <param name="uri">The URI to the file that is used as an image source.</param>
+ /// <param name="uri">The uri to the file that is used as an image source</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(Uri uri)
/// Sets a location in the memory to be used as an image object's source bitmap.
/// </summary>
/// <remarks>
- /// This function is handy when the contents of an image file are mapped into the memory, for example,
- /// the format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary).
+ /// This function is handy when the contents of an image file are mapped into the memory, for example.
+ /// The format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary).
/// This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds.
/// </remarks>
- /// <param name="img">The binary data that is used as an image source.</param>
- /// <param name="size">The size of the binary data blob img.</param>
+ /// <param name="img">The binary data that is used as an image source</param>
+ /// <param name="size">The size of the binary data blob img</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
[Obsolete("This method will be removed. Use Load(Stream stream) instead.")]
/// <summary>
/// Sets the stream that is used as the image's source.
/// </summary>
- /// <param name="stream">The stream that is used as an image source.</param>
+ /// <param name="stream">The stream that is used as an image source</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(Stream stream)
/// <summary>
/// Sets the file that is used as the image's source with async.
/// </summary>
- /// <param name="file">The path to the file that is used as an image source.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
+ /// <param name="file">The path to the file that is used as an image source</param>
+ /// <param name="cancellationToken">cancellation token</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public Task<bool> LoadAsync(string file, CancellationToken cancellationToken = default(CancellationToken))
}
/// <summary>
- /// Sets the URI that is used as the image's source with async.
+ /// Sets the uri that is used as the image's source with async.
/// </summary>
- /// <param name="uri">The URI to the file that is used as an image source.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
+ /// <param name="uri">The uri to the file that is used as an image source</param>
+ /// <param name="cancellationToken">cancellation token</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public Task<bool> LoadAsync(Uri uri, CancellationToken cancellationToken = default(CancellationToken))
/// <summary>
/// Sets the stream that is used as the image's source with async.
/// </summary>
- /// <param name="stream">The stream that is used as an image source.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
+ /// <param name="stream">The stream that is used as an image source</param>
+ /// <param name="cancellationToken">cancellation token</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public async Task<bool> LoadAsync(Stream stream, CancellationToken cancellationToken = default(CancellationToken))
}
/// <summary>
- /// Sets the color of the Color class for a given widget.
+ /// Sets the color of color class for a given widget.
/// </summary>
- /// <param name="part">The name of the Color class.</param>
- /// <param name="color">The struct of the Color class.</param>
+ /// <param name="part">The name of color class.</param>
+ /// <param name="color">The struct of color</param>
/// <since_tizen> preview </since_tizen>
public override void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets the color of the Color class for a given widget.
+ /// Gets the color of color class for a given widget.
/// </summary>
- /// <param name="part">The name of the Color class.</param>
- /// <returns>The color object.</returns>
+ /// <param name="part">The name of color class.</param>
+ /// <returns>color object</returns>
/// <since_tizen> preview </since_tizen>
public override Color GetPartColor(string part)
{
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created.</returns>
+ /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the fill mode of the image border.
+ /// Enumeration for the fill mode of image border
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ImageBorderFillMode
{
/// <summary>
- /// None mode of the image border.
+ /// None mode of image border
/// </summary>
None,
/// <summary>
- /// Default mode of the image border.
+ /// Default mode of image border
/// </summary>
Default,
/// <summary>
- /// Solid mode of the image border.
+ /// Solid mode of image border
/// </summary>
Solid,
}
/// <summary>
- /// Enumeration for the possible orientation options.
+ /// Enumeration for the possible orientation options
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ImageOrientation : int
{
/// <summary>
- /// No orientation change.
+ /// No orientation change
/// </summary>
None = 0,
/// <summary>
- /// Rotate 90 degrees clockwise.
+ /// Rotate 90 degrees clockwise
/// </summary>
Rotate90,
/// <summary>
- /// Rotate 180 degrees clockwise.
+ /// Rotate 180 degrees clockwise
/// </summary>
Rotate180,
/// <summary>
- /// Rotate 90 degrees counter-clockwise (i.e., 270 degrees clockwise).
+ /// Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise)
/// </summary>
Rotate270,
/// <summary>
- /// Flip the image horizontally.
+ /// Flip image horizontally
/// </summary>
FlipHorizontal,
/// <summary>
- /// Flip the image vertically.
+ /// Flip image vertically
/// </summary>
FlipVertical,
/// <summary>
- /// Flip the image along the Y = (width - X) line (bottom-left to top-right).
+ /// Flip the image along the y = (width - x) line (bottom-left to top-right)
/// </summary>
FlipTranspose,
/// <summary>
- /// Flip the image along the Y = X line (top-left to bottom-right).
+ /// Flip the image along the y = x line (top-left to bottom-right)
/// </summary>
FlipTransverse
}
namespace ElmSharp
{
/// <summary>
- /// The Index widget gives you an index for fast access to whichever group of the other UI items one might have.
- /// Inherits Layout.
+ /// An index widget gives you an index for fast access to whichever group of other UI items one might have.
+ /// Inherits Layout
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Index : Layout
SmartEvent _delayedChanged;
/// <summary>
- /// Creates and initializes a new instance of the Index class.
+ /// Creates and initializes a new instance of Index class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Index(EvasObject parent) : base(parent)
{
public event EventHandler Changed;
/// <summary>
- /// Sets or gets whether the auto hiding feature is enabled or not for a given index widget.
+ /// Sets or gets the auto hiding feature is enabled or not for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoHide
}
/// <summary>
- /// Sets or gets a value whether the horizontal mode is enabled or not.
+ /// Sets or gets a value whether horizontal mode is enabled or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets a value of the indicator's disabled status.
+ /// Sets or gets the value of indicator's disabled status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IndicatorVisible
}
/// <summary>
- /// Sets or gets whether the omit feature is enabled or not for a given index widget.
+ /// Sets or gets the omit feature is enabled or not for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool OmitEnabled
}
/// <summary>
- /// Sets a delay change time for the index object.
- /// The delay time is 0.2 seconds by default.
+ /// Set a delay change time for index object.
+ /// delay time is 0.2 sec by default.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Delay
}
/// <summary>
- /// Controls the standard_priority group of the index.
- /// Priority group will be shown as many items as it can, and other group will be shown for one character only.
+ /// Control standard_priority group of index.
+ /// Priority group will be shown as many items as it can, and other group will be shown one character only.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Priority
}
/// <summary>
- /// Gets the last selected item for a given index widget.
+ /// Gets the last selected item, for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public IndexItem SelectedItem
}
/// <summary>
- /// Appends a new item on a given index widget.
+ /// Append a new item on a given index widget.
/// </summary>
- /// <param name="label">The label for which the item should be indexed.</param>
- /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+ /// <param name="label">the label which the item should be indexed</param>
+ /// <returns>A object to the IndexItem added or null, on errors</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem Append(string label)
{
}
/// <summary>
- /// Prepends a new item on a given index widget.
+ /// Prepend a new item on a given index widget.
/// </summary>
- /// <param name="label">The label for which the item should be indexed.</param>
- /// <returns>A handle to the item if added, or null on errors.</returns>
+ /// <param name="label">the label which the item should be indexed</param>
+ /// <returns>A handle to the item added or NULL, on errors</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem Prepend(string label)
{
}
/// <summary>
- /// Inserts a new item into the index object before the item before.
+ /// Insert a new item into the index object before item before.
/// </summary>
- /// <param name="label">The label for which the item should be indexed.</param>
+ /// <param name="label">the label which the item should be indexed</param>
/// <param name="before">The index item to insert after.</param>
- /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+ /// <returns>A object to the IndexItem added or null, on errors</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem InsertBefore(string label, IndexItem before)
{
}
/// <summary>
- /// Inserts a new item into the index object after the item after.
+ /// Insert a new item into the index object after item after.
/// </summary>
- /// <param name="label">The label for which the item should be indexed.</param>
+ /// <param name="label">the label which the item should be indexed</param>
/// <param name="after">The index item to insert after.</param>
- /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+ /// <returns>A object to the IndexItem added or null, on errors</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem InsertAfter(string label, IndexItem after)
{
}
/// <summary>
- /// Flushes the changes made to the index items so that they work correctly.
+ /// Flush the changes made to the index items so they work correctly.
/// </summary>
- /// <param name="level">The index level (one of 0 or 1) where the changes were made.</param>
+ /// <param name="level">The index level (one of 0 or 1) where changes were made</param>
/// <since_tizen> preview </since_tizen>
public void Update(int level)
{
}
/// <summary>
- /// Removes all the items from a given index widget.
+ /// Removes all items from a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The IndexItem is used to manage the index item.
- /// Inherits ItemObject.
+ /// The IndexItem is used to manage index item
+ /// Inherits ItemObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public class IndexItem : ItemObject
{
/// <summary>
- /// Creates and initializes a new instance of the IndexItem class.
+ /// Creates and initializes a new instance of IndexItem class.
/// </summary>
- /// <param name="text">The text is set to the Text. It's the 'string' type.</param>
+ /// <param name="text">the text is set to the Text. It's 'string' type.</param>
/// <since_tizen> preview </since_tizen>
public IndexItem(string text) : base(IntPtr.Zero)
{
}
/// <summary>
- /// Selected will be triggered when the index item is selected.
+ /// Selected will be triggered when the index item is selected
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
/// <summary>
- /// Gets the text.
+ /// Gets the text
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; private set; }
/// <summary>
/// Sets the selected state of an item.
/// </summary>
- /// <param name="selected">The selected state.</param>
+ /// <param name="selected">The selected state</param>
/// <since_tizen> preview </since_tizen>
public void Select(bool selected)
{
namespace ElmSharp
{
/// <summary>
- /// The ItemObject is used to manage the item object.
+ /// The ItemObject is used to manage item object
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ItemObject
EvasObject _trackObject = null;
/// <summary>
- /// Creates and initializes a new instance of the ItemObject class.
+ /// Creates and initializes a new instance of ItemObject class.
/// </summary>
/// <param name="handle">IntPtr</param>
/// <since_tizen> preview </since_tizen>
//}
/// <summary>
- /// Gets the ID of the item object.
+ /// Gets the id of item object
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Id { get; private set; }
/// <summary>
- /// Sets or gets whether the item object is enabled.
+ /// Sets or gets whether the item object is enabled
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsEnabled
}
/// <summary>
- /// Gets the track object of the item.
+ /// Gets track object of the item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject TrackObject
}
/// <summary>
- /// Sets or gets the style of the item.
+ /// Sets or gets the style of the Item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual string Style
}
/// <summary>
- /// Deleted will be triggered when the item object is deleted.
+ /// Deleted will be triggered when the item object is deleted
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// Deletes the item object.
+ /// Delete the item object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Delete()
}
/// <summary>
- /// Sets a content of an object item and deletes the old content.
+ /// Set a content of an object item and delete old content
/// </summary>
- /// <param name="part">The content part name (null for the default content).</param>
- /// <param name="content">The content of the object item.</param>
+ /// <param name="part">The content part name (null for the default content)</param>
+ /// <param name="content">The content of the object item</param>
/// <since_tizen> preview </since_tizen>
public void SetPartContent(string part, EvasObject content)
{
SetPartContent(part, content, false);
}
- /// <summary>.
- /// Sets a content of the object item.
+ /// <summary>
+ /// Set a content of an object item
/// </summary>
/// <param name="part">The content part name (null for the default content)</param>
- /// <param name="content">The content of the object item.</param>
- /// <param name="preserveOldContent">Judge whether to delete the old content.</param>
+ /// <param name="content">The content of the object item</param>
+ /// <param name="preserveOldContent">judge whether delete old content</param>
/// <since_tizen> preview </since_tizen>
public void SetPartContent(string part, EvasObject content, bool preserveOldContent)
{
}
/// <summary>
- /// Sets the label of the object item.
+ /// Set a label of an object item
/// </summary>
- /// <param name="part">The text part name (null for the default label).</param>
- /// <param name="text">Text of the label.</param>
+ /// <param name="part">The text part name (null for the default label)</param>
+ /// <param name="text">Text of the label</param>
/// <since_tizen> preview </since_tizen>
public void SetPartText(string part, string text)
{
}
/// <summary>
- /// Gets the label of the object item.
+ /// Gets a label of an object item
/// </summary>
- /// <param name="part">The text part name (null for the default label).</param>
+ /// <param name="part">The text part name (null for the default label)</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public string GetPartText(string part)
}
/// <summary>
- /// Sets the color of the object item.
+ /// Sets color of an object item
/// </summary>
- /// <param name="part">The text part name (null for the default label).</param>
- /// <param name="color">The color.</param>
+ /// <param name="part">The text part name (null for the default label)</param>
+ /// <param name="color">the color</param>
/// <since_tizen> preview </since_tizen>
public void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets the color of the object item.
+ /// Gets color of an object item
/// </summary>
- /// <param name="part">The text part name (null for the default label).</param>
- /// <returns>The color of an object item.</returns>
+ /// <param name="part">The text part name (null for the default label)</param>
+ /// <returns>the color of object item</returns>
/// <since_tizen> preview </since_tizen>
public Color GetPartColor(string part)
{
}
/// <summary>
- /// Deletes the color of the object item.
+ /// Deletes color of an object item
/// </summary>
- /// <param name="part">The text part name.</param>
+ /// <param name="part">The text part name</param>
/// <since_tizen> preview </since_tizen>
public void DeletePartColor(string part)
{
}
/// <summary>
- /// Adds a function for a signal emitted by the object item edje.
+ /// Add a function for a signal emitted by object item edje.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// Removes a signal-triggered function from the object item edje object.
+ /// Remove a signal-triggered function from a object item edje object.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// Gets the handle of the object item.
+ /// Gets the handle of object item
/// </summary>
/// <param name="obj">ItemObject</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// OnInvalidate of the object item.
+ /// OnInvalidate of object item
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInvalidate() { }
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
public override bool Equals(object obj)
{
IntPtr _parent = IntPtr.Zero;
/// <summary>
- /// Creates and initializes a new instance of the ItemEvasObject class.
+ /// Creates and initializes a new instance of ItemEvasObject class.
/// </summary>
/// <param name="parent">IntPtr</param>
public ItemEvasObject(IntPtr parent) : base()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
protected override IntPtr CreateHandle(EvasObject parent)
{
return Interop.Elementary.elm_object_item_track(_parent);
namespace ElmSharp
{
/// <summary>
- /// The ItemObjectExtension is used to manage the item object extension.
+ /// The ItemObjectExtension is used to manage item object extension
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class ItemObjectExtension
{
/// <summary>
- /// Grabs the highlight of the item object.
+ /// Grab high light of item object
/// </summary>
- /// <param name="obj">The item object, which has grabbed the highlight.</param>
+ /// <param name="obj">the item object which is grabbed high light</param>
/// <since_tizen> preview </since_tizen>
public static void GrabHighlight(this ItemObject obj)
{
}
/// <summary>
- /// Clears the highlight of the item object.
+ /// Clear high light of item object
/// </summary>
- /// <param name="obj">The item object, which has cleared the highlight.</param>
+ /// <param name="obj">the item object which is cleared high light</param>
/// <since_tizen> preview </since_tizen>
public static void ClearHighlight(this ItemObject obj)
{
namespace ElmSharp
{
/// <summary>
- /// The Label is a widget to display text, with a simple HTML-like markup.
- /// Inherits Layout.
+ /// Label is a widget to display text, with simple html-like markup.
+ /// Inherits Layout
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Label : Layout
SmartEvent _slideCompleted;
/// <summary>
- /// Creates and initializes a new instance of the Label class.
+ /// Creates and initializes a new instance of Label class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the Label as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Label as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Label(EvasObject parent) : base(parent)
{
public event EventHandler SlideCompleted;
/// <summary>
- /// Sets or gets the wrap width of the label.
+ /// Sets or gets wrap width of the label.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LineWrapWidth
}
/// <summary>
- /// Sets or gets the slide mode of the Label widget.
+ /// Sets or gets the slide mode of the label widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public LabelSlideMode SlideMode
}
/// <summary>
- /// Sets or gets the slide speed of the label.
+ /// Sets or gets the slide Speed of the label.
/// </summary>
/// <remarks>
/// The speed of the slide animation in px per seconds.
- /// If you set the duration of the slide using elm_label_slide_duration_set(), you cannot get the correct speed using this function until the label is actually rendered and resized.
+ /// If you set the duration of the slide using elm_label_slide_duration_set() you cannot get the correct speed using this function until the label is actually rendered and resized.
/// </remarks>
/// <seealso cref="SlideDuration"/>
/// <since_tizen> preview </since_tizen>
/// Sets or gets the style of the label text.
/// </summary>
/// <remarks>
- /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Available since Tizen_4.0.
+ /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0.
/// </remarks>
///
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Starts the slide effect.
+ /// Start slide effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void PlaySlide()
/// Sets the content at a part of a given container widget.
/// </summary>
/// <param name="parent">EvasObject</param>
- /// <returns>The new object, otherwise null if it cannot be created.</returns>
+ /// <returns>The new object, otherwise null if it cannot be created</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the slide modes of a label widget.
+ /// Enumeration for slide mode of a label widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum LabelSlideMode
{
/// <summary>
- /// No slide effect.
+ /// no slide effect
/// </summary>
None = 0,
/// <summary>
- /// Slide only if the label area is bigger than the text width length.
+ /// slide only if the label area is bigger than the text width length
/// </summary>
Auto,
/// <summary>
- /// Slide always.
+ /// slide always
/// </summary>
Always
}
namespace ElmSharp
{
/// <summary>
- /// This is a container widget that takes a standard edje design file and wraps it very thinly in a widget.
- /// Inherits Widget.
+ /// This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget.
+ /// Inherits Widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Layout : Container
IntPtr _edjeHandle;
/// <summary>
- /// Creates and initializes a new instance of the Layout class.
+ /// Creates and initializes a new instance of Layout class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the layout as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by Layout as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Layout(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of the Layout class.
+ /// Creates and initializes a new instance of Layout class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Layout() : base()
}
/// <summary>
- /// Gets or sets the accessibility state of texblock (text) parts in a layout object.
+ /// Gets or sets accessibility state of texblock(text) parts in the layout object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool TextBlockAccessibility
/// <summary>
/// Freezes the Elementary layout object.
- /// This function puts all the changes on hold.
+ /// This function puts all changes on hold.
/// Successive freezes will nest, requiring an equal number of thaws.
/// </summary>
- /// <returns>The frozen state, or 0 if the object is not frozen or on error.</returns>
+ /// <returns>The frozen state or 0 if the object is not frozen or on error.</returns>
/// <since_tizen> preview </since_tizen>
public int Freeze()
{
/// Thaws the Elementary object.
/// If sucessives freezes were done, an equal number of thaws will be required.
/// </summary>
- /// <returns>The frozen state, or 0 if the object is not frozen or on error.</returns>
+ /// <returns>The frozen state or 0 if the object is not frozen or on error.</returns>
/// <since_tizen> preview </since_tizen>
public int Thaw()
{
/// Manually forces a sizing re-evaluation.
/// This is useful when the minimum size required by the edje theme of this layout has changed.
/// The change on the minimum size required by the edje theme is not immediately reported to the elementary layout, so one needs to call this function in order to tell the widget (layout) that it needs to reevaluate its own size.
- /// The minimum size of the theme is calculated based on the minimum size of parts, the size of elements inside containers like the box and table, etc.
+ /// The minimum size of the theme is calculated based on minimum size of parts, the size of elements inside containers like box and table, etc.
/// All of this can change due to state changes, and that's when this function should be called.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Requests sizing re-evaluation, restricted to the current width and/or height.
- /// Useful mostly when there are TEXTBLOCK parts defining the height of an object and nothing else, restricting it to a minimum width. Calling this function will restrict minimum size in the Edje calculation to whatever size the layout has at the moment.
+ /// Request sizing reevaluation, restricted to current width and/or height.
+ /// Useful mostly when there are TEXTBLOCK parts defining the height of the object and nothing else restricting it to a minimum width.Calling this function will restrict the minimum size in the Edje calculation to whatever size it the layout has at the moment.
/// </summary>
- /// <param name="width">Restrict minimum size of the current width.</param>
- /// <param name="height">Restrict minimum size of the current height.</param>
+ /// <param name="width">Restrict minimum size ot the current width.</param>
+ /// <param name="height">Restrict minimum size ot the current height.</param>
/// <since_tizen> preview </since_tizen>
public void Resizing(bool width, bool height)
{
}
/// <summary>
- /// Gets the edje data from the given layout.
- /// This function fetches the data specified inside the edje theme of this layout.
- /// This function returns null if the data is not found.
+ /// Get the edje data from the given layout.
+ /// This function fetches data specified inside the edje theme of this layout.
+ /// This function return NULL if data is not found.
/// </summary>
- /// <param name="key">The data key.</param>
- /// <returns>The data.</returns>
+ /// <param name="key">The data key</param>
+ /// <returns>The data</returns>
/// <since_tizen> preview </since_tizen>
public string GetEdjeData(string key)
{
/// <summary>
/// Gets the text set in the given part.
/// </summary>
- /// <param name="part">The text part to retrieve the text off.</param>
+ /// <param name="part">The TEXT part to retrieve the text off.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public override string GetPartText(string part)
/// <summary>
/// Sets the text set in the given part.
/// </summary>
- /// <param name="part">The text part to retrieve the text off.</param>
+ /// <param name="part">The TEXT part to retrieve the text off.</param>
/// <param name="text">The text to set.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Appends a child to the layout box part.
- /// Once the object is appended, it will become a child of the layout.
- /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
+ /// Append child to layout box part.
+ /// Once the object is appended, it will become child of the layout.
+ /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="child">The object to append.</param>
- /// <returns>Success is true.</returns>
+ /// <param name="part">The part</param>
+ /// <param name="child">The Object to append</param>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxAppend(string part, EvasObject child)
{
}
/// <summary>
- /// Prepends a child to the layout box part.
- /// Once the object is prepended, it will become a child of the layout.
- /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
+ /// Prepend child to layout box part.
+ /// Once the object is prepended, it will become child of the layout.
+ /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="child">The object to prepend.</param>
- /// <returns>Success is true.</returns>
+ /// <param name="part">The part</param>
+ /// <param name="child">The Object to prepend</param>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxPrepend(string part, EvasObject child)
{
}
/// <summary>
- /// Removes a child from the given part box.
+ /// Remove a child of the given part box.
/// The object will be removed from the box part and its lifetime will not be handled by the layout anymore.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="child">The object to remove.</param>
- /// <returns>Success if true</returns>
+ /// <param name="part">The part</param>
+ /// <param name="child">The Object to remove</param>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxRemove(string part, EvasObject child)
{
}
/// <summary>
- /// Removes all the children from the given part box.
+ /// Remove all children of the given part box.
/// The objects will be removed from the box part and their lifetime will not be handled by the layout anymore.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="clear">If true, then all the objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas.</param>
- /// <returns>Success if true.</returns>
+ /// <param name="part">The part</param>
+ /// <param name="clear">If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas.</param>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxRemoveAll(string part, bool clear)
{
}
/// <summary>
- /// Inserts a child to the layout box part at a given position.
- /// Once the object is inserted, it will become a child of the layout.
- /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
+ /// Insert child to layout box part at a given position.
+ /// Once the object is inserted, it will become child of the layout.
+ /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="child">The child object to insert into the box.</param>
+ /// <param name="part">The part</param>
+ /// <param name="child">The child object to insert into box.</param>
/// <param name="position">The numeric position >=0 to insert the child.</param>
- /// <returns>Success if true.</returns>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxInsertAt(string part, EvasObject child, uint position)
{
}
/// <summary>
- /// Inserts a child to the layout box part before a reference object.
+ /// Insert child to layout box part before a reference object.
/// Once the object is inserted, it will become child of the layout.
- /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
+ /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part.</param>
- /// <param name="child">The child object to insert into the box.</param>
- /// <param name="reference">Another reference object to insert before the box.</param>
- /// <returns>Success is true.</returns>
+ /// <param name="part"></param>
+ /// <param name="child">The child object to insert into box.</param>
+ /// <param name="reference">Another reference object to insert before in box.</param>
+ /// <returns>Sucess is true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxInsertBefore(string part, EvasObject child, EvasObject reference)
{
/// <summary>
/// Sets the layout content.
/// </summary>
- /// <param name="part">The swallow part name in the edje file.</param>
+ /// <param name="part">The swallow part name in the edje file</param>
/// <param name="content">The child that will be added in this layout object.</param>
- /// <returns>TRUE on success, FALSE otherwise.</returns>
+ /// <returns>TRUE on success, FALSE otherwise</returns>
/// <since_tizen> preview </since_tizen>
public override bool SetPartContent(string part, EvasObject content)
{
/// <summary>
/// Sets the layout content.
/// </summary>
- /// <param name="part">The name of a particular part.</param>
- /// <param name="content">The content.</param>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="content">The content</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
- /// <returns>TRUE on success, FALSE otherwise.</returns>
+ /// <returns>TRUE on success, FALSE otherwise</returns>
/// <since_tizen> preview </since_tizen>
public override bool SetPartContent(string part, EvasObject content, bool preserveOldContent)
{
/// <summary>
/// Sets the edje group from the elementary theme that is used as a layout.
/// </summary>
- /// <param name="klass">The class of the group.</param>
- /// <param name="group">The group.</param>
- /// <param name="style">The style to use.</param>
+ /// <param name="klass">The class of the group</param>
+ /// <param name="group">The group</param>
+ /// <param name="style">The style to use</param>
/// <since_tizen> preview </since_tizen>
public void SetTheme(string klass, string group, string style)
{
/// <summary>
/// Sets the file that is used as a layout.
/// </summary>
- /// <param name="file">The path to the file (edje) that is used as a layout.</param>
- /// <param name="group">The group that the layout belongs to in the edje file.</param>
+ /// <param name="file">The path to the file (edj) that is used as a layout</param>
+ /// <param name="group">The group that the layout belongs to in the edje file</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, string group)
{
}
/// <summary>
- /// Sets the background color of a layout.
+ /// Sets the back ground color of layout
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
}
/// <summary>
- /// Sets the vertical text alignment of the layout's text part.
+ /// Sets the vertical text alignment of layout's text part
/// </summary>
/// <remarks>
- /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Available since Tizen_4.0.
+ /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public virtual void SetVerticalTextAlignment(string part, double valign)
}
/// <summary>
- /// Gets the vertical text alignment of the layout's text part.
+ /// Gets the vertical text alignment of layout's text part
/// </summary>
/// <remarks>
- /// API, elm_layout_text_valign_get, is an internal API only in Tizen. Available since Tizen_4.0.
+ /// API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public virtual double GetVerticalTextAlignment(string part)
}
/// <summary>
- /// The callback of the Realized Event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by the layout as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created.</returns>
+ /// <param name="parent">The parent is a given container which will be attached by Layout as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for setting the list's resizing behavior, transverse axis scrolling, and items cropping.
+ /// Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ListMode
/// <summary>
/// The list won't set any of its size hints to inform how a possible container should resize it.
/// Then, if it's not created as a "resize object", it might end with zeroed dimensions.
- /// The list will respect the container's geometry, and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
+ /// The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
/// </summary>
Compress = 0,
/// <summary>
/// </summary>
Scroll,
/// <summary>
- /// Sets a minimum size hint on the genlist object, so that the containers may respect it (and resize itself to fit the child properly).
+ /// Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly).
/// More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well.
/// This is naturally bound by the list object's maximum size hints, set externally.
/// </summary>
Limit,
/// <summary>
- /// Besides setting a minimum size on the transverse axis, just like on limit, the list will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time.
+ /// Besides setting a minimum size on the transverse axis, just like on Limit, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.
/// This is naturally bound by the list object's maximum size hints, set externally.
/// </summary>
Expand
/// <summary>
/// It inherits System.EventArgs.
- /// It contains an item which is <see cref="ListItem"/> type.
- /// All the events of a list contain ListItemEventArgs as a parameter.
+ /// It contains Item which is <see cref="ListItem"/> type.
+ /// All events of List contain ListItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ListItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets the list item. The return type is <see cref="ListItem"/>.
+ /// Gets or sets List item. The return type is <see cref="ListItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ListItem Item { get; set; }
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The List is a widget that aims to display a simple list item which has 2 icons, 1 text, and can be selected.
+ /// The List is a widget that aims to display simple list item which has 2 icons and 1 text, and can be selected.
/// For more robust lists, <see cref="GenList"/> should probably be used.
/// </summary>
/// <seealso cref="GenList"/>
/// <summary>
/// Creates and initializes a new instance of the List class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the list as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by List as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public List(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Gets or sets which mode to be used for the list.
+ /// Gets or sets which mode to use for the list.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ListMode Mode
public event EventHandler<ListItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when a list item is Unselected.
+ /// ItemUnselected is raised when the list item is Unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemUnselected;
/// <summary>
- /// ItemDoubleClicked is raised when a new list item is double-clicked.
+ /// ItemDoubleClicked is raised when a new list item is double clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemDoubleClicked;
/// <summary>
- /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default, it's 1 second.
+ /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemLongPressed;
/// <summary>
- /// ItemActivated is raised when a new list item is double-clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemActivated;
/// <summary>
/// Starts the list.
- /// Called before running <see cref="EvasObject.Show"/> on the list object.
+ /// Call before running <see cref="EvasObject.Show"/> on the list object.
/// If not called, it won't display the list properly.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all the items from a given list widget.
+ /// Removes all items from a given list widget.
/// To delete just one item, use <see cref="ItemObject.Delete"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// An instance to the list item is added.
- /// It contains the Text, LeftIcon, and RightIcon properties to show the list item which is given.
+ /// A instance to the list item added.
+ /// It contains Text, LeftIcon and RightIcon properties to show a list item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ListItem : ItemObject
{
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The MultiButtonEntry is a widget, that lets a user enter text and each chunk of the text managed as a set of buttons.
+ /// The MultiButtonEntry is a widget letting an user enter text and each chunk of text managed as a set of buttons.
/// Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row.
/// When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line.
/// The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions.
/// <summary>
/// Creates and initializes a new instance of the MultiButtonEntry class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntry(EvasObject parent) : base(parent)
{
public event EventHandler ExpandedStateChanged;
/// <summary>
- /// ItemSelected is raised when an item is selected by API, user interaction, and etc.
- /// This is also raised when a user presses backspace, while the cursor is on the first field of the entry.
+ /// ItemSelected is raised when an item is selected by api, user interaction, and etc.
+ /// This is also raised when a user press back space while cursor is on the first field of entry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<MultiButtonEntryItemEventArgs> ItemSelected;
public event EventHandler<MultiButtonEntryItemEventArgs> ItemDeleted;
/// <summary>
- /// Gets the selected item in the MultiButtonEntry.
+ /// Gets the selected item in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem SelectedItem
}
/// <summary>
- /// Gets or sets whether the MultiButtonEntry is editable or not.
+ /// Gets or sets whether the multibuttonentry is editable or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsEditable
}
/// <summary>
- /// Gets or sets the MultiButtonEntry to expanded state.
+ /// Gets or sets the multibuttonentry to expanded state.
/// If true, expanded state.
/// If false, single line state.
/// </summary>
}
/// <summary>
- /// Gets the first item in the MultiButtonEntry.
+ /// Gets the first item in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem FirstItem
}
/// <summary>
- /// Gets the last item in the MultiButtonEntry.
+ /// Gets the last item in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem LastItem
}
/// <summary>
- /// Gets the entry object int the MultiButtonEntry.
+ /// Gets the entry object int the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Entry Entry
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Appends a new item to the multibuttonentry.
+ /// Append a new item to the multibuttonentry.
/// </summary>
- /// <param name="label">The label of the new item.</param>
+ /// <param name="label">The label of new item.</param>
/// <returns>A MultiButtonEntryItem to the item added.</returns>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Append(string label)
}
/// <summary>
- /// Prepends a new item to the MultiButtonEntry.
+ /// Prepend a new item to the multibuttonentry.
/// </summary>
- /// <param name="label">The label of the new item.</param>
+ /// <param name="label">The label of new item.</param>
/// <returns>A MultiButtonEntryItem to the item added.</returns>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Prepend(string label)
}
/// <summary>
- /// Adds a new item to the MultiButtonEntry before the indicated object reference.
+ /// Add a new item to the multibuttonentry before the indicated object reference.
/// </summary>
/// <param name="before">The item before which to add it.</param>
/// <param name="label">The label of new item.</param>
}
/// <summary>
- /// Adds a new item to the MultiButtonEntry after the indicated object.
+ /// Add a new item to the multibuttonentry after the indicated object.
/// </summary>
/// <param name="after">The item after which to add it.</param>
/// <param name="label">The label of new item.</param>
}
/// <summary>
- /// Removes all items in the MultiButtonEntry.
+ /// Remove all items in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
}
/// <summary>
- /// Appends an item filter function for the text inserted in the multibuttonentry.
+ /// Append an item filter function for text inserted in the Multibuttonentry.
/// </summary>
/// <param name="func">The function to use as item filter.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepends a filter function for the text inserted in the MultiButtonEntry.
+ /// Prepend a filter function for text inserted in the Multibuttonentry.
/// </summary>
/// <param name="func">The function to use as text filter.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes a filter from the list.
+ /// Remove a filter from the list.
/// </summary>
/// <param name="func">The filter function to remove.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets a function to format the string that will be used to display the hidden items counter.
+ /// Set a function to format the string that will be used to display the hidden items counter.
/// If func is NULL, the default format will be used, which is "+ 'the hidden items counter'".
/// </summary>
- /// <param name="func">The function to return string to show.</param>
+ /// <param name="func">The function to return string to show</param>
/// <since_tizen> preview </since_tizen>
public void SetFormatCallback(Func<int, string> func)
{
/// <summary>
/// Creates and initializes a new instance of the EntryInner class.
/// </summary>
- /// <param name="parent">The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
internal EntryInner(EvasObject parent) : base(parent)
{
}
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
protected override IntPtr CreateHandle(EvasObject parent)
{
return Interop.Elementary.elm_multibuttonentry_entry_get(parent.Handle);
/// <summary>
/// It inherits System.EventArgs.
/// The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry.
- /// It contains the Item which is <see cref="MultiButtonEntryItem"/> type.
+ /// It contains Item which is <see cref="MultiButtonEntryItem"/> type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MultiButtonEntryItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets the MultiButtonEntryItem item. The return type is <see cref="MultiButtonEntryItem"/>.
+ /// Gets or sets MultiButtonEntryItem item. The return type is <see cref="MultiButtonEntryItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Item { get; set; }
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// MutltiButtonEntryItem is an item, which is added to MultiButtonEntry.
- /// It contains Next and Prev properties to get the next and previous item.
+ /// MutltiButtonEntryItem is a item which is added to MultiButtonEntry.
+ /// It contains Next and Prev properties to get next and previous item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MultiButtonEntryItem : ItemObject
/// <summary>
/// Creates and initializes a new instance of the MultiButtonEntryItem class.
/// </summary>
- /// <param name="text">The text of the MultiButtonEntryItem's label name.</param>
+ /// <param name="text">The text of MultiButtonEntryItem's Label name.</param>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem(string text) : base(IntPtr.Zero)
{
}
/// <summary>
- /// Get the next item in the MultiButtonEntry.
+ /// Get the next item in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Next
}
/// <summary>
- /// Get the previous item in the MultiButtonEntry.
+ /// Get the previous item in the multibuttonentry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Prev
namespace ElmSharp
{
/// <summary>
- /// Predefined values for the hint properties in EvasObject.
+ /// Predefined values for Hints properties in EvasObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class NamedHint
{
/// <summary>
- /// This value can be used for <see cref="EvasObject.WeightX"/> and <see cref="EvasObject.WeightY"/>.
+ /// This value can be used to <see cref="EvasObject.WeightX"/> and <see cref="EvasObject.WeightY"/>
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double Expand = 1.0;
/// <summary>
- /// This value can be used for <see cref="EvasObject.AlignmentX"/> and <see cref="EvasObject.AlignmentY"/>.
+ /// This value can be used to <see cref="EvasObject.AlignmentX"/> and <see cref="EvasObject.AlignmentY"/>
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double Fill = -1.0;
namespace ElmSharp
{
/// <summary>
- /// The NaviItem is a widget that contain the contents to show in Naviframe.
+ /// The NaviItem is a widget to contain the contents to show in Naviframe.
/// Inherits ItemObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Popped;
/// <summary>
- /// Gets the content object. The name of the content part is "elm.swallow.content".
+ /// Gets the content object. The name of content part is "elm.swallow.content".
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Content
}
/// <summary>
- /// Sets or gets a value whether the title area is enabled or not.
+ /// Sets or gets a value whether title area is enabled or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool TitleBarVisible
}
/// <summary>
- /// Sets or gets the title bar background color.
+ /// Sets or gets the title bar background color
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color TitleBarBackgroundColor
}
/// <summary>
- /// Invalidates the EventArgs if _isPopped is false.
- /// The method should be overridden in the children class.
+ /// Invalidate the EventArgs if _isPopped is false.
+ /// The method should be overridden in children class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnInvalidate()
namespace ElmSharp
{
/// <summary>
- /// The NaviframeEventArgs is an event arguments class for naviframe.
- /// Inherits EventArgs.
+ /// The NaviframeEventArgs is a event args class for navi frame.
+ /// Inherits EventArgs
/// </summary>
/// <since_tizen> preview </since_tizen>
public class NaviframeEventArgs : EventArgs
{
/// <summary>
- /// Sets or gets the content object. The name of the content part is "elm.swallow.content".
+ /// Sets or gets the content object. The name of content part is "elm.swallow.content".
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Content { get; set; }
}
/// <summary>
- /// The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications.
- /// Inherits Widget.
+ /// Naviframe is a widget to stands for navigation frame. It's a views manager for applications.
+ /// Inherits Widget
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Naviframe : Widget
readonly List<NaviItem> _itemStack = new List<NaviItem>();
/// <summary>
- /// Creates and initializes a new instance of the Naviframe class.
+ /// Creates and initializes a new instance of Naviframe class.
/// </summary>
/// <param name="parent">The parent is a given container which will be attached by Naviframe as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Popped will be triggered when the NaviItem is removed.
+ /// Popped will be triggered when NaviItem is removed.
/// </summary>
/// <remarks>
- /// It is always called when the NaviItem is removed.
+ /// It is always called when NaviItem was removed.
/// (even if removed by NaviItem.Delete())
- /// This event will be invoked in progress of the Pop/Delete operation.
- /// After calling the Popped event, the Pop/Delete method will be returned.
+ /// This event will be invoked in progress of Pop/Delete operation.
+ /// After called Popped event, Pop/Delete method will be returned
/// </remarks>
/// <since_tizen> preview </since_tizen>
public event EventHandler<NaviframeEventArgs> Popped;
/// <summary>
- /// AnimationFinished will be triggered when the animation is finished.
+ /// AnimationFinished will be triggered when animation is finished.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler AnimationFinished;
/// <summary>
- /// Gets the list of the navi item.
+ /// Gets the list of navi item
/// </summary>
/// <since_tizen> preview </since_tizen>
public IReadOnlyList<NaviItem> NavigationStack
}
/// <summary>
- /// Sets or gets the preserve content objects when items are popped.
+ /// Sets or gets the the preserve content objects when items are popped.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool PreserveContentOnPop
}
/// <summary>
- /// Sets or gets whether the default back button is enabled.
+ /// Sets or gets whether the default back button is enabled
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool DefaultBackButtonEnabled
}
/// <summary>
- /// Pushes a new item to the top of the naviframe stack and shows it.
+ /// Push a new item to the top of the naviframe stack and show it.
/// The title and style are null.
/// </summary>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content)
{
}
/// <summary>
- /// Pushes a new item to the top of the naviframe stack and shows it.
- /// The style is null.
+ /// Push a new item to the top of the naviframe stack and show it.
+ /// The style are null.
/// </summary>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content, string title)
}
/// <summary>
- /// Pushes a new item to the top of the naviframe stack and shows it.
+ /// Push a new item to the top of the naviframe stack and show it.
/// </summary>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
- /// <param name="style">The current item style name. Null would be default.</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
+ /// <param name="style">The current item style name. null would be default.</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content, string title, string style)
{
}
/// <summary>
- /// Inserts a new item into the naviframe before the item.
+ /// Insert a new item into the naviframe before item.
/// The title is "" and the style is null.
/// </summary>
- /// <param name="before">The item for which a new item is inserted before.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="before">The item which the new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content)
{
}
/// <summary>
- /// Inserts a new item into the naviframe before the item.
+ /// Insert a new item into the naviframe before item.
/// The style is null.
/// </summary>
- /// <param name="before">The item for which a new item is inserted before.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="before">The item which the new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content, string title)
{
}
/// <summary>
- /// Inserts a new item into the naviframe before the item.
+ /// Insert a new item into the naviframe before item.
/// </summary>
- /// <param name="before">The item for which a new item is inserted before.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
- /// <param name="style">The current item style name. Null would be default.</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="before">The item which the new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
+ /// <param name="style">The current item style name. null would be default.</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style)
{
}
/// <summary>
- /// Inserts a new item into the naviframe after the item.
+ /// Insert a new item into the naviframe after item.
/// The title is "" and the style is null.
/// </summary>
- /// <param name="after">The item for which a new item is inserted after.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="after">The item which the new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content)
{
}
/// <summary>
- /// Inserts a new item into the naviframe after the item.
+ /// Insert a new item into the naviframe after item.
/// The style is null.
/// </summary>
- /// <param name="after">The item which a new item is inserted after.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="after">The item which the new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content, string title)
{
}
/// <summary>
- /// Inserts a new item into the naviframe after the item.
+ /// Insert a new item into the naviframe after item.
/// </summary>
- /// <param name="after">The item for which a new item is inserted after.</param>
- /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. Null would be default.</param>
- /// <param name="style">The current item style name. Null would be default.</param>
- /// <returns>The created item, or null upon failure.</returns>
+ /// <param name="after">The item which the new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. null would be default.</param>
+ /// <param name="style">The current item style name. null would be default.</param>
+ /// <returns>The created item or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style)
{
}
/// <summary>
- /// Pops an item that is on top of the stack.
+ /// Pop an item that is on top of the stack.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Pop()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the PanelDirection types.
+ /// Enumeration for paneldirection type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum PanelDirection
{
/// <summary>
- /// Top to bottom.
+ /// Top to bottom
/// </summary>
Top = 0,
/// <summary>
- /// Bottom to top.
+ /// Bottom to top
/// </summary>
Bottom,
/// <summary>
- /// Left to right.
+ /// Left to right
/// </summary>
Left,
/// <summary>
- /// Right to left.
+ /// Right to left
/// </summary>
Right,
}
SmartEvent _toggled;
/// <summary>
- /// Creates and initializes a new instance of the Panel class.
+ /// Creates and initializes a new instance of Panel class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new panel will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new Panel will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Panel(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Toggled will be triggered when the panel is toggled.
+ /// Toggled will be triggered when toggles Panel.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Toggled;
/// <summary>
- /// Enable or disable scrolling in the panel.
+ /// Enable or disable scrolling in the Panel.
/// </summary>
/// <param name="enable">
/// Bool value can be false or true.
}
/// <summary>
- /// Sets the scroll size of the panel.
+ /// Sets the scroll size of Panel.
/// </summary>
/// <param name="ratio">
- /// The size of the scroll area.
+ /// The size of scroll area.
/// </param>
/// <since_tizen> preview </since_tizen>
public void SetScrollableArea(double ratio)
}
/// <summary>
- /// Toggles the hidden state of the panel.
+ /// Toggles the hidden state of the Panel.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Toggle()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// The Panes is a widget that adds a draggable bar between two contents.
- /// When dragged, this bar resizes the contents' size.
+ /// When dragged this bar resizes contents' size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Panes : Layout
}
/// <summary>
- /// Pressed will be triggered when the panes have been pressed (button isn't released yet).
+ /// Pressed will be triggered when panes have been pressed (button isn't released yet).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Pressed;
/// <summary>
- /// Unpressed will be triggered when the panes are released after being pressed.
+ /// Unpressed will be triggered when panes are released after being pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Unpressed;
/// <summary>
- /// Sets or gets the resize mode of a given Panes widget.
+ /// Sets or gets resize mode of a given Panes widget.
/// True means the left and right panes resize homogeneously.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the size proportion of the Panes widget's left side.
+ /// Sets or Gets the size proportion of the Panes widget's left side.
/// </summary>
/// <remarks>
- /// By default, it's homogeneous, i.e., both sides have the same size. If something different is required,
+ /// By default it's homogeneous, i.e., both sides have the same size.If something different is required,
/// it can be set with this function. For example, if the left content should be displayed over 75% of the panes size,
- /// the size should be passed as 0.75. This way, the right content is resized to 25% of the panes size.
- /// If displayed vertically, left content is displayed at the top and right content at the bottom.
+ /// size should be passed as 0.75. This way, the right content is resized to 25% of the panes size.
+ /// If displayed vertically, left content is displayed at the top, and right content at the bottom.
/// This proportion changes when the user drags the panes bar.
///
- /// The float type value between 0.0 and 1.0 represents the size proportion of the left side.
+ /// The value is float type and between 0.0 and 1.0 representing the size proportion of the left side.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Proportion
/// Sets or gets the orientation of a given Panes widget.
/// </summary>
/// <remarks>
- /// Use this function to change how your panes are to be disposed: vertically or horizontally.
+ /// Use this function to change how your panes is to be disposed: vertically or horizontally.
/// Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents.
- /// By default, the panes are in a vertical mode.
+ /// By default panes is in a vertical mode.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
/// <summary>
/// Sets or gets the absolute minimum size of panes widget's left side.
- /// If displayed vertically, left content is displayed at the top.
- /// The value represents minimum size of the left side in pixels.
+ /// If displayed vertically, left content is displayed at top.
+ /// value representing minimum size of left side in pixels.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LeftMinimumSize
}
/// <summary>
- /// Sets or gets the relative minimum size of the panes widget's left side.
- /// The proportion of minimum size of the left side.
- /// If displayed vertically, left content is displayed at the top.
- /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the left side.
+ /// Sets or gets the relative minimum size of panes widget's left side.
+ /// proportion of minimum size of left side.
+ /// If displayed vertically, left content is displayed at top.
+ /// value between 0.0 and 1.0 representing size proportion of minimum size of left side.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LeftMinimumRelativeSize
}
/// <summary>
- /// Sets or gets the absolute minimum size of the panes widget's right side.
- /// If displayed vertically, right content is displayed at the top.
- /// The value represents the minimum size of the right side in pixels.
+ /// Sets or gets the absolute minimum size of panes widget's right side.
+ /// If displayed vertically, right content is displayed at top.
+ /// value representing minimum size of right side in pixels.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int RightMinimumSize
}
/// <summary>
- /// Sets or gets the relative minimum size of the panes widget's right side.
- /// Proportion of the minimum size of the right side.
- /// If displayed vertically, right content is displayed at the top.
- /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the right side.
+ /// Sets or gets the relative minimum size of panes widget's right side.
+ /// proportion of minimum size of right side.
+ /// If displayed vertically, right content is displayed at top.
+ /// value between 0.0 and 1.0 representing size proportion of minimum size of right side.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RightMinimumRelativeSize
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Point is a struct that defines the 2D point as a pair of generic type.
+ /// The Point is a struct that defines a 2-D point as a pair of generic type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Point : IEquatable<Point>
public int Y;
/// <summary>
- /// A human readable representation of <see cref="T:Tizen.UI.Point"/>.
+ /// A human-readable representation of the <see cref="T:Tizen.UI.Point" />.
/// </summary>
/// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the hash code.
+ /// Gets hash code.
/// </summary>
/// <returns>The hash code.</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Point"/> to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Point other)
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Point"/>s are equal.
+ /// Whether the two <see cref="T:Tizen.UI.Point" />s are equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point"/> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Point"/>s have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Point p1, Point p2)
{
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Point"/>s are not equal.
+ /// Whether two <see cref="T:Tizen.UI.Point" />s are not equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point"/> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Point"/>s do not have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Point p1, Point p2)
{
namespace ElmSharp
{
/// <summary>
- /// The Point3D is a struct that defines a 3D point.
+ /// The Point3D is a Struct that defining a 3-D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Point3D : IEquatable<Point3D>
{
/// <summary>
- /// The X-coordinate of a 3D point.
+ /// The X coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int X;
/// <summary>
- /// The Y-coordinate of a 3D point.
+ /// The Y coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Y;
/// <summary>
- /// The Z-coordinate of a 3D point.
+ /// The Z coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Z;
/// <summary>
- /// A human-readable representation of <see cref="T:Tizen.UI.Point3D"/>.
+ /// 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>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Point3D"/> to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value.
+ /// true if obj and this instance are the same type and represent the same value.
/// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Point3D"/>s are equal.
+ /// Whether the two <see cref="T:Tizen.UI.Point3D" />s are equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point3D"/> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point3D"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Point3D"/>s have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Point3D p1, Point3D p2)
{
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Point3D"/>s are not equal.
+ /// Whether two <see cref="T:Tizen.UI.Point3D" />s are not equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point3D"/> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point3D"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Point3D"/>s do not have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Point3D p1, Point3D p2)
{
namespace ElmSharp
{
/// <summary>
- /// The Polygon is a widget that is used to draw a polygon (filled).
+ /// The Polygon is a widget that used to draw a polygon (filled).
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Polygon : EvasObject
}
/// <summary>
- /// Adds a new vertex to the polygon.
- /// <param name="x">The X-coordinate of the new vertex.</param>
- /// <param name="y">The Y-coordinate of the new vertex.</param>
+ /// Adds a new vertex to the Polygon.
+ /// <param name="x">The X coordinate of the new vertex.</param>
+ /// <param name="y">The Y coordinate of the new vertex.</param>
/// </summary>
/// <since_tizen> preview </since_tizen>
public void AddPoint(int x, int y)
}
/// <summary>
- /// Adds a new vertex to the polygon.
+ /// Adds a new vertex to the Polygon.
/// <param name="p">The coordinates of the new vertex.</param>
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all the vertices of the polygon, making it empty.
+ /// Removes all the vertices of the Polygon, making it empty.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearPoints()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the popup orientation types.
+ /// Enumeration for the popup orientation type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum PopupOrientation
{
/// <summary>
- /// Appears in the top of parent, by default.
+ /// Appears in the top of parent, 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>
/// <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>
public Popup(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Dismissed will be triggered when the popup has been dismissed.
+ /// Dismissed will be triggered when Popup have been dismissed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
public event EventHandler OutsideClicked;
/// <summary>
- /// OutsideClicked will be triggered when the popup is closed as a result of timeout.
+ /// OutsideClicked will be triggered when Popup is closed as a result of timeout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler TimedOut;
/// <summary>
- /// OutsideClicked will be triggered when the popup transition has finished in showing.
+ /// OutsideClicked will be triggered when the Popup transition is finished in showing.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ShowAnimationFinished;
/// <summary>
- /// Sets or gets the position in which the popup will appear in its parent.
+ /// Sets or gets the position in which Popup will appear in its parent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public PopupOrientation Orientation
}
/// <summary>
- /// Sets or gets the wrapping type of content text packed in the content area of Popup widget.
+ /// Sets or gets the wrapping type of content text packed in content area of Popup widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WrapType ContentTextWrapType
}
/// <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,]]>
+ /// 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 > 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>
}
/// <summary>
- /// Sets or gets whether events should be passed to the event blocked area by a click outside.
+ /// Sets or gets whether events should be passed to event blocked area by a click outside.
/// </summary>
/// <remarks>
- /// The visible region of the popup is surrounded by a translucent region called the Blocked event area.
+ /// The visible region of popup is surrounded by a translucent region called Blocked Event area.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool AllowEvents
}
/// <summary>
- /// Gets the opacity value of the popup.
+ /// Gets the Opacity value of the Popup.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Adds the label to a Popup widget.
+ /// Adds label to a Popup widget.
/// </summary>
/// <param name="label"></param>
- /// <returns>The new PopupItem which contains a label.</returns>
+ /// <returns>The new PopupItem which contains label .</returns>
/// <since_tizen> preview </since_tizen>
public PopupItem Append(string label)
{
}
/// <summary>
- /// Adds the Label and icon to a Popup widget.
+ /// Adds 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 the 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 label and icon.</returns>
/// <since_tizen> preview </since_tizen>
public PopupItem Append(string label, EvasObject icon)
{
/// <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>
public void Dismiss()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The PopupItem is a class that includes the icon and text.
+ /// The PopupItem is a class that including icon and text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class PopupItem : ItemObject
}
/// <summary>
- /// Gets the text label of the popupitem. Return value is string.
+ /// Gets the text label of popupitem.Return value is string.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; internal set; }
/// <summary>
- /// Gets the EvasObject icon of the popupitem.
+ /// Gets the icon EvasObject of popupitem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Icon { get; internal set; }
namespace ElmSharp
{
/// <summary>
- /// The ProgressBar is a widget for visually representing the progress status of a given job or task.
+ /// The ProgressBar is a widget for visually representing the progress status of a given job/task.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ProgressBar : Layout
}
/// <summary>
- /// ValueChanged will be triggered when the value of the ProgressBar changes.
+ /// ValueChanged will be triggered when value of ProgressBar change.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ValueChanged;
/// <summary>
- /// Sets or gets the value whether a given ProgressBar widget is at the "pulsing mode".
+ /// Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode".
/// </summary>
/// <remarks>
/// By default, progress bars display values from low to high value boundaries.
/// There are, though, contexts in which the progress of a given task is unknown.
- /// For such cases, one can set the progress bar widget to a "pulsing state",
+ /// For such cases, one can set a progress bar widget to a "pulsing state",
/// to give the user an idea that some computation is being held,
- /// but without the exact progress values. In the default theme,
+ /// but without exact progress values. In the default theme,
/// it animates its bar with the contents filling in constantly and back to non-filled, in a loop.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the value of the ProgressBar.
+ /// Sets or gets the value of ProgressBar.
/// </summary>
/// <remarks>
/// Use this property to set the progress bar levels.
- /// If you pass a value out of the specified range (0.0~1.0),
+ /// If you pass a value out of the specified range(0.0~1.0),
/// it is interpreted as the closest of the boundary values in the range.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the span value of the ProgressBar.
+ /// Sets or gets the span value of ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int SpanSize
}
/// <summary>
- /// Sets or gets the value whether a given ProgressBar widget is horizontal.
+ /// Sets or gets the value wheather a given ProgressBar widget is horizontal.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets the format string for a given progress bar widget's units label.
+ /// Sets or gets format string for a given progress bar widget's units label.
/// </summary>
/// <remarks>
- /// If null is passed on format, it makes the object units area to be hidden completely.
+ /// If NULL is passed on format, it makes obj units area to be hidden completely.
/// If not, it sets the format string for the units label's text.
- /// The units label are provided with a floating point value, so the units text displays at the most one floating point value.
+ /// The units label is provided with a floating point value, so the units text displays at most one floating point value.
/// Note that the units label is optional. Use a format string such as "%1.2f meters" for example.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the part value of a given part of the Progressbar.
+ /// Gets the part value of the given part of the Progressbar.
/// </summary>
/// <param name="part">Part of the Progressbar.</param>
- /// <returns>Value range is from 0.0 to 1.0.</returns>
+ /// <returns>Returns value range is from 0.0 to 1.0.</returns>
/// <since_tizen> preview </since_tizen>
public double GetPartValue(string part)
{
}
/// <summary>
- /// Sets the part value of a given part of the Progressbar.
+ /// Sets the part value of the give part of the Progressbar.
/// </summary>
/// <param name="part">Part of the Progressbar.</param>
/// <param name="value">Value range is from 0.0 to 1.0.</param>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Radio is a widget that allows for 1 or more options to be displayed, and have the user choose only 1 of them.
+ /// The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Radio : Layout
}
/// <summary>
- /// ValueChanged will be triggered when value of the radio changes.
+ /// ValueChanged will be triggered when value of Radio change.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ValueChanged;
/// <summary>
- /// Sets or gets a unique value to each radio button.
+ /// Sets or gets a unique value to each Radio button.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int StateValue
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
public enum ReadingInfoType
{
/// <summary>
- /// None.
+ /// None
/// </summary>
None = 0,
/// <summary>
- /// Name for reading info type.
+ /// Name for reading info type
/// </summary>
Name = 0x1,
/// <summary>
- /// Role for reading info type.
+ /// Role for reading info type
/// </summary>
Role = 0x2,
/// <summary>
- /// Description for reading info type.
+ /// Description for reading info type
/// </summary>
Description = 0x4,
/// <summary>
- /// State for reading info type.
+ /// State for reading info type
/// </summary>
State = 0x8
}
namespace ElmSharp
{
/// <summary>
- /// The Rect is a struct that represents the rectangular space.
+ /// The Rect is a struct that represent rectangluar space.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
/// <summary>
/// Creates and initializes a new instance of the Rect class.
/// </summary>
- /// <param name="x">X-axis value.</param>
- /// <param name="y">Y-axis value.</param>
+ /// <param name="x">X axis value.</param>
+ /// <param name="y">Y axis value.</param>
/// <param name="w">Width value.</param>
/// <param name="h">Height value.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the position of this rectangle on the X-axis.
+ /// Gets or sets the position of this Rectangle on the X axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int X { get; set; }
/// <summary>
- /// Gets or sets the position of this rectangle on the Y-axis.
+ /// Gets or sets the position of this Rectangle on the Y axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Y { get; set; }
/// <summary>
- /// Gets or sets the width of this rectangle.
+ /// Gets or sets the width of this Rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Width { get; set; }
/// <summary>
- /// Gets or sets the height of this rectangle.
+ /// Gets or sets the height of this Rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Height { get; set; }
/// <summary>
- /// Gets the position of this rectangle on the X-axis.
+ /// Gets the position of this Rectangle on the X axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Left { get { return X; } }
/// <summary>
- /// Gets the extent along the X-axis.
+ /// Gets the extent along the X axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Right { get { return X + Width; } }
/// <summary>
- /// Gets the position of this rectangle on the Y-axis.
+ /// Gets the position of this Rectangle on the Y axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Top { get { return Y; } }
/// <summary>
- /// Gets the extent along the Y-axis.
+ /// Gets the extent along the Y axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Bottom { get { return Y + Height; } }
/// <summary>
- /// Gets the point defined by Rectangle.Left and Rectangle.Top.
+ /// Gets the Point defined by Rectangle.Left and Rectangle.Top.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point Location { get { return new Point { X = X, Y = Y }; } }
/// <summary>
- /// Gets the extent of the rectangle along its X-axis and Y-axis.
+ /// Gets the extent of the Rectangle along its X and Y axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size Size { get { return new Size { Width = Width, Height = Height }; } }
/// <summary>
- /// A human-readable representation of <see cref="T:Tizen.UI.Rect"/>.
+ /// 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>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Rect"/> to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise, false
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Rect other)
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Rectangle"/>'s are equal.
+ /// Whether the two <see cref="T:Tizen.UI.Rectangle" />s are equal.
/// </summary>
- /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle"/> on the left hand side.</param>
- /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Rectangle"/>'s have equal values.</returns>
+ /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle" /> on the left hand side.</param>
+ /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Rectangle" />s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Rect r1, Rect r2)
{
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Rectangle"/>'s are not equal.
+ /// Whether two <see cref="T:Tizen.UI.Rectangle" />s are not equal.
/// </summary>
- /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle"/> on the left hand side.</param>
- /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Rectangle"/>'s do not have equal values.</returns>
+ /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle" /> on the left hand side.</param>
+ /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Rectangle" />s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Rect r1, Rect r2)
{
namespace ElmSharp
{
/// <summary>
- /// The Rectangle is a class that is used to draw a solid colored rectangle.
+ /// The Rectangle is a class that used to draw a solid colored rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Rectangle : EvasObject
/// <summary>
/// Creates and initializes a new instance of the Rectangle class.
/// </summary>
- /// <param name="parent">The <see cref="EvasObject"/> to which the new slider will be attached as a child.</param>
+ /// <param name="parent">The <see cref="EvasObject"/> to which the new Slider will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Rectangle(EvasObject parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the visible type of scrollbar.
+ /// Enumeration for visible type of scrollbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollBarVisiblePolicy
{
/// <summary>
- /// Show scrollbars as needed.
+ /// Show scrollbars as needed
/// </summary>
Auto = 0,
/// <summary>
- /// Always show scrollbars.
+ /// Always show scrollbars
/// </summary>
Visible,
/// <summary>
- /// Never show scrollbars.
+ /// Never show scrollbars
/// </summary>
Invisible
}
/// <summary>
- /// Enumeration for the visible type of scrollbar.
+ /// Enumeration for visible type of scrollbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollBlock
{
/// <summary>
- /// Scrolling movement is allowed in both the directions (X-axis and Y-axis).
+ /// Scrolling movement is allowed in both direction.(X axis and Y axis)
/// </summary>
None = 1,
/// <summary>
- /// Scrolling movement is not allowed in the Y-axis direction.
+ /// Scrolling movement is not allowed in Y axis direction.
/// </summary>
Vertical = 2,
/// <summary>
- /// Scrolling movement is not allowed in the X-axis direction.
+ /// Scrolling movement is not allowed in X axis direction.
/// </summary>
Horizontal = 4
}
public enum ScrollSingleDirection
{
/// <summary>
- /// Scroll in every direction.
+ /// Scroll every direction.
/// </summary>
None,
/// <summary>
- /// Scroll in single direction if the direction is certain.
+ /// Scroll single direction if the direction is certain.
/// </summary>
Soft,
/// <summary>
- /// Scroll only in a single direction.
+ /// Scroll only single direction.
/// </summary>
Hard,
}
}
/// <summary>
- /// Gets the current region in the content object that is visible through the scroller.
+ /// Gets the current region in the content object that is visible through the Scroller.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Rect CurrentRegion
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy.
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
/// Sets or gets the value of ScrollBlock.
/// </summary>
/// <remarks>
- /// This function will block scrolling movement in a given direction. One can disable movements in the X-axis, the Y-axis, or both.
+ /// This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both.
/// The default value is ScrollBlock.None, where movements are allowed in both directions.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the scroll current page number.
+ /// Sets or gets scroll current page number.
/// </summary>
/// <remarks>
/// Current page means the page which meets the top of the viewport.
}
/// <summary>
- /// Sets or gets the scroll current page number.
+ /// Sets or gets scroll current page number.
/// </summary>
/// <remarks>
/// Current page means the page which meets the left of the viewport.
}
/// <summary>
- /// Sets the scrolling gravity values for a scroller.
- /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase.
- /// The scroller will adjust the view to glue itself as follows:
- /// x=0.0, for staying where it is relative to the left edge of the content, x=1.0, for staying where it is relative to the rigth edge of the content, y=0.0, for staying where it is relative to the top edge of the content, y=1.0, for staying where it is relative to the bottom edge of the content.
- /// Default values for x and y are 0.0.
+ /// Set scrolling gravity values for a scroller.
+ /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase.
+ /// The scroller will adjust the view to glue itself as follows.
+ /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content
+ /// Default values for x and y are 0.0
/// </summary>
/// <since_tizen> preview </since_tizen>
public double HorizontalGravity
}
/// <summary>
- /// Sets the scrolling gravity values for a scroller.
- /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase.
- /// The scroller will adjust the view to glue itself as follows:
- /// x=0.0, for staying where it is relative to the left edge of the content, x=1.0, for staying where it is relative to the rigth edge of the content, y=0.0, for staying where it is relative to the top edge of the content, y=1.0, for staying where it is relative to the bottom edge of the content.
- /// Default values for x and y are 0.0.
+ /// Set scrolling gravity values for a scroller.
+ /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase.
+ /// The scroller will adjust the view to glue itself as follows.
+ /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content
+ /// Default values for x and y are 0.0
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalGravity
}
/// <summary>
- /// Gets the scroll last page number.
+ /// Get scroll last page number.
/// The page number starts from 0. 0 is the first page. This returns the last page number among the pages.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the scroll last page number.
+ /// Get scroll last page number.
/// The page number starts from 0. 0 is the first page. This returns the last page number among the pages.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets an infinite loop_ for a scroller.
+ /// Set an infinite loop_ for a scroller.
/// This function sets the infinite loop vertically.
/// If the content is set, it will be shown repeatedly.
/// </summary>
}
/// <summary>
- /// Sets an infinite loop_ for a scroller.
+ /// Set an infinite loop_ for a scroller.
/// This function sets the infinite loop horizontally.
/// If the content is set, it will be shown repeatedly.
/// </summary>
}
/// <summary>
- /// Gets or sets the page snapping behavior of a scroller.
+ /// Gets or Sets the page snapping behavior of a scroller.
/// </summary>
/// <remarks>
/// When scrolling, if a scroller is paged (see VerticalRelativePageSize),
}
/// <summary>
- /// Gets or sets the page snapping behavior of a scroller.
+ /// Gets or Sets the page snapping behavior of a scroller.
/// </summary>
/// <remarks>
/// When scrolling, if a scroller is paged (see HorizontalRelativePageSize),
/// <summary>
/// Gets or sets the event propagation for a scroller.
/// This enables or disables event propagation from the scroller content to the scroller and its parent.
- /// By default, event propagation is enabled.
+ /// By default event propagation is enabled.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ContentPropagateEvents
/// <summary>
/// Sets the scroller minimum size limited to the minimum size of the content.
- /// By default, the scroller will be as small as its design allows, irrespective of its content.
+ /// By default the scroller will be as small as its design allows, irrespective of its content.
/// This will make the scroller minimum size the right size horizontally and/or vertically to perfectly fit its content in that direction.
/// </summary>
- /// <param name="horizontal">Enable limiting minimum size horizontally.</param>
- /// <param name="vertical">Enable limiting minimum size vertically.</param>
+ /// <param name="horizontal">Enable limiting minimum size horizontally</param>
+ /// <param name="vertical">Enable limiting minimum size vertically</param>
/// <since_tizen> preview </since_tizen>
public void MinimumLimit(bool horizontal, bool vertical)
{
}
/// <summary>
- /// The callback of the Realized event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Size is a struct defining the height and width as a pair of generic type.
+ /// The Size is a struct that defining height and width as a pair of generic type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Size : IEquatable<Size>
public int Height;
/// <summary>
- /// Initializes a new instance of the size structure from specified dimensions.
+ /// Initializes a new instance of the Size structure from the specified dimensions.
/// </summary>
- /// <param name="width">The width to set.</param>
- /// <param name="height">The height to set.</param>
+ /// <param name="width">The width to set</param>
+ /// <param name="height">The height to set</param>
/// <since_tizen> preview </since_tizen>
public Size(int width, int height)
{
}
/// <summary>
- /// A human-readable representation of <see cref="T:Tizen.UI.Size"/>.
+ /// A human-readable representation of the <see cref="T:Tizen.UI.Size" />.
/// </summary>
/// <returns>The string is formatted as "{{Width={0} Height={1}}}".</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the hash code.
+ /// Gets hash code.
/// </summary>
/// <returns>The hash code.</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Size"/> to compare with the current instance.</param>
/// <returns>
- /// true if the object and this instance are of the same type and represent the same value,
- /// otherwise false.
+ /// true if obj and this instance are the same type and represent the same value.
+ /// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Size other)
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Size"/>s are equal.
+ /// Whether the two <see cref="T:Tizen.UI.Size" />s are equal.
/// </summary>
- /// <param name="s1">A <see cref="T:Tizen.UI.Size"/> on the left hand side.</param>
- /// <param name="s2">A <see cref="T:Tizen.UI.Size"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Size"/>s have equal values.</returns>
+ /// <param name="s1">A <see cref="T:Tizen.UI.Size" /> on the left hand side.</param>
+ /// <param name="s2">A <see cref="T:Tizen.UI.Size" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Size" />s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Size s1, Size s2)
{
}
/// <summary>
- /// Whether both <see cref="T:Tizen.UI.Size"/>s are not equal.
+ /// Whether two <see cref="T:Tizen.UI.Size" />s are not equal.
/// </summary>
- /// <param name="s1">A <see cref="T:Tizen.UI.Size"/> on the left hand side.</param>
- /// <param name="s2">A <see cref="T:Tizen.UI.Size"/> on the right hand side.</param>
- /// <returns>True if both <see cref="T:Tizen.UI.Size"/>s do not have equal values.</returns>
+ /// <param name="s1">A <see cref="T:Tizen.UI.Size" /> on the left hand side.</param>
+ /// <param name="s2">A <see cref="T:Tizen.UI.Size" /> on the right hand side.</param>
+ /// <returns>True if the two <see cref="T:Tizen.UI.Size" />s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Size s1, Size s2)
{
public enum SliderIndicatorVisibleMode
{
/// <summary>
- /// Shows the indicator on mouse down or change in the slider value.
+ /// Show indicator on mouse down or change in slider value.
/// </summary>
Default,
/// <summary>
/// Creates and initializes a new instance of the Slider class.
/// </summary>
- /// <param name="parent">The <see cref="EvasObject"/> to which the new slider will be attached as a child.</param>
+ /// <param name="parent">The <see cref="EvasObject"/> to which the new Slider will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Slider(EvasObject parent) : base(parent)
{
/// </summary>
/// <remarks>
/// This sets the minimum width (when in the horizontal mode) or height (when in the vertical mode)
- /// of the actual bar area of the slider object. This in turn affects the object's minimum size.
+ /// of the actual bar area of the slider obj. This in turn affects the object's minimum size.
/// Use this when you're not setting other size hints expanding on the given direction
/// (like weight and alignment hints), and you would like it to have a specific size.
/// </remarks>
/// <remarks>
/// The slider may display its value somewhere other than the unit label,
/// for example, above the slider knob that is dragged around. This function sets the format string
- /// used for this. If null, the indicator label won't be visible. If not, it sets the format string
+ /// used for this.If NULL, the indicator label won't be visible. If not, it sets the format string
/// for the label text. For the label text floating point value is provided, so the label text can
- /// display up to 1 floating point value. Note that this is optional. Use a format string
+ /// display up to 1 floating point value. Note that this is optional.Use a format string
/// such as "%1.2f meters" for example, and it displays values like: "3.14 meters" for a value
- /// equal to 3.14159. By default, the indicator label is disabled.
+ /// equal to 3.14159.By default, the indicator label is disabled.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public string IndicatorFormat
/// Sets or gets the orientation of a given slider widget.
/// </summary>
/// <remarks>
- /// The orientation may be vertical or horizontal. By default, it's displayed horizontally.
+ /// The orientation may be vertically or horizontally.By default, it's displayed horizontally.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
/// <remarks>
/// This defines the allowed minimum values to be selected by the user.
/// If the actual value is less than min, it is updated to min.
- /// Actual value can be obtained with value. By default, the minimum is equal to 0.0.
+ /// Actual value can be obtained with Value.By default, min is equal to 0.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Minimum
/// <remarks>
/// This defines the allowed maximum values to be selected by the user.
/// If the actual value is bigger then max, it is updated to max.
- /// Actual value can be obtained with value. By default, minimum is equal to 0.0 and maximum is equal to 1.0.
+ /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0.
/// Maximum must be greater than minimum, otherwise the behavior is undefined.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <remarks>
/// Value will be presented on the unit label following format specified with UnitFormat and
- /// on indicator with IndicatorFormat. The value must be between minimum and maximum values.
+ /// on indicator with IndicatorFormat.The value must to be between Minimum and Maximum values.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Value
/// <remarks>
/// This value is used when the draggable object is moved automatically i.e.,
/// in case of a key event when up/down/left/right key is pressed or in case accessibility
- /// is set and the flick event is used to increase or decrease the slider values.
+ /// is set and the flick event is used to inc/dec slider values.
/// By default, the step value is equal to 0.05.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <remarks>
/// A slider may be inverted, in which case it gets its values inverted,
- /// with high values being on the left or top, and low values on the right or bottom,
+ /// with high values being on the left or top and low values on the right or bottom,
/// as opposed to normally have the low values on the former and high values on the latter,
/// respectively, for the horizontal and vertical modes.
/// </remarks>
/// </summary>
/// <remarks>
/// By default, the indicator is bigger when dragged by the user.
- /// It won't display the values set with IndicatorFormat if you disable the indicator.
+ /// It won't display values set with IndicatorFormat if you disable the indicator.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsIndicatorVisible
}
/// <summary>
- /// Sets or gets the visible mode of the slider indicator.
+ /// Sets or gets the visible mode of slider indicator.
/// </summary>
/// <since_tizen> preview </since_tizen>
public SliderIndicatorVisibleMode IndicatorVisibleMode
}
/// <summary>
- /// Sets or gets whether to show the indicator of a slider on focus.
+ /// Sets or gets whether to Show the indicator of slider on focus.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsIndicatorFocusable
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
/// <summary>
/// It inherits <see cref="IInvalidatable"/>.
/// The event with TEventArgs for <see cref="EvasObject"/>.
- /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
+ /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
/// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
/// They are defined by an event string, which identifies them uniquely.
/// </summary>
public class SmartEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs
{
/// <summary>
- /// The delegate for creating smart event item arguments.
+ /// The delegate for creating smart event item args.
/// </summary>
/// <param name="data">The item data.</param>
- /// <param name="obj">The sender object.</param>
- /// <param name="info">The item sender object.</param>
+ /// <param name="obj">The sender obj.</param>
+ /// <param name="info">The item sender obj.</param>
/// <returns>Return smart event item args.</returns>
/// <since_tizen> preview </since_tizen>
public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info);
}
/// <summary>
- /// Creates and initializes a new instance of the SmartEvent class.
+ /// 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>
}
/// <summary>
- /// Destroys the SmartEvent object.
+ /// Destroy the SmartEvent object.
/// </summary>
~SmartEvent()
{
}
/// <summary>
- /// Adds or removes a delegate for the event.
+ /// Adds or removes delegate for event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Makes the current instance invalidate.
+ /// Make current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed,
- /// otherwise false.
+ /// true if managed resources should be disposed
+ /// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
/// <summary>
/// It inherits <see cref="IInvalidatable"/>.
- /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
+ /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
/// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
/// They are defined by an event string, which identifies them uniquely.
/// </summary>
}
/// <summary>
- /// Destroys the SmartEvent object.
+ /// Destroy the SmartEvent object.
/// </summary>
~SmartEvent()
{
}
/// <summary>
- /// Adds or removes a delegate for the event.
+ /// Adds or removes delegate for event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler On
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Makes the current instance invalidate.
+ /// Make current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed,
- /// otherwise false.
+ /// true if managed resources should be disposed
+ /// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
namespace ElmSharp
{
/// <summary>
- /// The Spinner is a widget that increases or decreases the numeric values using arrow buttons, or edit values directly.
+ /// The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly.
/// Inherits <see cref="Layout"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Creates and initializes a new instance of the Layout class.
+ /// Creates and initializes a new instance of Layout class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Spinner() : base()
public event EventHandler ValueChanged;
/// <summary>
- /// DelayedValueChanged will be triggered after a short time when the value is changed.
+ /// DelayedValueChanged will be triggered after a short time when the value is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler DelayedValueChanged;
}
/// <summary>
- /// Sets or gets the step that is used to increment or decrement the spinner value.
+ /// Sets or gets the step that used to increment or decrement the spinner value.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Step
}
/// <summary>
- /// Sets or gets the interval on time updates for a user mouse button to hold on the spinner widgets' arrows.
+ /// Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
/// Sets or gets the wrap of a given spinner widget.
/// </summary>
/// <remarks>
- /// If wrap is disabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the maximum value.
- /// If wrap is enabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the minimum value.
- /// By default, it's disabled.
+ /// If wrap is disabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the maximum value.
+ /// If wrap is enabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the minimum value.
+ /// By default it's disabled.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsWrapEnabled
/// <summary>
/// Sets or gets whether the spinner can be directly edited by the user or not.
/// </summary>
- /// <remarks>By default, it is enabled.</remarks>
+ /// <remarks>By default it is enabled</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsEditable
{
}
/// <summary>
- /// Sets a special string to display in the place of the numerical value.
+ /// Set a special string to display in the place of the numerical value.
/// </summary>
/// <param name="value">The numerical value to be replaced</param>
/// <param name="label">The label to be used</param>
}
/// <summary>
- /// Removes a previously added special value. After this, the spinner will display the value itself instead of a label.
+ /// Remove a previously added special value, After this, the spinner will display the value itself instead of a label.
/// </summary>
- /// <param name="value">The replaced numerical value.</param>
+ /// <param name="value">The replaced numerical value</param>
/// <since_tizen> preview </since_tizen>
public void RemoveSpecialValue(double value)
{
}
/// <summary>
- /// Gets the special string display in the place of the numerical value.
+ /// Get the special string display in the place of the numerical value.
/// </summary>
/// <param name="value">The replaced numerical value.</param>
- /// <returns>The value of the spinner, which replaced the numerical value with a special string.</returns>
+ /// <returns>The value of the spinner which replaced numerical value with special string</returns>
/// <since_tizen> preview </since_tizen>
public string GetSpecialValue(double value)
{
}
/// <summary>
- /// The callback of the Realized event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows.
+ /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows .
/// Inherits <see cref="Container"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets or gets whether the layout of this table is homogeneous.
/// </summary>
- /// <remarks>True for homogeneous, False for no homogeneous.</remarks>
+ /// <remarks>True for homogeneous, False for no homogeneous</remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
{
/// <summary>
/// Adds a subobject on the table with the coordinates passed.
/// </summary>
- /// <param name="obj">The subobject to be added to the table.</param>
- /// <param name="col">The column number.</param>
- /// <param name="row">The row number.</param>
- /// <param name="colspan">The column span.</param>
- /// <param name="rowspan">The row span.</param>
+ /// <param name="obj">The subobject to be added to the table</param>
+ /// <param name="col">The column number</param>
+ /// <param name="row">The row number</param>
+ /// <param name="colspan">The column span</param>
+ /// <param name="rowspan">The row span</param>
/// <since_tizen> preview </since_tizen>
public void Pack(EvasObject obj, int col, int row, int colspan, int rowspan)
{
/// <summary>
/// Removes the child from the table.
/// </summary>
- /// <param name="obj">The subobject.</param>
+ /// <param name="obj">The subobject</param>
/// <since_tizen> preview </since_tizen>
public void Unpack(EvasObject obj)
{
}
/// <summary>
- /// Removes all the child objects from a table object.
+ /// Removes all child objects from a table object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
}
/// <summary>
- /// Sets the color for a particular part of the table.
+ /// Sets the color for particular part of the table.
/// </summary>
- /// <param name="part">The name of part class.</param>
- /// <param name="color">The color.</param>
+ /// <param name="part">The name of part class</param>
+ /// <param name="color">The color</param>
/// <since_tizen> preview </since_tizen>
public override void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets the color of a particular part of the table.
+ /// Gets the color of particular part of the table.
/// </summary>
- /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
- /// <returns>The color of a particular part.</returns>
+ /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'</param>
+ /// <returns>The color of the particular part</returns>
/// <since_tizen> preview </since_tizen>
public override Color GetPartColor(string part)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the selection mode of the toolbar.
+ /// Enumeration for the selection mode of Toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarSelectionMode
}
/// <summary>
- /// Enumeration for setting the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them.
+ /// Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarShrinkMode
{
/// <summary>
- /// Sets the minimum toolbar size to fit all the items.
+ /// Sets minimum toolbar size to fit all the items.
/// </summary>
None = 0,
Scroll,
/// <summary>
- /// Inserts a button to popup a menu with exceeding items.
+ /// Inserts a button to pop up a menu with exceeding items.
/// </summary>
Menu,
}
/// <summary>
- /// Enumeration for the icon lookup order of the toolbar.
+ /// Enumeration for the icon lookup order of Toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarIconLookupOrder
{
/// <summary>
- /// Icon lookup order: freedesktop, theme.
+ /// Icon look up order: freedesktop, theme.
/// </summary>
FreedesktopTheme,
/// <summary>
- /// Icon lookup order: theme, freedesktop.
+ /// Icon look up order: theme, freedesktop.
/// </summary>
ThemeFreedesktop,
/// <summary>
- /// Icon lookup order: freedesktop.
+ /// Icon look up order: freedesktop.
/// </summary>
Freedesktop,
/// <summary>
- /// Icon lookup order: theme.
+ /// Icon look up order: theme.
/// </summary>
Theme,
}
}
/// <summary>
- /// Selected will be triggered when toolbar has been selected.
+ /// Selected will be triggered when toolbar have been selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ToolbarItemEventArgs> Selected;
/// <summary>
/// Sets or gets whether the layout of this toolbar is homogeneous.
/// </summary>
- /// <remarks>True for homogeneous, False for no homogeneous.</remarks>
+ /// <remarks>True for homogeneous, False for no homogeneous</remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
{
}
/// <summary>
- /// Sets or gets the toolbar's current orientation.
+ /// Sets or gets toolbar's current orientation.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the number of items in a Toolbar widget.
+ /// Gets the number of items in a toolbar widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ItemsCount
/// <summary>
/// Sets or gets the alignment of the items.
/// </summary>
- /// <remarks>The toolbar items alignment, a float between 0.0 and 1.0.</remarks>
+ /// <remarks>The toolbar items alignment, a float between 0.0 and 1.0</remarks>
/// <since_tizen> preview </since_tizen>
public double ItemAlignment
{
}
/// <summary>
- /// Sets or gets the item's transverse expansion of a given Toolbar widget.
+ /// Sets or gets the item's transverse expansion of a given toolbar widget.
/// </summary>
/// <remarks>
/// The transverse expansion of the item, true for on and false for off.
}
/// <summary>
- /// Appends the ToolbarItem, which just contains label to the toolbar.
+ /// Appends ToolbarItem which just contains label to the toolbar.
/// </summary>
- /// <param name="label">The label of the item.</param>
- /// <returns>The new ToolbarItem which is appended to the toolbar.</returns>
+ /// <param name="label">The label of the item</param>
+ /// <returns>The new ToolbarItem which appended to the toolbar</returns>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string)"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Appends the ToolbarItem, which contains label and icon to the toolbar.
+ /// Appends ToolbarItem which contains label and icon to the toolbar.
/// </summary>
- /// <param name="label">The label of the item.</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
- /// <returns>The new ToolbarItem which is appended to the toolbar.</returns>
+ /// <param name="label">The label of the item</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
+ /// <returns>The new ToolbarItem which appended to the toolbar</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Prepend(string)"/>
/// <seealso cref="Prepend(string, string)"/>
}
/// <summary>
- /// Prepends the ToolbarItem, which just contains label to the toolbar.
+ /// Prepends ToolbarItem which just contains label to the toolbar.
/// </summary>
- /// <param name="label">The label of the item.</param>
- /// <returns>The new ToolbarItem which is prepended to the toolbar.</returns>
+ /// <param name="label">The label of the item</param>
+ /// <returns>The new ToolbarItem which prepended to the toolbar</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string, string)"/>
}
/// <summary>
- /// Prepends the ToolbarItem, which contains label and icon to the toolbar.
+ /// Prepends ToolbarItem which contains label and icon to the toolbar.
/// </summary>
- /// <param name="label">The label of the item.</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
- /// <returns>The new <see cref="ToolbarItem"/> which is prepended to the toolbar.</returns>
+ /// <param name="label">The label of the item</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which prepended to the toolbar</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string)"/>
/// <summary>
/// Inserts a new item which just contains label into the toolbar object before item <paramref name="before"/>.
/// </summary>
- /// <param name="before">The toolbar item to insert before.</param>
- /// <param name="label">The label of the item.</param>
- /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
+ /// <param name="before">The toolbar item to insert before</param>
+ /// <param name="label">The label of the item</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
/// <seealso cref="InsertBefore(ToolbarItem, string, string)"/>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertBefore(ToolbarItem before, string label)
/// <summary>
/// Inserts a new item which contains label and icon into the toolbar object before item <paramref name="before"/>.
/// </summary>
- /// <param name="before">The toolbar item to insert before.</param>
- /// <param name="label">The label of the item.</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
- /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
+ /// <param name="before">The toolbar item to insert before</param>
+ /// <param name="label">The label of the item</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
/// <seealso cref="InsertBefore(ToolbarItem, string)"/>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon)
/// <summary>
/// Inserts a new item which contains label and icon into the toolbar object after item <paramref name="after"/>.
/// </summary>
- /// <param name="after">The toolbar item to insert after.</param>
- /// <param name="label">The label of the item.</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
- /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
+ /// <param name="after">The toolbar item to insert after</param>
+ /// <param name="label">The label of the item</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon)
{
}
/// <summary>
- /// Finds the item with that label in the toolbar.
+ /// Find the item with that label in the toolbar.
/// </summary>
- /// <param name="label">The label of the item.</param>
- /// <returns>The <see cref="ToolbarItem"/> into the toolbar.</returns>
+ /// <param name="label">The label of the item</param>
+ /// <returns>The <see cref="ToolbarItem"/> into the toolbar</returns>
/// <since_tizen> preview </since_tizen>
public ToolbarItem FindItemByLabel(string label)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The ToolbarItem is an item of the toolbar.
+ /// The ToolbarItem is a item of Toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ToolbarItem : ItemObject
/// <summary>
/// Sets or gets whether displaying the item as a separator.
/// </summary>
- /// <remarks>Items aren't set as a separator by default. If set as a separator, it displays a separator theme, so it won't display the icons or labels.</remarks>
+ /// <remarks>Items aren't set as a separator by default. If set as a separator it displays a separator theme, so it won't display icons or labels.</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsSeparator
{
public event EventHandler Selected;
/// <summary>
- /// LongPressed will be triggered when the item is pressed for a long time.
+ /// LongPressed will be triggered when the item is pressed long time.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler LongPressed;
namespace ElmSharp
{
/// <summary>
- /// Transit is designed to apply various animated transition effects, such as translation, rotation, etc.
- /// For using these effects, create a transit and add the desired transition effects.
+ /// Transit is designed to apply various animated transition effects, such like translation, rotation, etc.
+ /// For using these effects, create an Transit and add the desired transition effects.
/// </summary>
/// <remarks>Transit is not reusable. If the effect ends, the transit is destroyed automatically.</remarks>
/// <since_tizen> preview </since_tizen>
Elm_Transit_Effect_Transition_Cb EffectTransitionCallback;
/// <summary>
- /// A callback is called when the transit is deleted.
+ /// A callback called when the transit is deleted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// Creates and initializes a new instance of the Transit class.
+ /// Creates and initializes a new instance of Transit class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Transit()
}
/// <summary>
- /// Destroys the transit object.
+ /// Destroy the Transit object.
/// </summary>
~Transit()
{
}
/// <summary>
- /// Gets or sets the transit animation time.
+ /// Gets or sets the transit animation time
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Duration
}
/// <summary>
- /// Gets or sets a value whether the objects states will be kept or not.
- /// If it is not kept, the objects states will be reset when the transition ends.
+ /// Gets or sets a value whether the objects states will be keep or not.
+ /// If it is not kept, the objects states will be reset when transition ends.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ObjectStateKeep
}
/// <summary>
- /// Gets or sets if auto reverse is on.
+ /// Gets or sets if the auto reverse is on.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoReverse
}
/// <summary>
- /// Gets or sets the smooth scaling for transit map rendering.
- /// This gets the smooth scaling for transit map rendering.
+ /// Gets or sets the smooth scaling for transit map rendering
+ /// This gets smooth scaling for transit map rendering.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Smooth
}
/// <summary>
- /// Gets the time progression of the animation (a double value between 0.0 and 1.0).
- /// The value returned is a fraction (current time/total time).
+ /// Get the time progression of the animation (a double value between 0.0 and 1.0).
+ /// The value returned is a fraction(current time / total time).
/// It represents the progression position relative to the total.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// Starts the transition in given seconds.
/// Once this API is called, the transit begins to measure the time.
/// </summary>
- /// <param name="interval">The interval value in seconds.</param>
+ /// <param name="interval">The interval value in seconds</param>
/// <since_tizen> preview </since_tizen>
public void Go(double interval = 0)
{
}
/// <summary>
- /// Pauses the transition.
+ /// Pause the transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Pause()
}
/// <summary>
- /// Resumes the transition.
+ /// Resume the transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Resume()
}
/// <summary>
- /// Gets the current chained transit list.
+ /// Get the current chained transit list.
/// </summary>
/// <remarks>Cannot add the duplicate transit.</remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the objects list of the transit.
+ /// Get the objects list of the transit.
/// </summary>
/// <remarks>Cannot add the duplicate object.</remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Adds the effect.
+ /// Add the effect.
/// </summary>
/// <param name="effect">EffectBase object.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Destroys the current object.
+ /// Destroy current object
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Releases all the resources currently used by this instance.
+ /// Releases all resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if the managed resources should be disposed,
- /// otherwise false.
+ /// true if managed resources should be disposed
+ /// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Adds a new object to apply the effects.
- /// After the first addition of an object to transit, if its object list becomes empty again, the transit will be killed.
- /// If the object belongs to another transit, the object will be removed from it and it will only belong to the other transit.
+ /// Add new object to apply the effects.
+ /// After the first addition of an object to transit, if its object list become empty again, the transit will be killed.
+ /// If the obj belongs to another transit, the obj will be removed from it and it will only belong to the other transit.
/// </summary>
- /// <remarks>It is not allowed to add a new object after the transit begins.</remarks>
+ /// <remarks>It is not allowed to add a new object after transit begins.</remarks>
/// <param name="obj">Object to be animated.</param>
void AddObject(EvasObject obj)
{
/// <summary>
/// Makes the chain relationship between two transits.
/// </summary>
- /// <param name="transit">The chain transit object. This transit will be operated after the transit is done.</param>
+ /// <param name="transit">The chain transit object. This transit will be operated after transit is done.</param>
void AddChainedTransit(Transit transit)
{
if (_checker.Contains(transit))
}
/// <summary>
- /// Cuts off the chain relationship between two transits.
+ /// Cut off the chain relationship between two transits.
/// </summary>
/// <param name="transit">The chain transit object.</param>
void DeleteChainedTransit(Transit transit)
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the axis along which flip effect should be applied.
+ /// The axis along which flip effect should be applied.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FlipAxis
{
/// <summary>
- /// Flip on X-axis.
+ /// Flip on X axis
/// </summary>
X,
/// <summary>
- /// Flip on Y-axis.
+ /// Flip on Y axis
/// </summary>
Y,
}
/// <summary>
- /// Enumeration for the direction in which the wipe effect should occur.
+ /// The direction in which the wipe effect should occur.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WipeDirection
{
/// <summary>
- /// Wipe to the left.
+ /// Wipe to the left
/// </summary>
Left,
/// <summary>
- /// Wipe to the right.
+ /// Wipe to the right
/// </summary>
Right,
/// <summary>
- /// Wipe to the up.
+ /// Wipe to the up
/// </summary>
Up,
/// <summary>
- /// Wipe to the down.
+ /// Wipe to the down
/// </summary>
Down,
}
/// <summary>
- /// Enumeration for whether the wipe effect should show or hide the object.
+ /// Whether the wipe effect should show or hide the object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WipeType
{
/// <summary>
- /// Hide the object during the animation.
+ /// Hide the object during the animation
/// </summary>
Hide,
/// <summary>
- /// Show the object during the animation.
+ /// Show the object during the animation
/// </summary>
Show,
}
/// <summary>
- /// Enumration for the type of acceleration used in transition.
+ /// The type of acceleration used in the transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TweenMode
{
/// <summary>
- /// Constant speed.
+ /// Constant speed
/// </summary>
Linear,
/// <summary>
- /// Starts slow, increases speed over time, then decrease again and stop slowly, v1 being a power factor.
+ /// Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor
/// </summary>
Sinusoidal,
/// <summary>
- /// Starts fast and decreases speed over time, v1 being a power factor.
+ /// Starts fast and decrease speed over time, v1 being a power factor
/// </summary>
Decelerate,
/// <summary>
- /// Starts slow and increases speed over time, v1 being a power factor.
+ /// Starts slow and increase speed over time, v1 being a power factor
/// </summary>
Accelerate,
/// <summary>
- /// Starts at gradient v1, interpolated via power of v2 curve.
+ /// Start at gradient v1, interpolated via power of v2 curve
/// </summary>
DivisorInterpolate,
/// <summary>
- /// Starts at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1.
+ /// Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1
/// </summary>
Bounce,
/// <summary>
- /// Starts at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1.
+ /// Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1
/// </summary>
Spring,
/// <summary>
- /// Follows the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2).
+ /// Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2)
/// </summary>
BezierCurve,
}
public class BlendEffect : EffectBase
{
/// <summary>
- /// Creates and initializes a new instance of the BlendEffect class.
+ /// Creates and initializes a new instance of BlendEffect class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public BlendEffect()
Color _end;
/// <summary>
- /// Creates and initializes a new instance of the ColorEffect class.
+ /// Creates and initializes a new instance of ColorEffect class.
/// </summary>
- /// <param name="beginColor">The begin color of the effect.</param>
- /// <param name="endColor">The end color of the effect.</param>
+ /// <param name="beginColor">The begin color of the effect</param>
+ /// <param name="endColor">The end color of the effect</param>
/// <since_tizen> preview </since_tizen>
public ColorEffect(Color beginColor, Color endColor)
{
}
/// <summary>
- /// The begin color of the effect.
+ /// The begin color of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color BeginColor
}
/// <summary>
- /// The end color of the effect.
+ /// The end color of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color EndColor
public class FadeEffect : EffectBase
{
/// <summary>
- /// Creates and initializes a new instance of the FadeEffect class.
+ /// Creates and initializes a new instance of FadeEffect class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FadeEffect()
bool _resizable;
/// <summary>
- /// Creates and initializes a new instance of the FlipEffect class.
+ /// Creates and initializes a new instance of FlipEffect class.
/// </summary>
- /// <param name="axis">Flipping axis (X or Y).</param>
- /// <param name="clockWise">Flipping Direction. True is clockwise.</param>
- /// <param name="resizable">Resizable effect with FlipEffect.</param>
+ /// <param name="axis">Flipping Axis(X or Y).</param>
+ /// <param name="clockWise">Flipping Direction. True is clock-wise.</param>
+ /// <param name="resizable">Resizable effect with FlipEffect</param>
/// <since_tizen> preview </since_tizen>
public FlipEffect(FlipAxis axis, bool clockWise, bool resizable = false)
{
}
/// <summary>
- /// Flipping axis (X or Y).
+ /// Flipping Axis(X or Y).
/// </summary>
/// <since_tizen> preview </since_tizen>
public FlipAxis Axis
}
/// <summary>
- /// Flipping direction. True is clockwise.
+ /// Flipping Direction. True is clock-wise.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ClockWise
Size _end;
/// <summary>
- /// Creates and initializes a new instance of the ResizingEffect class.
+ /// Creates and initializes a new instance of FlipEffect class.
/// </summary>
- /// <param name="beginSize">The begin size of the effect.</param>
- /// <param name="endSize">The end size of the effect.</param>
+ /// <param name="beginSize">The begin Size of the effect</param>
+ /// <param name="endSize">The end Size of the effect</param>
/// <since_tizen> preview </since_tizen>
public ResizingEffect(Size beginSize, Size endSize)
{
}
/// <summary>
- /// The begin size of the effect.
+ /// The begin Size of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size BeginSize
}
/// <summary>
- /// The end size of the effect.
+ /// The end Size of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size EndSize
float _end;
/// <summary>
- /// Creates and initializes a new instance of the RotationEffect class.
+ /// Creates and initializes a new instance of RotationEffect class.
/// </summary>
- /// <param name="beginDegree">The begin degree of the effect.</param>
- /// <param name="endDegree">The end degree of the effect.</param>
+ /// <param name="beginDegree">The begin degree of the effect</param>
+ /// <param name="endDegree">The end degree of the effect</param>
/// <since_tizen> preview </since_tizen>
public RotationEffect(float beginDegree, float endDegree)
{
}
/// <summary>
- /// The begin degree of the effect.
+ /// The begin degree of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public float BeginDegree
}
/// <summary>
- /// The end degree of the effect.
+ /// The end degree of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public float EndDegree
Point _end;
/// <summary>
- /// Creates and initializes a new instance of the TranslationEffect class.
+ /// Creates and initializes a new instance of FlipEffect class.
/// </summary>
- /// <param name="beginPoint">The begin point of the effect.</param>
- /// <param name="endPoint">The end point of the effect.</param>
+ /// <param name="beginPoint">The begin Point of the effect</param>
+ /// <param name="endPoint">The end Point of the effect</param>
/// <since_tizen> preview </since_tizen>
public TranslationEffect(Point beginPoint, Point endPoint)
{
}
/// <summary>
- /// The begin point of the effect.
+ /// The begin Point of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point BeginPoint
}
/// <summary>
- /// The end point of the effect.
+ /// The end Point of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point EndPoint
WipeDirection _direction;
/// <summary>
- /// Creates and initializes a new instance of the WipeEffect class.
+ /// Creates and initializes a new instance of WipeEffect class.
/// </summary>
/// <param name="type">Wipe type. Hide or show.</param>
- /// <param name="direction">Wipe direction.</param>
+ /// <param name="direction">Wipe Direction.</param>
/// <since_tizen> preview </since_tizen>
public WipeEffect(WipeType type, WipeDirection direction)
{
}
/// <summary>
- /// Wipe direction.
+ /// Wipe Direction.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WipeDirection Direction
float _end;
/// <summary>
- /// Creates and initializes a new instance of the ZoomEffect class.
+ /// Creates and initializes a new instance of ZoomEffect class.
/// </summary>
- /// <param name="beginRate">The begin rate of the effect.</param>
- /// <param name="endRate">The end rate of the effect.</param>
+ /// <param name="beginRate">The begin rate of the effect</param>
+ /// <param name="endRate">The end rate of the effect</param>
/// <since_tizen> preview </since_tizen>
public ZoomEffect(float beginRate, float endRate)
{
}
/// <summary>
- /// The begin rate of the effect.
+ /// The begin rate of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public float BeginRate
}
/// <summary>
- /// The end rate of the effect.
+ /// The end rate of the effect
/// </summary>
/// <since_tizen> preview </since_tizen>
public float EndRate
namespace ElmSharp
{
/// <summary>
- /// This class is a static class for utility methods.
+ /// This class is a static class for a utility methods.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class Utility
}
/// <summary>
- /// Removes all font paths loaded into the memory by evas_font_path_app_* APIs for the application.
+ /// Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void ClearEvasGlobalFontPath()
}
/// <summary>
- /// Sets the Edje color class.
+ /// Sets Edje color class.
/// </summary>
- /// <param name="colorClass">Color class.</param>
- /// <param name="red">Object red value.</param>
- /// <param name="green">Object green value.</param>
- /// <param name="blue">Object blue value.</param>
- /// <param name="alpha">Object alpha value.</param>
- /// <param name="outlineRed">Outline red value.</param>
- /// <param name="outlineGreen">Outline green value.</param>
- /// <param name="outlineBlue">Outline blue value.</param>
- /// <param name="outlineAlpha">Outline alpha value.</param>
- /// <param name="shadowRed">Shadow red value.</param>
- /// <param name="shadowGreen">Shadow green value.</param>
- /// <param name="shadowBlue">Shadow blue value.</param>
- /// <param name="shadowAlpha">Shadow alpha value.</param>
+ /// <param name="colorClass">Color class</param>
+ /// <param name="red">Object Red value</param>
+ /// <param name="green">Object Red value</param>
+ /// <param name="blue">Object Red value</param>
+ /// <param name="alpha">Object Red value</param>
+ /// <param name="outlineRed">Outline Red value</param>
+ /// <param name="outlineGreen">Outline Green value</param>
+ /// <param name="outlineBlue">Outline Blue value</param>
+ /// <param name="outlineAlpha">Outline Alpha value</param>
+ /// <param name="shadowRed">Shadow Red value</param>
+ /// <param name="shadowGreen">Shadow Green value</param>
+ /// <param name="shadowBlue">Shadow Bluevalue</param>
+ /// <param name="shadowAlpha">Shadow Alpha value</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
}
/// <summary>
- /// Gets the Edje color class.
+ /// Gets Edje color class.
/// </summary>
- /// <param name="colorClass">Color class.</param>
- /// <param name="red">Object red value.</param>
- /// <param name="green">Object green value.</param>
- /// <param name="blue">Object blue value.</param>
- /// <param name="alpha">Object alpha value.</param>
- /// <param name="outlineRed">Outline red value.</param>
- /// <param name="outlineGreen">Outline green value.</param>
- /// <param name="outlineBlue">Outline blue value.</param>
- /// <param name="outlineAlpha">Outline alpha value.</param>
- /// <param name="shadowRed">Shadow red value.</param>
- /// <param name="shadowGreen">Shadow green value.</param>
- /// <param name="shadowBlue">Shadow blue value.</param>
- /// <param name="shadowAlpha">Shadow alpha value.</param>
+ /// <param name="colorClass">Color class</param>
+ /// <param name="red">Object Red value</param>
+ /// <param name="green">Object Red value</param>
+ /// <param name="blue">Object Red value</param>
+ /// <param name="alpha">Object Red value</param>
+ /// <param name="outlineRed">Outline Red value</param>
+ /// <param name="outlineGreen">Outline Green value</param>
+ /// <param name="outlineBlue">Outline Blue value</param>
+ /// <param name="outlineAlpha">Outline Alpha value</param>
+ /// <param name="shadowRed">Shadow Red value</param>
+ /// <param name="shadowGreen">Shadow Green value</param>
+ /// <param name="shadowBlue">Shadow Bluevalue</param>
+ /// <param name="shadowAlpha">Shadow Alpha value</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public static bool GetEdjeColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue,
}
/// <summary>
- /// Processes all the queued up edje messages.
+ /// Processes all queued up edje messages.
/// This function triggers the processing of messages addressed to any (alive) edje objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the Edje text class.
/// </summary>
- /// <param name="textClass">The text class name.</param>
- /// <param name="font">The font name.</param>
- /// <param name="size">The font size.</param>
- /// <returns>True on success, or False on error.</returns>
+ /// <param name="textClass">The text class name</param>
+ /// <param name="font">The font name</param>
+ /// <param name="size">The font size</param>
+ /// <returns>True, on success or false, on error</returns>
/// <since_tizen> preview </since_tizen>
public static bool SetEdjeTextClass(string textClass, string font, int size)
{
/// <summary>
/// Gets the Edje text class.
/// </summary>
- /// <param name="textClass">The text class name.</param>
- /// <param name="font">The font name.</param>
- /// <param name="size">The font size.</param>
- /// <returns>True on success, or False on error.</returns>
+ /// <param name="textClass">The text class name</param>
+ /// <param name="font">The font name</param>
+ /// <param name="size">The font size</param>
+ /// <returns>True, on success or false, on error</returns>
/// <since_tizen> preview </since_tizen>
public static bool GetEdjeTextClass(string textClass, out string font, out int size)
{
/// <summary>
/// Delete the text class.
/// </summary>
- /// <param name="textClass">The text class name.</param>
+ /// <param name="textClass"></param>
/// <since_tizen> preview </since_tizen>
public static void DeleteEdjeTextClass(string textClass)
{
}
/// <summary>
- /// Pre-multiplies the RGB triplet by an alpha factor.
+ /// Pre-multiplies a rgb triplet by an alpha factor.
/// </summary>
- /// <param name="alpha">The alpha factor.</param>
- /// <param name="red">The red component of the color.</param>
- /// <param name="green">The green component of the color.</param>
- /// <param name="blue">The blue component of the color.</param>
+ /// <param name="alpha">The alpha factor</param>
+ /// <param name="red">The Red component of the color</param>
+ /// <param name="green">The Green component of the color</param>
+ /// <param name="blue">The Blue component of the color</param>
/// <since_tizen> preview </since_tizen>
public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
{
}
/// <summary>
- /// Undoes pre-multiplication of the RGB triplet by an alpha factor.
+ /// Undoes pre-multiplies a rgb triplet by an alpha factor.
/// </summary>
- /// <param name="alpha">The alpha factor.</param>
- /// <param name="red">The red component of the color.</param>
- /// <param name="green">The green component of the color.</param>
- /// <param name="blue">The blue component of the color.</param>
+ /// <param name="alpha">The alpha factor</param>
+ /// <param name="red">The Red component of the color</param>
+ /// <param name="green">The Green component of the color</param>
+ /// <param name="blue">The Blue component of the color</param>
/// <since_tizen> preview </since_tizen>
public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
{
public enum FocusDirection
{
/// <summary>
- /// Previous direction.
+ /// Previous direction
/// </summary>
Previous,
/// <summary>
- /// Next direction.
+ /// Next direction
/// </summary>
Next,
/// <summary>
- /// Up direction.
+ /// Up direction
/// </summary>
Up,
/// <summary>
- /// Down direction.
+ /// Down direction
/// </summary>
Down,
/// <summary>
- /// Right direction.
+ /// Right direction
/// </summary>
Right,
/// <summary>
- /// Left direction.
+ /// Left direction
/// </summary>
Left
}
/// <summary>
- /// The Widget is an abstract class and the parent of other widgets.
+ /// The Widget is abstract class, it is the parent of other widgets.
/// Inherits from <see cref="EvasObject"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
internal int _opacity = Color.Default.A;
/// <summary>
- /// Creates and initializes a new instance of the Widget class.
+ /// Creates and initializes a new instance of Widget class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Widget()
/// <summary>
/// Creates and initializes a new instance of the Widget class.
/// </summary>
- /// <param name="parent">The parent of the new Widget instance.</param>
+ /// <param name="parent">The parent of new Widget instance</param>
/// <since_tizen> preview </since_tizen>
protected Widget(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Updates the part contents.
+ /// Update the part contents
/// </summary>
- /// <param name="content">The content which is put into the part.</param>
- /// <param name="part">The updated part.</param>
+ /// <param name="content">The content which put to the part</param>
+ /// <param name="part">The updated part</param>
/// <since_tizen> preview </since_tizen>
protected void UpdatePartContents(EvasObject content, string part = "__default__")
{
/// <summary>
/// Gets whether a widget is focusable or not.
/// </summary>
- /// <remarks>Widgets which are meant to be interacted with by input events, are created able to be focused by default.</remarks>
+ /// <remarks>Widgets which are meant to be interacted with by input events are created able to be focused, by default</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsFocusAllowed
{
/// <summary>
/// Sets or gets the text of the widget.
/// </summary>
- /// <remarks>It could be overridden by special child class.</remarks>
+ /// <remarks>It could be override by special child class</remarks>
/// <since_tizen> preview </since_tizen>
public virtual string Text
{
/// <summary>
/// Sets or gets the background color of the widget.
/// </summary>
- /// <remarks>It could be overridden by special child class.</remarks>
+ /// <remarks>It could be override by special child class</remarks>
/// <since_tizen> preview </since_tizen>
public virtual Color BackgroundColor
{
/// <summary>
/// Sets or gets the opacity of the widget.
/// </summary>
- /// <remarks>It could be overridden by special child class.</remarks>
+ /// <remarks>It could be override by special child class</remarks>
/// <since_tizen> preview </since_tizen>
public virtual int Opacity
{
/// <summary>
/// Sets or gets the widget's mirrored mode setting.
- /// When widget is set to automatic mode(true), it follows the system mirrored mode.
+ /// When widget set automatic mode(true), it follows the system mirrored mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsAutoMirroredMode
/// <summary>
/// Sets the widget to be focused or not.
/// </summary>
- /// <param name="isFocus">Whether be focused.</param>
+ /// <param name="isFocus">Weather be focused</param>
/// <since_tizen> preview </since_tizen>
public void SetFocus(bool isFocus)
{
/// <summary>
/// Sets the ability for a widget to be focused.
/// </summary>
- /// <param name="isAllowFocus">true if the object can be focused, false if not(and on errors).</param>
+ /// <param name="isAllowFocus">True if the object can be focused, false if not(and on errors)</param>
/// <since_tizen> preview </since_tizen>
public void AllowFocus(bool isAllowFocus)
{
}
/// <summary>
- /// Gives focus to the next widget in the widget tree.
+ /// Gives focus to next widget in widget tree.
/// </summary>
- /// <param name="direction">Direction to move the focus.</param>
+ /// <param name="direction">Direction to move the focus</param>
/// <since_tizen> preview </since_tizen>
public void FocusNext(FocusDirection direction)
{
}
/// <summary>
- /// Sets the next widget with specific focus direction.
+ /// Set next widget with specific focus direction.
/// </summary>
- /// <param name="next">Focus next widget.</param>
- /// <param name="direction">Focus direction.</param>
+ /// <param name="next">Focus next widget</param>
+ /// <param name="direction">Focus direction</param>
/// <since_tizen> preview </since_tizen>
public void SetNextFocusObject(EvasObject next, FocusDirection direction)
{
}
/// <summary>
- /// Sets content to the particular part of the widget, and the preserve old content will not be unset.
+ /// Sets content to particular part of the widget, and the preserve old content will not be unset.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <param name="content">The content.</param>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="content">The content</param>
/// <seealso cref="SetPartContent(string, EvasObject, bool)"/>
/// <since_tizen> preview </since_tizen>
public virtual bool SetPartContent(string part, EvasObject content)
}
/// <summary>
- /// Sets content to the particular part of the widget.
+ /// Sets content to particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <param name="content">The content.</param>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="content">The content</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
/// <seealso cref="SetPartContent(string, EvasObject)"/>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets content to the widget, and the preserve old content will not be unset.
/// </summary>
- /// <param name="content">The content.</param>
+ /// <param name="content">The content</param>
/// <seealso cref="SetContent(EvasObject, bool)"/>
/// <since_tizen> preview </since_tizen>
public void SetContent(EvasObject content)
}
/// <summary>
- /// Sets content to the widget.
+ /// Sets content the widget.
/// </summary>
- /// <param name="content">The content.</param>
+ /// <param name="content">The content</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
/// <seealso cref="SetContent(EvasObject)"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets text to the particular part of the widget.
+ /// Sets text to particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <param name="text">The text.</param>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="text">The text</param>
/// <since_tizen> preview </since_tizen>
public virtual bool SetPartText(string part, string text)
{
/// <summary>
/// Gets text of a particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <returns>Text of the particular part of the widget.</returns>
+ /// <param name="part">The name of particular part</param>
+ /// <returns>Text of the particular part of the widget</returns>
/// <since_tizen> preview </since_tizen>
public virtual string GetPartText(string part)
{
/// <summary>
/// Sets color of a particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <param name="color">The color to be set to the widget.</param>
- /// <remarks>This method is a virtual method, it could be overridden by special child class.</remarks>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="color">The color be set to widget</param>
+ /// <remarks>This method is a virtual method, it could be override by special child class</remarks>
/// <since_tizen> preview </since_tizen>
public virtual void SetPartColor(string part, Color color)
{
/// <summary>
/// Gets color of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <returns>The color of the particular part.</returns>
- /// <remarks>This method is a virtual method, it could be overridden by special child class.</remarks>
+ /// <param name="part">The name of particular part</param>
+ /// <returns>The color of the particular part</returns>
+ /// <remarks>This method is a virtual method, it could be override by special child class</remarks>
/// <since_tizen> preview </since_tizen>
public virtual Color GetPartColor(string part)
{
/// <summary>
/// Sets opacity of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <param name="opacity">The opacity of the particular part.</param>
+ /// <param name="part">The name of particular part</param>
+ /// <param name="opacity">The opacity of the particular part</param>
/// <since_tizen> preview </since_tizen>
public void SetPartOpacity(string part, int opacity)
{
/// <summary>
/// Gets opacity of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of the particular part.</param>
- /// <returns>Opacity value of the particular part.</returns>
+ /// <param name="part">The name of particular part</param>
+ /// <returns>Opacity value of the particular part</returns>
/// <since_tizen> preview </since_tizen>
public int GetPartOpacity(string part)
{
}
/// <summary>
- /// Sends a signal to the edje object of the widget.
+ /// Send a signal to the edje object of the widget.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// The callback of the Realized event.
+ /// The callback of Realized Event
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
public enum DisplayRotation
{
/// <summary>
- /// Rotation value of the window is 0 degree.
+ /// Rotation value of window is 0 degree
/// </summary>
Degree_0 = 1,
/// <summary>
- /// Rotation value of the window is 90 degrees.
+ /// Rotation value of window is 90 degree
/// </summary>
Degree_90 = 2,
/// <summary>
- /// Rotation value of the window is 180 degrees.
+ /// Rotation value of window is 180 degree
/// </summary>
Degree_180 = 4,
/// <summary>
- /// Rotation value of the window is 270 degrees.
+ /// Rotation value of window is 270 degree
/// </summary>
Degree_270 = 8
};
/// <summary>
- /// Enumeration for the indicator opacity.
+ /// Enumeration for the indicator opacity
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum StatusBarMode
{
/// <summary>
- /// Opacifies the status bar.
+ /// Opacifies the status bar
/// </summary>
Opaque = 1,
/// <summary>
- /// Be translucent the status bar.
+ /// Be translucent the status bar
/// </summary>
/// <remarks>
/// Not supported.
Translucent = 2,
/// <summary>
- /// Transparentizes the status bar.
+ /// Transparentizes the status bar
/// </summary>
Transparent = 3,
}
/// <summary>
- /// Enumeration for the keygrab modes of the window.
+ /// Enumeration for the keygrab modes of window.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum KeyGrabMode
{
/// <summary>
- /// Unknown keygrab mode.
+ /// Unknown keygrab mode
/// </summary>
Shared = 256,
Topmost = 512,
/// <summary>
- /// Getting the grabbed-key only when the window is top of the stack.
+ /// Getting the grabbed-key only when window is top of the stack.
/// </summary>
Exclusive = 1024,
/// <summary>
- /// Getting the grabbed-key exclusively regardless of the window's position.
+ /// Getting the grabbed-key exclusively regardless of window's position.
/// </summary>
OverrideExclusive = 2048,
}
};
/// <summary>
- /// Enumeration for the keyboard mode.
+ /// Enumeration for the keyboard mode
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum KeyboardMode
{
/// <summary>
- /// Unknown keyboard state.
+ /// Unknown keyboard state
/// </summary>
Unknown,
/// <summary>
- /// Request to deactivate the keyboard.
+ /// Request to deactivate the keyboard
/// </summary>
Off,
/// <summary>
- /// Enable keyboard with default layout.
+ /// Enable keyboard with default layout
/// </summary>
On,
/// <summary>
- /// Alpha (a-z) keyboard layout.
+ /// Alpha (a-z) keyboard layout
/// </summary>
Alpha,
/// <summary>
- /// Numeric keyboard layout.
+ /// Numeric keyboard layout
/// </summary>
Numeric,
/// <summary>
- /// Pin keyboard layout.
+ /// PIN keyboard layout
/// </summary>
Pin,
/// <summary>
- /// Phone keyboard layout.
+ /// Phone keyboard layout
/// </summary>
PhoneNumber,
/// <summary>
- /// Hexadecimal numeric keyboard layout.
+ /// Hexadecimal numeric keyboard layout
/// </summary>
Hex,
/// <summary>
- /// Full (QWERTY) keyboard layout.
+ /// Full (QWERTY) keyboard layout
/// </summary>
QWERTY,
/// <summary>
- /// Password keyboard layout.
+ /// Password keyboard layout
/// </summary>
Password,
/// <summary>
- /// IP keyboard layout.
+ /// IP keyboard layout
/// </summary>
IP,
/// <summary>
- /// Host keyboard layout.
+ /// Host keyboard layout
/// </summary>
Host,
/// <summary>
- /// File keyboard layout.
+ /// File keyboard layout
/// </summary>
File,
/// <summary>
- /// URL keyboard layout.
+ /// URL keyboard layout
/// </summary>
URL,
/// <summary>
- /// Keypad layout.
+ /// Keypad layout
/// </summary>
Keypad,
/// <summary>
- /// J2ME keyboard layout.
+ /// J2ME keyboard layout
/// </summary>
J2ME,
};
/// <summary>
- /// Enumeration for the window type.
+ /// Enumeration for the window type
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WindowType
{
/// <summary>
- /// Unknown.
+ /// Unknown
/// </summary>
Unknown,
PopupMenu,
/// <summary>
- /// The window is a tooltip. A short piece of explanatory text that typically appears after the mouse cursor hovers over an object for a while.
+ /// The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while.
/// </summary>
Tooltip,
/// <summary>
- /// A notification window, like a warning about battery life or a new e-mail received.
+ /// A notification window, like a warning about battery life or a new E-Mail received.
/// </summary>
Notification,
Combo,
/// <summary>
- /// Used to indicate the window as a representation of an object being dragged across different windows, or even applications.
+ /// Used to indicate the window is a representation of an object being dragged across different windows, or even applications.
/// </summary>
DragAndDrop,
/// <summary>
/// The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer.
- /// This allows to have children windows inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it.
+ /// This allows to have children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it.
/// </summary>
InlinedImage,
};
/// <summary>
- /// The Window is a container that contains the graphical user interface of a program.
+ /// The Window is container that contain the graphical user interface of a program.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Window : Widget
/// Creates and initializes a new instance of the Window class.
/// </summary>
/// <param name="parent">
- /// Parent widget which this window is created on.
+ /// Parent widget which this widow created on.
/// </param>
/// <param name="name">
/// Window name.
/// </param>
/// <remarks>
- /// Window constructor.show window indicator, set callback
- /// when closing the window in any way outside the program control,
- /// and set callback when window rotation is changed.
+ /// Window constructor.show window indicator,set callback
+ /// When closing the window in any way outside the program control,
+ /// and set callback when window rotation changed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public Window(Window parent, string name) : this(parent, name, WindowType.Basic)
/// Creates and initializes a new instance of the Window class.
/// </summary>
/// <param name="parent">
- /// Parent widget which this window is created on.
+ /// Parent widget which this widow created on.
/// </param>
/// <param name="name">
/// Window name.
/// </param>
/// <param name="type">
- /// Window type.
+ /// Window type
/// </param>
/// <remarks>
- /// Window constructor.show window indicator, set callback
- /// when closing the window in any way outside the program control,
- /// and set callback when window rotation is changed.
+ /// Window constructor.show window indicator,set callback
+ /// When closing the window in any way outside the program control,
+ /// and set callback when window rotation changed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public Window(Window parent, string name, WindowType type)
}
/// <summary>
- /// CloseRequested will be triggered when window is closed.
+ /// CloseRequested will be triggered when Window close.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler CloseRequested;
/// <summary>
- /// RotationChanged will be triggered when window is rotated.
+ /// RotationChanged will be triggered when Window do rotation.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler RotationChanged;
/// <summary>
- /// Sets or gets the window name.
+ /// Sets or gets Window name.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Name { get; set; }
/// <summary>
- /// Gets the window type.
+ /// Gets the Window type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WindowType Type { get; } = WindowType.Basic;
/// <summary>
- /// Gets the window size with Size value(w,h)
+ /// Gets Window size with Size value(w,h)
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size ScreenSize
}
/// <summary>
- /// Gets the screen dpi for the screen that the window is on.
+ /// Gets the screen dpi for the screen that a Window is on.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point ScreenDpi
}
/// <summary>
- /// Gets the rotation of the window. The rotation of the window in degrees (0-360).
+ /// Gets the rotation of the Window.The rotation of the window in degrees (0-360).
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Rotation
}
/// <summary>
- /// Gets whether the window manager supports window rotation or not.
+ /// Gets whether window manager supports window rotation or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsRotationSupported
}
/// <summary>
- /// Sets or gets the available rotation degree.
+ /// Sets or gets available rotation degree.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")]
public DisplayRotation AavailableRotations { get; set; }
/// <summary>
- /// Sets or gets the available rotation degree.
+ /// Sets or gets available rotation degree.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DisplayRotation AvailableRotations
}
/// <summary>
- /// Sets or gets whether the auto deletion function is enabled.
+ /// Sets or gets whether auto deletion function is enable.
/// </summary>
/// <remarks>
/// If you enable auto deletion, the window is automatically destroyed after the signal is emitted.
}
/// <summary>
- /// Sets or gets the alpha channel state of the window.
+ /// Sets or gets the alpha channel state of a window.
/// </summary>
/// <remarks>
- /// true if the window alpha channel is enabled, false otherwise.
+ /// True if the window alpha channel is enabled, false otherwise.
/// If alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the mode of the status bar.
+ /// Sets or gets the mode of status bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public StatusBarMode StatusBarMode
}
/// <summary>
- /// Sets or gets the iconified state of the window.
+ /// Sets or gets the iconified state of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets or sets the aspect ratio of the window.
+ /// Gets or sets the aspect ratio of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Aspect
}
/// <summary>
- /// Gets the borderless state of the window.
+ /// Get the borderless state of a window.
/// This function requests the Window Manager to not draw any decoration around the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the demand attention state of the window.
+ /// Gets or sets the demand attention state of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool DemandAttention
}
/// <summary>
- /// Gets or sets the floating mode of the window.
+ /// Gets or sets the floating mode of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool FloatingMode
}
/// <summary>
- /// Gets or sets the enabled status for the focus highlight in the window.
+ /// Gets or sets the enabled status for the focus highlight in a window.
/// This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Gets or sets the style for the focus highlight on this window.
- /// Sets the style to use for theming the highlight of focused objects on the given window. If style is NULL, the default will be used.
+ /// Sets the style to use for theming the highlight of focused objects on the given window.If style is NULL, the default will be used.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string FocusHighlightStyle
}
/// <summary>
- /// Gets the keyboard mode of the window.
+ /// Get the keyboard mode of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public KeyboardMode KeyboardMode
/// <summary>
/// Gets or sets the layer of the window.
/// What this means exactly will depend on the underlying engine used.
- /// In the case of X11 backed engines, the value in layer has the following meanings:
+ /// In the case of X11 backed engines, the value in layer has the following meanings
/// less than 3 means that the window will be placed below all others,
/// more than 5 means that the window will be placed above all others,
/// and anything else means that the window will be placed in the default layer.
}
/// <summary>
- /// Gets or sets the modal state of the window.
+ /// Gets or sets the modal state of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Modal
}
/// <summary>
- /// Gets or sets the noblank property of the window.
- /// This is a way to request the display on which the window is shown is not blank, screensave, or otherwise hidden or obscure. It is intended for use such as media playback on a television where a user may not want to be interrupted by an idle screen.
+ /// Gets or sets the noblank property of a window.
+ /// This is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window.It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen.
/// The noblank property may have no effect if the window is iconified/minimized or hidden.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the profile of the window.
+ /// Get the profile of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Profile
}
/// <summary>
- /// Gets the constraints on the maximum width and height of the window relative to the width and height of its screen.
- /// When this function returns true, object will never resize larger than the screen.
+ /// Get the constraints on the maximum width and height of a window relative to the width and height of its screen.
+ /// When this function returns true, obj will never resize larger than the screen.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ScreenConstrain
}
/// <summary>
- /// Gets or sets the base size of the window.
+ /// Gets or sets the base size of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size BaseSize
}
/// <summary>
- /// Gets or sets the step size of the window.
+ /// Gets or sets the step size of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size StepSize
}
/// <summary>
- /// Gets the screen position X of a window.
+ /// Get the screen position X of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ScreenPositionX
}
/// <summary>
- /// Gets the screen position Y of a window.
+ /// Get the screen position Y of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ScreenPositionY
}
/// <summary>
- /// Gets or sets the urgent state of the window.
+ /// Gets or sets the urgent state of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Urgent
}
/// <summary>
- /// Gets or sets the withdrawn state of the window.
+ /// Gets or sets the withdrawn state of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Withdrawn
}
/// <summary>
- /// Creates a socket to provide the service for the Plug widget.
+ /// Create a socket to provide the service for Plug widget.
/// </summary>
- /// <param name="name">A service name.</param>
+ /// <param name="name">A service name</param>
/// <param name="number">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
- /// <param name="systemWide">A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user ID that created the service.</param>
- /// <returns>If true creates successful, otherwise false.</returns>
+ /// <param name="systemWide">A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.</param>
+ /// <returns>If true, create successfull, otherwise false</returns>
/// <since_tizen> preview </since_tizen>
public bool CreateServiceSocket(string name, int number, bool systemWide)
{
}
/// <summary>
- /// Sets the rotation of the window.
+ /// Set the rotation of the window.
/// </summary>
/// <param name="degree">The rotation of the window, in degrees (0-360), counter-clockwise.</param>
/// <param name="resize">Resizes the window's contents so that they fit inside the current window geometry.</param>
}
/// <summary>
- /// Sets the window to be skipped by focus.
+ /// Set the window to be skipped by focus.
/// This sets the window to be skipped by normal input.
- /// This means the Windows Manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc.
- /// Call this and enable it on the window BEFORE you show it for the first time, otherwise it may have no effect.
+ /// This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc.
+ /// Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect.
/// Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input.
/// Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care.
/// </summary>
}
/// <summary>
- /// Pulls up the window object.
- /// Places the window pointed by object at the top of the stack, so that it's not covered by any other window.
+ /// Pull up the window object.
+ /// Places the window pointed by obj at the top of the stack, so that it's not covered by any other window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void PullUp()
}
/// <summary>
- /// Brings down the window object.
- /// Places the window pointed by object at the bottom of the stack, so that no other window is covered by it.
+ /// Bring down the window object.
+ /// Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void BringDown()
}
/// <summary>
- /// This function sends a request to the Windows Manager to activate the window.
- /// If honored by the Windows Manager, the window receives the keyboard focus.
+ /// This function sends a request to the Windows Manager to activate the Window.
+ /// If honored by the WM, the window receives the keyboard focus.
/// </summary>
/// <remarks>
- /// This is just a request that the Windows Manager may ignore, so calling this function does not ensure
+ /// This is just a request that a Window Manager may ignore, so calling this function does not ensure
/// in any way that the window is going to be the active one after it.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Deletes the subobj as a resize object of the window object.
- /// This function removes the object subobj from the resize objects of the window object.
- /// It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled, or set as child of some other container.
+ /// Delete subobj as a resize object of window obj.
+ /// This function removes the object subobj from the resize objects of the window obj.
+ /// It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled or set as child of some other container.
/// </summary>
/// <param name="obj">Resize object.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Adds an object as a resize object of the window.
+ /// Adds obj as a resize object of the Window.
/// </summary>
/// <remarks>
- /// Setting an object as a resize object of the window means that the object child's size and
- /// position is controlled by the window directly. That is, the object is resized to match the window size
- /// and should never be moved or resized manually by the developer. In addition,
+ /// Setting an object as a resize object of the window means that the obj child's size and
+ /// position is controlled by the window directly. That is, the obj is resized to match the window size
+ /// and should never be moved or resized manually by the developer.In addition,
/// resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user.
/// </remarks>
/// <param name="obj">
}
/// <summary>
- /// Sets the keygrab value of the window.
- /// This function grabs the key of the window using grab_mode.
+ /// 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>
+ /// <param name="mode">According to the grabmode, it can grab key differently</param>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public void WinKeyGrab(string keyname, KeyGrabMode mode)
}
/// <summary>
- /// Unsets the keygrab value of the window.
- /// This function unsets keygrab value. Ungrab key of the window.
+ /// Unset keygrab value of the window.
+ /// This function unset keygrab value.Ungrab key of window.
/// </summary>
/// <param name="keyname">The keyname to grab.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets the keygrab of the window.
+ /// Set the keygrab of the window.
/// </summary>
- /// <param name="keyname">The keyname string to set keygrab.</param>
+ /// <param name="keyname">keyname string to set keygrab</param>
/// <since_tizen> preview </since_tizen>
public void KeyGrabEx(string keyname)
{
}
/// <summary>
- /// Unsets the keygrab of the window.
+ /// Unset the keygrab of the window.
/// </summary>
- /// <param name="keyname">The keyname string to unset keygrab.</param>
+ /// <param name="keyname">keyname string to unset keygrab</param>
/// <since_tizen> preview </since_tizen>
public void KeyUngrabEx(string keyname)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>Handle IntPtr.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>Handle IntPtr</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the wrap types.
+ /// Enumeration for the wrap type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WrapType
/// </summary>
Char,
/// <summary>
- /// Word wrap - wrap within the allowed wrapping points.
+ /// Word wrap - wrap within the allowed wrapping points
/// (as defined in the unicode standard).
/// </summary>
Word,
/// <summary>
- /// Mixed wrap - word wrap, if that fails, char wrap.
+ /// Mixed wrap - Word wrap, if that fails, char wrap.
/// </summary>
Mixed
}
internal static partial class Elementary
{
/// <summary>
- /// Types of "Enter" keys available for different keyboard layouts.
+ /// Types of "Enter" keys available for different keyboards layout
/// </summary>
public enum ReturnKeyType
{
using Tizen.Applications;
/// <summary>
-/// The Interoperability support class for the Tizen APIs.
+/// Interoperability support class for Tizen APIs
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Interoperability support class for the attach panel APIs.
+ /// Interoperability support class for the attach panel APIs
/// </summary>
internal static partial class AttachPanel
{
/// <summary>
-/// The Interoperability support class for the attach panel APIs.
+/// Interoperability support class for the attach panel APIs
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Interoperability support class for the API library.
+ /// Interoperability support class for the API library
/// </summary>
internal static partial class Libraries
{
namespace Tizen.Applications.AttachPanel
{
/// <summary>
- /// Represents the immutable class for the attach panel.
+ /// Represents immutable class for attach panel.
/// </summary>
public partial class AttachPanel
{
/// <summary>
- /// Represents the immutable class for the attach panel.
+ /// Represents immutable class for attach panel.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="conformant">The caller's conformant.</param>
- /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate the memory fails.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel already exists or the <paramref name="conformant"/> is not a conformant object.</exception>
+ /// <param name="conformant">The caller's conformant</param>
+ /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate memory fails.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is already exist or the <paramref name="conformant"/> is not a conformant object</exception>
public AttachPanel(EvasObject conformant)
{
if (conformant == IntPtr.Zero)
}
/// <summary>
- /// Represents the immutable class for the attach panel.
+ /// Represents immutable class for attach panel.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="conformant">The caller's conformant.</param>
- /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate the memory fails.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel already exists or the <paramref name="conformant"/> is not a conformant object.</exception>
+ /// <param name="conformant">The caller's conformant</param>
+ /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate memory fails.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is already exist or the <paramref name="conformant"/> is not a conformant object</exception>
public AttachPanel(Conformant conformant)
{
if (conformant == IntPtr.Zero)
}
/// <summary>
- /// A destructor which deallocates the attach panel resources.
+ /// A destructor which deallocates attach panel resources.
/// </summary>
~AttachPanel()
{
/// <summary>
/// Gets the state of the AttachPanel.
/// </summary>
- /// <value>The AttachPanel window state.</value>
+ /// <value>The AttachPanel window state</value>
/// <since_tizen> 4 </since_tizen>
public StateType State
{
/// <summary>
/// Gets the value that indicates whether the AttachPanel is visible.
/// </summary>
- /// <value>Visible value of the AttachPanel state.</value>
+ /// <value>visible value of AttachPanel state</value>
/// <since_tizen> 4 </since_tizen>
public bool Visible
{
}
/// <summary>
- /// Adds a content category in the AttachPanel.
+ /// Add a content category in the AttachPanel.
/// </summary>
- /// <param name="category">The ContentCategory to be added in the AttachPanel.</param>
- /// <param name="extraData">The AttachPanel sends some information using the Bundle.</param>
+ /// <param name="category">The ContentCategory to be added in the AttachPanel</param>
+ /// <param name="extraData">The AttachPanel send some information using Bundle</param>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/camera</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <feature>http://tizen.org/feature/camera</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <remarks>
- /// The caller application has to check the return value of this function.
- /// Content categories will be shown as the sequence of using AddCategory.
+ /// The caller app has to check the return value of this function.
+ /// Content categories will be shown as the sequence of using AddCategory
/// Some contents need time to load it all.
- /// So, it is needed to use this before the mainloop of the Show.
+ /// So, it is needed to use this before the mainloop of Show
/// Privileges,
- /// http://tizen.org/privilege/mediastorage, for using Image or Camera.
- /// http://tizen.org/privilege/camera, for using Camera or TakePicture.
- /// http://tizen.org/privilege/recorder, for using Voice.
- /// http://tizen.org/privilege/appmanager.launch, for adding content categories on the More tab.
- /// http://tizen.org/feature/camera, for using Camera or TakePicture.
- /// http://tizen.org/feature/microphone, for using Voice.
+ /// http://tizen.org/privilege/mediastorage, for using Image or Camera
+ /// http://tizen.org/privilege/camera, for using Camera or TakePicture
+ /// http://tizen.org/privilege/recorder, for using Voice
+ /// http://tizen.org/privilege/appmanager.launch, for adding content categories on the More tab
+ /// http://tizen.org/feature/camera, for using Camera or TakePicture
+ /// http://tizen.org/feature/microphone, for using Voice
/// Deliver more information to the callee with a bundle if you need.
/// http://tizen.org/appcontrol/data/total_count
/// http://tizen.org/appcontrol/data/total_size
/// </remarks>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have the privilege to access this method.</exception>
- /// <exception cref="NotSupportedException">Thrown when the device does not support the <paramref name="category"/> feature.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is not created yet or is already destroyed.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method</exception>
+ /// <exception cref="NotSupportedException">Thrown when the device does not supported the <paramref name="category"/> feature </exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is not created yet or already destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCategory(ContentCategory category, Bundle extraData)
{
}
/// <summary>
- /// Removes the ContentCategory from the AttachPanel.
+ /// Removes the ContentCategory from the AttachPanel
/// </summary>
- /// <param name="category">The ContentCategory to be added in the AttachPanel.</param>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is not created yet or is already destroyed.</exception>
+ /// <param name="category">The ContentCategory adding in the AttachPanel</param>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is not created yet or already destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void RemoveCategory(ContentCategory category)
{
}
/// <summary>
- /// Sets the extraData to be sent to the ContentCategory using a Bundle.
+ /// Sets extraData to send to the ContentCategory using a Bundle
/// </summary>
- /// <param name="category">The ContentCategory that some information is to be set, in the AttachPanel.</param>
- /// <param name="extraData">The AttachPanel sends some information using a Bundle.</param>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate the memory fails.</exception>
+ /// <param name="category">The ContentCategory that some information to be set in the AttachPanel.</param>
+ /// <param name="extraData">The AttachPanel send some information using Bundle</param>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when an attempt to allocate memory fails.</exception>
/// <since_tizen> 4 </since_tizen>
public void SetExtraData(ContentCategory category, Bundle extraData)
{
}
/// <summary>
- /// Shows the attach panel with the animations.
+ /// Shows the attach panel with animations
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void Show()
{
}
/// <summary>
- /// Shows the attach panel and selects whether or not to animate.
+ /// Shows the attach panel and selects whether or not to animate
/// </summary>
- /// <param name="animation">A flag which turns on or turns off the animation while the attach panel is showing.</param>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed.</exception>
+ /// <param name="animation">A flag which turn on or turn off the animation while attach panel showing.</param>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void Show(bool animation)
{
}
/// <summary>
- /// Hides the attach panel with the animations.
+ /// Hides the attach panel with animations
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void Hide()
{
}
/// <summary>
- /// Hides the attach panel and selects whether or not to animate.
+ /// Hides the attach panel and selects whether or not to animate
/// </summary>
- /// <param name="animation">A flag which turns on or turns off the animation while the attach panel is hiding.</param>
- /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed.</exception>
+ /// <param name="animation">A flag which turn on or turn off the animation while attach panel hiding.</param>
+ /// <exception cref="InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>
/// <since_tizen> 4 </since_tizen>
public void Hide(bool animation)
{
}
/// <summary>
- /// Occurs when the reserved events are published from the panel-side.
+ /// Occurs when reserved events are published from the panel-side.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<StateEventArgs> EventChanged
}
/// <summary>
- /// Occurs when a user selects and confirms something to attach in the AttachPanel.
+ /// Occurs when an user selects and confirms something to attach in the AttachPanel
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<ResultEventArgs> ResultCallback
namespace Tizen.Applications.AttachPanel
{
/// <summary>
- /// Attach panel internal implementation.
+ /// Attach panel internal implementation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public partial class AttachPanel
public enum ContentCategory
{
/// <summary>
- /// Attaching images from the gallery.
+ /// Attaching images from the gallery
/// </summary>
Image = 1,
/// <summary>
- /// Taking pictures to attach.
+ /// Taking pictures to attach
/// </summary>
Camera,
/// <summary>
- /// Taking a voice clip to attach.
+ /// Taking a voice clip to attach
/// </summary>
Voice,
/// <summary>
- /// Attaching video from the gallery.
+ /// Attaching video from the gallery
/// </summary>
Video,
/// <summary>
- /// Attaching audio from my files.
+ /// Attaching audio from my files
/// </summary>
Audio,
/// <summary>
- /// Attaching calendar data from the calendar.
+ /// Attaching calendar data from the calendar
/// </summary>
Calendar,
/// <summary>
- /// Attaching contact data from the contacts.
+ /// Attaching contact data from the contacts
/// </summary>
Contact,
/// <summary>
- /// Attaching files data from my files.
+ /// Attaching files data from my files
/// </summary>
Myfiles,
/// <summary>
- /// Taking a video clip to attach.
+ /// Taking a video clip to attach
/// </summary>
VideoRecorder,
/// <summary>
- /// Attaching files from the document list.
+ /// Attaching files from the document list
/// </summary>
Document,
/// <summary>
- /// Launching apps to take pictures will be attached.
+ /// Launching apps to take pictures will be attached
/// </summary>
TakePicture,
/// <summary>
- /// Attaching memo data from the memo.
+ /// Attaching memo data from the memo
/// </summary>
Memo,
}
public enum EventType
{
/// <summary>
- /// Attach panel starts the effect to show.
+ /// Attach panel starts the effect to show
/// </summary>
ShowStart = 1,
/// <summary>
- /// Attach panel finishes the effect to show.
+ /// Attach panel finishes the effect to show
/// </summary>
ShowFinish,
/// <summary>
- /// Attach panel starts the effect to hide the panel.
+ /// Attach panel starts the effect to hide the panel
/// </summary>
HideStart,
/// <summary>
- /// Attach panel finishes the effect to hide the panel.
+ /// Attach panel finishes the effect to hide the panel
/// </summary>
HideFinish,
}
namespace Tizen.Applications.AttachPanel
{
/// <summary>
- /// A class for the event arguments of the result event.
+ /// Class for event arguments of the result event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ResultEventArgs : EventArgs
}
/// <summary>
- /// Property for the result.
- /// The caller application has to use the ExtraData property to get received data.
+ /// Property for result
+ /// The caller app has to use ExtraData property to get received data.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public AppControl Result
}
/// <summary>
- /// Property for the result of the AppControl.
+ /// Property for result of AppControl
/// </summary>
/// <since_tizen> 4 </since_tizen>
public AppControlReplyResult ResultCode
namespace Tizen.Applications.AttachPanel
{
/// <summary>
- /// A class for the event arguments of the state event.
+ /// Class for event arguments of the state event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class StateEventArgs : EventArgs
}
/// <summary>
- /// Property for the event type.
+ /// Property for event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public EventType EventType
public enum StateType
{
/// <summary>
- /// Attach panel is not visible.
+ /// Attach panel is not visible
/// </summary>
Hidden = 0,
/// <summary>
- /// Attach panel is in the partial window mode.
+ /// Attach panel is in partial window mode
/// </summary>
Partial,
/// <summary>
- /// Attach panel is in the full screen mode.
+ /// Attach panel is in full screen mode
/// </summary>
Full,
}
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class that contains the shortcut information.
+ /// A class that contains shortcut information.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class HomeShortcutInfo : ShortcutInfo
{
/// <summary>
- /// Gets or sets the specific information delivered to the viewer for creating a shortcut.
+ /// Gets or sets the specific information for delivering to the viewer for creating a shortcut.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Uri { get; set; } = string.Empty;
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// Enumeration for the sizes of the shortcut widget.
+ /// Enumeration for sizes of shortcut widget.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ShortcutWidgetSize
{
/// <summary>
- /// Type mask for the normal mode widget, don't use this value for a specific size.
+ /// Type mask for the normal mode widget , don't use this value for specific size.
/// </summary>
WidgetDefault = 0x10000000,
Widget4by6 = 0x12000000,
/// <summary>
- /// Type mask for the easy mode widget, don't use this value for a specific size.
+ /// Type mask for the easy mode widget, don't use this value for specific size.
/// </summary>
EasyDefault = 0x30000000,
/// <summary>
- /// Easy mode 1by1.
+ /// Easy mode 1by1
/// </summary>
Easy1by1 = 0x30010000,
/// <summary>
- /// Easy mode 3by2.
+ /// Easy mode 3by2
/// </summary>
Easy3by1 = 0x30020000,
/// <summary>
- /// Easy mode 3by3.
+ /// Easy mode 3by3
/// </summary>
Easy3by3 = 0x30040000,
}
/// <summary>
- /// Enumeration for the shortcut types.
+ /// Enumeration for shortcut types.
/// </summary>
internal enum ShortcutType
{
LaunchByApp = 0x00000000,
/// <summary>
- /// Launch the application with the given data (URI).
+ /// Launch the application with the given data(URI).
/// </summary>
LaunchByUri = 0x00000001,
}
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class to get the information of the shortcut.
+ /// A class to get information of the Shortcut.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ShortcutInfo
public string IconPath { get; set; } = string.Empty;
/// <summary>
- /// Gets or sets a value indicating whether to allow or not allow duplication.
+ /// Gets or sets a value indicating whether to allow or not to allow duplication.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool IsAllowDuplicate { get; set; }
using System;
/// <summary>
- /// This class provides some functions to add or delete a shortcut.
+ /// This class provides the some functions to add, delete shortcut.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class ShortcutManager
private static Interop.Shortcut.ResultCallback shortcutDeleteResult = null;
/// <summary>
- /// Adds a shortcut on the home-screen.
+ /// Adds a shortcut on home-screen.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="shortcut">Object that contains the shortcut information.</param>
+ /// <param name="shortcut">Object that contain shortcut info.</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Add(HomeShortcutInfo shortcut)
}
/// <summary>
- /// Adds a shortcut on the home-screen.
+ /// Adds a shortcut on home-screen.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="shortcut">Object that contains the shortcut information.</param>
+ /// <param name="shortcut">Object that contain shortcut info.</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Add(WidgetShortcutInfo shortcut)
}
/// <summary>
- /// Removes a shortcut from home by the ShortcutName.
+ /// Removes a shortcut from home by ShortcutName.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="shortcutName">The shortcut name string.</param>
+ /// <param name="shortcutName">Shortcut name string.</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Delete(string shortcutName)
}
/// <summary>
- /// Removes a shortcut from home by the ShortcutInfo.
+ /// Removes a shortcut from home by ShortcutInfo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="shortcut">Object that contains the shortcut information.</param>
+ /// <param name="shortcut">Object that contain shortcut info.</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Delete(ShortcutInfo shortcut)
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class that contains the information about the widget.
+ /// A class that contains information about the widget.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WidgetShortcutInfo : ShortcutInfo
{
/// <summary>
- /// Gets or sets the widget ID.
+ /// Gets or sets the Widget ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string WidgetId { get; set; } = string.Empty;
/// <summary>
- /// Gets or sets the size of the widget.
+ /// Gets or sets the size of widget.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ShortcutWidgetSize WidgetSize { get; set; }
/// <summary>
- /// Gets or sets the update period in seconds.
+ /// Gets or sets the Update period in seconds.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public double Period { get; set; }
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class that contains the shortcut information.
+ /// A class that contains shortcut information.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class HomeShortcutAddedInfo : ShortcutAddedInfo
{
/// <summary>
- /// Gets the name of the application.
+ /// Gets the name of application.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string AppId { get; internal set; }
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class for getting the information of the shortcut.
+ /// A class for getting information of the Shortcut.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ShortcutAddedInfo
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class for getting the information of the shortcut.
+ /// A class for getting information of the Shortcut.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ShortcutDeletedInfo
{
/// <summary>
- /// Gets the name of the package.
+ /// Gets the name of package.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string AppId { get; internal set; }
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// Enumeration for values of the shortcut response types.
+ /// Enumeration for values of shortcut response types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ShortcutError
OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory,
/// <summary>
- /// I/O error.
+ /// I/O Error.
/// </summary>
IoError = Tizen.Internals.Errors.ErrorCode.IoError,
Exist = -0x01160000 | 0x02,
/// <summary>
- /// Shortcut does not exist.
+ /// Not exist shortcut.
/// </summary>
NotExist = -0x01160000 | 0x08,
}
using Tizen.Internals.Errors;
/// <summary>
- /// The callback function that is invoked when the add request occurs.
+ /// The callback function that is invoked when add request occurred
/// </summary>
- /// <param name="args">Object that contains the shortcut information to add.</param>
- /// <returns>The result of handling a shortcut add request.</returns>
+ /// <param name="args">Object that contain shortcut info to add.</param>
+ /// <returns>The result of handling a shortcut add request</returns>
/// <since_tizen> 4 </since_tizen>
public delegate ShortcutError ShortcutAdded(ShortcutAddedInfo args);
/// <summary>
- /// The callback function that is invoked when the delete request occurs.
+ /// The callback function that is invoked when delete request occurred
/// </summary>
- /// <param name="args">Object that contains the shortcut information to delete.</param>
- /// <returns>The result of handling a shortcut delete request.</returns>
+ /// <param name="args">Object that contain shortcut info to delete.</param>
+ /// <returns>The result of handling a shortcut delete request</returns>
/// <since_tizen> 4 </since_tizen>
public delegate ShortcutError ShortcutDeleted(ShortcutDeletedInfo args);
/// <summary>
- /// This class provides a way to register the callback function for the shortcut add and delete events.
+ /// This class provides a way to register callback function for shortcut add, delete events.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class ShortcutEventManager
private static ShortcutDeleted shortcutDeleted = null;
/// <summary>
- /// Registers a callback function to listen requests from the applications.
+ /// Registers a callback function to listen requests from applications.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="addedEvent">The callback function pointer that is invoked when Add() is requested.</param>
+ /// <param name="addedEvent">The callback function pointer that is invoked when Add() is requested</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <remarks>
- /// Previous registered delegate function should be unregistered.
+ /// Previous registered delegate function should be unregister.
/// </remarks>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void RegisterEventHandler(ShortcutAdded addedEvent)
}
/// <summary>
- /// Registers a callback function to listen requests from the applications.
+ /// Registers a callback function to listen requests from applications.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="deletedEvent">The callback function pointer that is invoked when Delete() is requested.</param>
+ /// <param name="deletedEvent">The callback function pointer that is invoked when Delete() is requested</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <remarks>
- /// Previous registered delegate function should be unregistered.
+ /// Previous registered delegate function should be unregister.
/// </remarks>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void RegisterEventHandler(ShortcutDeleted deletedEvent)
/// Unregisters a callback for the shortcut request.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="addedEvent">The callback function pointer that is used for RegisterCallback.</param>
+ /// <param name="addedEvent">The callback function pointer that used for RegisterCallback</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
public static void UnregisterEventHandler(ShortcutAdded addedEvent)
{
if (shortcutAdded != null && shortcutAdded.Equals(addedEvent))
/// Unregisters a callback for the shortcut request.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="deletedEvent">The callback function pointer that is used for RegisterCallback.</param>
+ /// <param name="deletedEvent">The callback function pointer that used for RegisterCallback</param>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
public static void UnregisterEventHandler(ShortcutDeleted deletedEvent)
{
if (shortcutDeleted != null && shortcutDeleted.Equals(deletedEvent))
}
/// <summary>
- /// Gets the preset list of the shortcut template from the installed package.
+ /// Gets the preset list of shortcut template from the installed package.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="appId">The application ID.</param>
+ /// <param name="appId">Application ID.</param>
/// <returns>The List of ShortcutTemplate.</returns>
/// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
- /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case the permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when the shortcut is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
/// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static IEnumerable<ShortcutTemplate> GetTemplateList(string appId)
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class that contains the preset list of the shortcut template from the installed package.
+ /// A class that contains the preset list of shortcut template from the installed package.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ShortcutTemplate
{
/// <summary>
- /// Gets the application ID.
+ /// Gets the Application ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string AppId { get; internal set; }
public string IconPath { get; internal set; }
/// <summary>
- /// Gets the user data. A property of the shortcut element in the manifest file.
+ /// Gets the user data. A property of shortcut element in manifest file.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ExtraKey { get; internal set; }
/// <summary>
- /// Gets the user data. A property of the shortcut element in the manifest file.
+ /// Gets the user data. A property of shortcut element in manifest file.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ExtraData { get; internal set; }
namespace Tizen.Applications.Shortcut
{
/// <summary>
- /// A class that contains the information about the widget.
+ /// A class that contains information about the widget.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WidgetShortcutAddedInfo : ShortcutAddedInfo
{
/// <summary>
- /// Gets the widget ID.
+ /// Gets the Widget ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string WidgetId { get; internal set; }
/// <summary>
- /// Gets the size of the widget.
+ /// Gets the size of widget.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ShortcutWidgetSize WidgetSize { get; internal set; }
/// <summary>
- /// Gets the update period in seconds.
+ /// Gets the Update period in seconds.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public double Period { get; internal set; }
internal delegate int ListCallback(string package_name, string icon, string name, string extra_key, string extra_data, IntPtr user_data);
/// <summary>
- /// Enumeration for the values of the shortcut response types.
+ /// Enumeration for values of shortcut response types.
/// </summary>
internal enum ErrorCode : int
{
/// <summary>
- /// Successful.
+ /// Successful
/// </summary>
None = Tizen.Internals.Errors.ErrorCode.None,
/// <summary>
- /// Invalid function parameter.
+ /// Invalid function parameter
/// </summary>
InvalidParameter = Tizen.Internals.Errors.ErrorCode.InvalidParameter,
/// <summary>
- /// Out of memory.
+ /// Out of memory
/// </summary>
OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory,
/// <summary>
- /// Permission denied.
+ /// Permission denied
/// </summary>
PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied,
/// <summary>
- /// I/O Error.
+ /// I/O Error
/// </summary>
IoError = Tizen.Internals.Errors.ErrorCode.IoError,
/// <summary>
- /// Not supported.
+ /// Not supported
/// </summary>
NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported,
/// <summary>
- /// Device or resource busy.
+ /// Device or resource busy
/// </summary>
ResourceBusy = Tizen.Internals.Errors.ErrorCode.ResourceBusy,
/// <summary>
- /// There is no space to add a new shortcut.
+ /// There is no space to add a new shortcut
/// </summary>
NoSpace = -0x01160000 | 0x01,
/// <summary>
- /// Shortcut is already added.
+ /// Shortcut is already added
/// </summary>
Exist = -0x01160000 | 0x02,
/// <summary>
- /// Unrecoverable error.
+ /// Unrecoverable error
/// </summary>
Fault = -0x01160000 | 0x04,
/// <summary>
- /// Shortcut does not exist.
+ /// Not exist shortcut
/// </summary>
NotExist = -0x01160000 | 0x08,
/// <summary>
- /// Connection not established or communication problem.
+ /// Connection not established or communication problem
/// </summary>
COMM = -0x01160000 | 0x40
}
namespace Tizen.Applications.CoreBackend
{
/// <summary>
- /// A class that represents the type of event for backends. This class can be converted from the string type.
+ /// Class that represents the type of event for backends. This class can be converted from string type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WatchEventType : EventType
{
/// <summary>
- /// Pre-defined event type, "Created".
+ /// Pre-defined event type. "Created"
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static readonly WatchEventType TimeTick = "TimeTick";
/// <summary>
- /// Pre-defined event type, "AmbientTick".
+ /// Pre-defined event type. "AmbientTick"
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static readonly WatchEventType AmbientTick = "AmbientTick";
/// <summary>
- /// Pre-defined event type, "AmbientChanged".
+ /// Pre-defined event type. "AmbientChanged"
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static readonly WatchEventType AmbientChanged = "AmbientChanged";
}
/// <summary>
- /// Converts a string to the WatchEventType instance.
+ /// Converts a string to WatchEventType instance.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static implicit operator WatchEventType(string value)
namespace Tizen.Applications
{
/// <summary>
- /// Arguments for the event that are raised when the device enters or exits the ambient mode.
+ /// Arguments for the event that reaised when the device enters or exits the ambient mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class AmbientEventArgs : EventArgs
{
/// <summary>
- /// The received ambient mode.
+ /// The received Ambient mode
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool Enabled { get; internal set; }
namespace Tizen.Applications
{
/// <summary>
- /// Enumeration for the ambient tick types.
+ /// Enumeration for Ambient tick type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AmbientTickType
{
/// <summary>
- /// No periodic ambient tick.
+ /// No peridoic ambient tick.
/// </summary>
NoTick,
/// <summary>
namespace Tizen.Applications
{
/// <summary>
- /// Arguments for the event that are raised when the time tick comes.
+ /// Arguments for the event that reaised when the time tick comes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class TimeEventArgs : EventArgs
namespace Tizen.Applications
{
/// <summary>
- /// Enumeration for the time tick resolution.
+ /// Enumeration for Time tick resolution.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TimeTickResolution
namespace Tizen.Applications
{
/// <summary>
- /// The class that represents the Tizen watch application.
+ /// The class that represents a Tizen watch application.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WatchApplication : CoreApplication
{
/// <summary>
- /// Initializes the WatchApplication class.
+ /// Initialize the WatchApplication class
/// </summary>
/// <remarks>
- /// Default backend for the watch application will be used.
+ /// Default backend for Watch application will be used.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public WatchApplication() : base(new WatchCoreBackend())
}
/// <summary>
- /// Initializes the WatchApplication class.
+ /// Initialize the WatchApplication class
/// </summary>
/// <remarks>
- /// If you want to change the backend, use this constructor.
+ /// If want to change the backend , use this constructor
/// </remarks>
- /// <param name="backend">The backend instance implementing the ICoreBackend interface.</param>
+ /// <param name="backend">The backend instance implementing ICoreBackend interface.</param>
/// <since_tizen> 4 </since_tizen>
public WatchApplication(ICoreBackend backend) : base(backend)
{
}
/// <summary>
- /// Instances for the window.
+ /// Instance for the window
/// </summary>
/// <since_tizen> 4 </since_tizen>
protected Window Window;
public event EventHandler<TimeEventArgs> TimeTick;
/// <summary>
- /// Occurs whenever the time tick comes in the ambient mode.
+ /// Occurs whenever the time tick comes in ambient mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<TimeEventArgs> AmbientTick;
/// <summary>
/// Runs the UI applications' main loop.
/// </summary>
- /// <param name="args">Arguments from the commandline.</param>
+ /// <param name="args">Arguments from commandline.</param>
/// <since_tizen> 4 </since_tizen>
public override void Run(string[] args)
{
}
/// <summary>
- /// Overrides this method to handle the behavior when the application is launched.
+ /// Overrides this method if want to handle behavior when the application is launched.
/// If base.OnCreate() is not called, the event 'Created' will not be emitted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Overrides this method to handle the behavior when the application is resumed.
+ /// Overrides this method if want to handle behavior when the application is resumed.
/// If base.OnResume() is not called, the event 'Resumed' will not be emitted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Overrides this method to handle the behavior when the application is paused.
+ /// Overrides this method if want to handle behavior when the application is paused.
/// If base.OnPause() is not called, the event 'Paused' will not be emitted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Overrides this method to handle the behavior when the time tick event comes.
+ /// Overrides this method if want to handle behavior when the time tick event comes.
/// If base.OnTick() is not called, the event 'TimeTick' will not be emitted.
/// </summary>
- /// <param name="time">The received TimeEventArgs to get the time information.</param>
+ /// <param name="time">The received TimeEventArgs to get time information.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void OnTick(TimeEventArgs time)
{
}
/// <summary>
- /// Overrides this method to handle the behavior when the time tick event comes in ambient mode.
+ /// Overrides this method if want to handle behavior when the time tick event comes in ambient mode.
/// If base.OnAmbientTick() is not called, the event 'AmbientTick' will not be emitted.
/// </summary>
/// <param name="time">The received TimeEventArgs to get time information.</param>
}
/// <summary>
- /// Overrides this method to handle the behavior when the ambient mode is changed.
+ /// Overrides this method if want to handle behavior when the ambient mode is changed.
/// If base.OnAmbientChanged() is not called, the event 'AmbientChanged' will not be emitted.
/// </summary>
- /// <param name="mode">The received AmbientEventArgs.</param>
+ /// <param name="mode">The received AmbientEventArgs</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void OnAmbientChanged(AmbientEventArgs mode)
{
}
/// <summary>
- /// Gets the current time.
+ /// Gets the current time
/// </summary>
/// <returns>WatchTime</returns>
/// <feature>http://tizen.org/feature/watch_app</feature>
- /// <exception cref="InvalidOperationException">Thrown when failed to get the current time because of an invalid parameter.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed to get the current time because the memory is not enough.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to get current time because of invalid parameter.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed to get current time because memory is not enough.</exception>
/// <exception cref="NotSupportedException">Thrown when the method is not supported.</exception>
/// <example>
/// <code>
}
/// <summary>
- /// Gets the type of the periodic ambient tick.
+ /// Gets the type of periodic ambient tick.
/// </summary>
/// <returns>AmbientTickType</returns>
/// <feature>http://tizen.org/feature/watch_app</feature>
- /// <exception cref="InvalidOperationException">Thrown when failed to get the ambient tick type.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to get ambient tick type.</exception>
/// <exception cref="NotSupportedException">Thrown when the method is not supported.</exception>
/// <example>
/// <code>
}
/// <summary>
- /// Sets the type of the periodic ambient tick.
- /// OnAmbientTick will be called for the following settings.
- /// If the SetAmbientTickType is not called, the OnAmbientTick will be called every minute.
+ /// Sets the type of periodic ambient tick.
+ /// OnAmbientTick will be called following settings.
+ /// If SetAmbientTickType is not called, OnAmbientTick will be called every minute.
/// </summary>
- /// <param name="ambientTickType">The type of the ambient tick.</param>
+ /// <param name="ambientTickType">the type of ambient tick</param>
/// <feature>http://tizen.org/feature/watch_app</feature>
- /// <exception cref="InvalidOperationException">Thrown when failed to set the ambient tick type.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to set ambient tick type.</exception>
/// <exception cref="NotSupportedException">Thrown when the method is not supported.</exception>
/// <example>
/// <code>
}
/// <summary>
- /// Sets the frequency of the time tick.
- /// OnTick will be called for the following settings.
+ /// Sets the frequency of time tick.
+ /// OnTick will be called following settings.
/// If SetTimeTickFrequency is not called, OnTick will be called every second.
/// </summary>
- /// <param name="ticks">Ticks the number of ticks per given resolution type.</param>
- /// <param name="type">Type of the resolution type.</param>
+ /// <param name="ticks">Ticks the number of ticks per given resolution type</param>
+ /// <param name="type">Type of the resolution type</param>
/// <feature>http://tizen.org/feature/watch_app</feature>
- /// <exception cref="InvalidOperationException">Thrown when failed to set the time tick frequency.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to set time tick frequency.</exception>
/// <exception cref="NotSupportedException">Thrown when the method is not supported.</exception>
/// <example>
/// <code>
}
/// <summary>
- /// Gets the frequency of the time tick.
+ /// Gets the frequency fo time tick.
/// </summary>
- /// <param name="ticks">Ticks the number of ticks per given resolution type.</param>
- /// <param name="type">Type of the resolution type.</param>
+ /// <param name="ticks">Ticks the number of ticks per given resolution type</param>
+ /// <param name="type">Type of the resolution type</param>
/// <feature>http://tizen.org/feature/watch_app</feature>
- /// <exception cref="InvalidOperationException">Thrown when failed to get the time tick frequency.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to get time tick frequency.</exception>
/// <exception cref="NotSupportedException">Thrown when the method is not supported.</exception>
/// <example>
/// <code>
namespace Tizen.Applications
{
/// <summary>
- /// The information of the Watch Time.
+ /// The information of Watch Time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WatchTime
}
/// <summary>
- /// The information of a year.
+ /// The information of year
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a month.
+ /// The information fo month
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a day.
+ /// The information of day
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a day of the week.
+ /// The information of day of week
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of an hour.
+ /// The information of hour
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of an hour for the 24 hour format.
+ /// The information of hour for 24 hour form
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a minute.
+ /// The information of Minute
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a second.
+ /// The information of second
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of a millisecond.
+ /// The information of millisecond
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of the timezone.
+ /// The information of timezone
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
}
/// <summary>
- /// The information of the UTC time stamp.
+ /// The information of UTC time stamp
/// </summary>
/// <feature>http://tizen.org/feature/watch_app</feature>
/// <exception cref="NotSupportedException">Thrown when the property is not supported.</exception>
using Tizen.Network.Nsd;
/// <summary>
-/// Interop class for NSD.
+/// Interop class for Nsd
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// NSD native APIs.
+ /// Nsd Native Apis
/// </summary>
internal static partial class Nsd
{
namespace Tizen.Network.Nsd
{
/// <summary>
- /// This class is used for managing the network service discovery using DNS-SD.
+ /// This class is used for managing network service discovery using DNSSD.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DnssdBrowser : INsdBrowser
private Interop.Nsd.Dnssd.ServiceFoundCallback _serviceFoundCallback;
/// <summary>
- /// This event is raised when a DNS-SD service is found during the service discovery.
+ /// This event is raised when a DNSSD service is found during service discovery.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<DnssdServiceFoundEventArgs> ServiceFound
}
/// <summary>
- /// A public constructor for the DnssdBrowser class to create a DnssdBrowser instance for the given service type.
+ /// A public constructor for DnssdBrowser class to create a DnssdBrowser instance for the given service type.
/// </summary>
- /// <param name="serviceType">The DNS-SD service type.</param>
+ /// <param name="serviceType">The DNSSD service type</param>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="ArgumentException">Thrown when the serviceType is null.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when serviceType is null.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
public DnssdBrowser(string serviceType)
{
DnssdInitializer dnssdInit = Globals.s_threadDns.Value;
}
/// <summary>
- /// Starts browsing the DNS-SD remote service.
+ /// Starts browsing the DNSSD remote service.
/// </summary>
/// <remarks>
- /// If there are any services available, the ServiceFound event will be invoked.
- /// The application will keep browsing for the available or unavailable services until it calls StopDiscovery().
+ /// If there are any services available, ServiceFound event will be invoked.
+ /// Application will keep browsing for available/unavailable services until it calls StopDiscovery().
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
public void StartDiscovery()
{
DnssdInitializer dnssdInit = Globals.s_threadDns.Value;
}
/// <summary>
- /// Stops browsing the DNS-SD remote service.
+ /// Stops browsing the DNSSD remote service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
public void StopDiscovery()
{
int ret = Interop.Nsd.Dnssd.StopBrowsing(_browserHandle);
}
}
/// <summary>
- /// This class is used for managing the local service registration and its properties using DNS-SD.
+ /// This class is used for managing local service registration and its properties using DNSSD.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DnssdService : INsdService
private Interop.Nsd.Dnssd.ServiceRegisteredCallback _serviceRegisteredCallback;
/// <summary>
- /// The constructor to create the DnssdService instance that sets the serviceType to a given value.
+ /// Constructor to create DnssdService instance that sets the serviceType to a given value.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="serviceType">The DNS-SD service type. It is expressed as a type followed by the protocol, separated by a dot (For example, "_ftp._tcp").
- /// It must begin with an underscore followed by 1-15 characters, which may be letters, digits, or hyphens.
+ /// <param name="serviceType">The DNSSD service type. It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp").
+ /// It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens.
/// </param>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="NotSupportedException">Thrown while setting this property when DNS-SD is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the serviceType is set to null.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when DNSSD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when serviceType is set to null.</exception>
public DnssdService(string serviceType)
{
_serviceType = serviceType;
}
/// <summary>
- /// Name of the DNS-SD service.
+ /// Name of DNSSD service.
/// </summary>
/// <remarks>
- /// Set the name for only an unregistered service created locally.
+ /// Set Name for only unregistered service created locally.
/// It may be up to 63 bytes.
- /// In case of an error, null will be returned during get and exception will be thrown during set.
+ /// In case of error, null will be returned during get and exception will be thrown during set.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="NotSupportedException">Thrown while setting this property when DNS-SD is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the name value is set to null.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when DNSSD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when Name value is set to null.</exception>
/// <exception cref="InvalidOperationException">Thrown while setting this property when any other error occurred.</exception>
public string Name
{
}
/// <summary>
- /// Type of the DNS-SD local or remote service.
+ /// Type of DNSSD local/remote service.
/// </summary>
/// <remarks>
- /// It is expressed as a type followed by the protocol, separated by a dot (For example, "_ftp._tcp").
- /// It must begin with an underscore followed by 1-15 characters, which may be letters, digits, or hyphens.
- /// In case of an error, null will be returned.
+ /// It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp").
+ /// It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens.
+ /// In case of error, null will be returned.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public string Type
}
/// <summary>
- /// Port number of the DNS-SD local or remote service.
+ /// Port number of DNSSD local/remote service.
/// </summary>
/// <remarks>
- /// Set the port for only an unregistered service created locally. The default value of the port is 0.
- /// In case of an error, -1 will be returned during get and exception will be thrown during set.
+ /// Set Port for only unregistered service created locally. The default value of Port is 0.
+ /// In case of error, -1 will be returned during get and exception will be thrown during set.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="NotSupportedException">Thrown while setting this property when DNS-SD is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown if the value of port is set to less than 0 or more than 65535.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when DNSSD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown if value of Port is set to less than 0 or more than 65535.</exception>
/// <exception cref="InvalidOperationException">Thrown while setting this property when any other error occurred.</exception>
public int Port
{
}
/// <summary>
- /// IP address of the DNS-SD remote service.
+ /// IP address of DNSSD remote service.
/// </summary>
/// <remarks>
/// If the remote service has no IPv4 Address, then IPv4Address would contain null and if it has no IPv6 Address, then IPv6Address would contain null.
- /// In case of an error, null object will be returned.
+ /// In case of error, null object will be returned.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public IPAddressInformation IP
/// Adds the TXT record.
/// </summary>
/// <remarks>
- /// TXT record should be added after registering the local service using RegisterService().
+ /// TXT record should be added after registering local service using RegisterService().
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <param name="key">The key of the TXT record. It must be a null-terminated string with 9 characters or fewer excluding null. It is case insensitive.</param>
- /// <param name="value">The value of the TXT record. If null, then "key" will be added with no value. If non-null but the value_length is zero, then "key=" will be added with an empty value.</param>
+ /// <param name="value">The value of the TXT record.If null, then "key" will be added with no value. If non-null but value_length is zero, then "key=" will be added with empty value.</param>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the value of the key is null.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when value of key is null.</exception>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
public void AddTXTRecord(string key, string value)
{
/// <since_tizen> 4 </since_tizen>
/// <param name="key">The key of the TXT record to be removed.</param>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the value of the key is null.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when value of key is null.</exception>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
public void RemoveTXTRecord(string key)
{
}
/// <summary>
- /// Registers the DNS-SD local service for publishing.
+ /// Registers the DNSSD local service for publishing.
/// </summary>
/// Name of the service must be set.
/// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
public void RegisterService()
{
if (!Globals.s_threadDns.IsValueCreated)
}
/// <summary>
- /// Deregisters the DNS-SD local service.
+ /// Deregisters the DNSSD local service.
/// </summary>
/// <remarks>
/// A local service registered using RegisterService() must be passed.
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD is not supported.</exception>
public void DeregisterService()
{
int ret = Interop.Nsd.Dnssd.DeregisterService(_serviceHandle);
}
/// <summary>
- /// Destroys the DnssdService object.
+ /// Destroy the DnssdService object
/// </summary>
~DnssdService()
{
}
/// <summary>
- /// This class manages the IP address properties of the DNS-SD service.
+ /// This class manages the IP address properties of DNSSD service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class IPAddressInformation
}
/// <summary>
- /// The IP version 4 address of the DNS-SD service.
+ /// The IP version 4 address of DNSSD service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IPAddress IPv4Address
}
/// <summary>
- /// The IP version 6 address of the DNS-SD service.
+ /// The IP version 6 address of DNSSD service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IPAddress IPv6Address
namespace Tizen.Network.Nsd
{
/// <summary>
- /// This interface is used for managing the network service discovery using DNS-SD/SSDP.
+ /// This interface is used for managing network service discovery using DNSSD/SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public interface INsdBrowser
{
/// <summary>
- /// Starts browsing the DNS-SD/SSDP remote service.
+ /// Starts browsing the DNSSD/SSDP remote service.
/// </summary>
/// <remarks>
- /// If there are any services available, the ServiceFound event will be invoked.
- /// The application will keep browsing for the available or unavailable services until it calls StopDiscovery().
+ /// If there are any services available, ServiceFound event will be invoked.
+ /// Application will keep browsing for available/unavailable services until it calls StopDiscovery().
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occured.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD/SSDP is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD/SSDP is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
void StartDiscovery();
/// <summary>
- /// Stops browsing the DNS-SD/SSDP remote service.
+ /// Stops browsing the DNSSD/SSDP remote service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occured.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD/SSDP is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD/SSDP is not supported.</exception>
void StopDiscovery();
}
}
namespace Tizen.Network.Nsd
{
/// <summary>
- /// This interface is used for managing the local service registration using DNS-SD/SSDP.
+ /// This interface is used for managing local service registration using DNSSD/SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public interface INsdService : IDisposable
{
/// <summary>
- /// Registers the DNS-SD/SSDP local service for publishing.
+ /// Registers the DNSSD/SSDP local service for publishing.
/// </summary>
/// <remarks>
- /// A service that is created locally must be passed.
+ /// A service created locally must be passed.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD/SSDP is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD/SSDP is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
void RegisterService();
/// <summary>
- /// Deregisters the DNS-SD/SSDP local service.
+ /// Deregisters the DNSSD/SSDP local service.
/// </summary>
/// <remarks>
- /// A local service that is registered using RegisterService() must be passed.
+ /// A local service registered using RegisterService() must be passed.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.dnssd</feature>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when DNS-SD/SSDP is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when DNSSD/SSDP is not supported.</exception>
void DeregisterService();
}
}
namespace Tizen.Network.Nsd
{
/// <summary>
- /// Enumeration for the DNS-SD service states.
+ /// Enumeration for DNS-SD service state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DnssdServiceState
/// <since_tizen> 4 </since_tizen>
Unavailable,
/// <summary>
- /// Lookup failure for the service name.
+ /// Lookup failure for service name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ServiceNameLookupFailed,
/// <summary>
- /// Lookup failure for the host name and port number.
+ /// Lookup failure for host name and port number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
HostNameLookupFailed,
/// <summary>
- /// Lookup failure for the IP address.
+ /// Lookup failure for IP address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
AddressLookupFailed
}
/// <summary>
- /// Enumeration for the SSDP service states.
+ /// Enumeration for SSDP service state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SsdpServiceState
namespace Tizen.Network.Nsd
{
/// <summary>
- /// An extended EventArgs class, which contains the changed service state during a service discovery using DNS-SD.
+ /// An extended EventArgs class which contains changed service state during service discovery using DNSSD.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DnssdServiceFoundEventArgs : EventArgs
}
/// <summary>
- /// The DNS-SD service state.
+ /// DNSSD service state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public DnssdServiceState State
}
/// <summary>
- /// The DNS-SD service instance.
+ /// DNSSD service instance.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public DnssdService Service
}
/// <summary>
- /// An extended EventArgs class, which contains the changed service state during a service discovery using SSDP.
+ /// An extended EventArgs class which contains changed service state during service discovery using SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SsdpServiceFoundEventArgs : EventArgs
}
/// <summary>
- /// The SSDP service state.
+ /// SSDP service state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public SsdpServiceState State
}
/// <summary>
- /// The SSDP service instance.
+ /// SSDP service instance.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public SsdpService Service
namespace Tizen.Network.Nsd
{
/// <summary>
- /// This class is used for managing the network service discovery using SSDP.
+ /// This class is used for managing network service discovery using SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SsdpBrowser : INsdBrowser
private Interop.Nsd.Ssdp.ServiceFoundCallback _serviceFoundCallback;
/// <summary>
- /// This event is raised when the service has become available or unavailable during a service discovery using SSDP.
+ /// This event is raised when service has become available or unavailable during service discovery using SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SsdpServiceFoundEventArgs> ServiceFound
}
/// <summary>
- /// A public constructor for the SsdpBrowser class to create a SsdpBrowser instance for the given target.
+ /// A public constructor for SsdpBrowser class to create a SsdpBrowser instance for the given target.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <param name="target">The target to browse for the service.</param>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
- /// <exception cref="ArgumentException">Thrown when the target is null.</exception>
+ /// <exception cref="ArgumentException">Thrown when target is null.</exception>
/// <exception cref="NotSupportedException">Thrown when SSDP is not supported.</exception>
public SsdpBrowser(string target)
{
/// Starts browsing the SSDP remote service.
/// </summary>
/// <remarks>
- /// If there are any services available, the ServiceFound event will be invoked.
- /// The application will keep browsing for the available or unavailable services until it calls StopDiscovery().
+ /// If there are any services available, ServiceFound event will be invoked.
+ /// Application will keep browsing for available/unavailable services until it calls StopDiscovery().
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occured.</exception>
/// <exception cref="NotSupportedException">Thrown when SSDP is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
public void StopDiscovery()
{
int ret = Interop.Nsd.Ssdp.StopBrowsing(_browserHandle);
}
/// <summary>
- /// This class is used for managing the local service registration and its properties using SSDP.
+ /// This class is used for managing local service registration and its properties using SSDP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SsdpService : INsdService
private Interop.Nsd.Ssdp.ServiceRegisteredCallback _serviceRegisteredCallback;
/// <summary>
- /// The constructor to create the SsdpService instance that sets the target to a given value.
+ /// Constructor to create SsdpService instance that sets the target to a given value.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <param name="target">The SSDP local service's target. It may be a device type or a service type.</param>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="NotSupportedException">Thrown while setting this property when SSDP is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the target is set to null.</exception>
+ /// <exception cref="ArgumentException">Thrown when target is set to null.</exception>
public SsdpService(string target)
{
_target = target;
}
/// <summary>
- /// Unique Service Name of the SSDP service.
+ /// Unique Service Name of SSDP service.
/// </summary>
/// <remarks>
- /// Set the USN for only an unregistered service created locally. If the service is already registered, the USN will not be set.
- /// In case of an error, null will be returned during get and exception will be thrown during set.
+ /// Set Usn for only unregistered service created locally. If service is already registered, Usn will not be set.
+ /// In case of error, null will be returned during get and exception will be thrown during set.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="NotSupportedException">Thrown while setting this property when SSDP is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when USN value is set to null.</exception>
+ /// <exception cref="ArgumentException">Thrown when Usn value is set to null.</exception>
/// <exception cref="InvalidOperationException">Thrown while setting this property when any other error occurred.</exception>
public string Usn
{
}
/// <summary>
- /// Target of the SSDP service.
+ /// Target of SSDP service.
/// </summary>
/// <remarks>
- /// It may be a device type or a service type specified in the UPnP forum (http://upnp.org).
- /// In case of an error, null will be returned.
+ /// It may be a device type or a service type specified in UPnP forum (http://upnp.org).
+ /// In case of error, null will be returned.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public string Target
}
/// <summary>
- /// URL of the SSDP service.
+ /// URL of SSDP service.
/// </summary>
/// <remarks>
- /// Set the URL for only an unregistered service created locally. If the service is already registered, the URL will not be set.
- /// In case of an error, null will be returned during get and exception will be thrown during set.
+ /// Set Url for only unregistered service created locally. If service is already registered, Url will not be set.
+ /// In case of error, null will be returned during get and exception will be thrown during set.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="NotSupportedException">Thrown while setting this property when SSDP is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the URL value is set to null.</exception>
+ /// <exception cref="ArgumentException">Thrown when Url value is set to null.</exception>
/// <exception cref="InvalidOperationException">Thrown while setting this property when any other error occurred.</exception>
public string Url
{
/// </summary>
/// <remarks>
/// A service created locally must be passed.
- /// URL and USN of the service must be set before the RegisterService is called.
+ /// Url and Usn of the service must be set before RegisterService is called.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when the SSDP is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when SSDP is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
public void RegisterService()
{
if (!Globals.s_threadSsd.IsValueCreated)
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/network.service_discovery.ssdp</feature>
/// <exception cref="InvalidOperationException">Thrown when any other error occurred.</exception>
- /// <exception cref="NotSupportedException">Thrown when the SSDP is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when SSDP is not supported.</exception>
public void DeregisterService()
{
int ret = Interop.Nsd.Ssdp.DeregisterService(_serviceHandle);
}
/// <summary>
- /// Destroys the SsdpService object.
+ /// Destroy the SsdpService object
/// </summary>
~SsdpService()
{
namespace Tizen.PhonenumberUtils
{
/// <summary>
- /// The PhonenumberUtils class provides the methods for parsing, formatting, and normalizing the phone numbers.
+ /// The PhonenumberUtils class provides methods for parsing, formatting and normalizing phone numbers.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class PhonenumberUtils : IDisposable
/// Creates a PhonenumberUtils.
/// </summary>
/// <feature>http://tizen.org/feature/network.telephony</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 3 </since_tizen>
public PhonenumberUtils()
{
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~PhonenumberUtils()
}
/// <summary>
- /// Releases all the resources used by the PhonenumberUtils.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the PhonenumberUtils.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
}
/// <summary>
- /// Gets the location string from the number, region, and language.
+ /// Gets the location string from number, region, and language.
/// </summary>
- /// <param name="number">The number.</param>
- /// <param name="region">The region of number.</param>
- /// <param name="language">The language of location.</param>
- /// <returns>The location string.</returns>
+ /// <param name="number">The number</param>
+ /// <param name="region">The region of number</param>
+ /// <param name="language">The language of location</param>
+ /// <returns>The location string</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the input coordinates are invalid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 3 </since_tizen>
public string GetLocationFromNumber(string number, Region region, Language language)
{
/// <summary>
/// Gets the formatted number.
/// </summary>
- /// <param name="number">The number.</param>
- /// <param name="region">The region of number.</param>
- /// <returns>The formatted number string.</returns>
+ /// <param name="number">The number</param>
+ /// <param name="region">The region of number</param>
+ /// <returns>The formatted number string</returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the input coordinates are invalid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 3 </since_tizen>
public string GetFormattedNumber(string number, Region region)
{
/// <summary>
/// Gets the normalized number.
/// </summary>
- /// <param name="number">The number.</param>
- /// <returns>The normalized number.</returns>
+ /// <param name="number">The number</param>
+ /// <returns>The normalized number</returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when the input coordinates are invalid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <remarks>
/// Normalized number starts with plus('+') and country code, and excludes the separators such as dash or space.
- /// It is a format of the E.164 standard including the country code based on the current network.
+ /// It is a format of E.164 standard including the country code based on current network.
/// </remarks>
/// <since_tizen> 3 </since_tizen>
public string GetNormalizedNumber(string number)
namespace Tizen.PhonenumberUtils
{
/// <summary>
- /// Enumeration for the language types.
+ /// Enumeration for language type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum Language
{
/// <summary>
- /// Amharic.
+ /// Amharic
/// </summary>
Amharic,
/// <summary>
- /// Arabic.
+ /// Arabic
/// </summary>
Arabic,
/// <summary>
- /// Belarusian.
+ /// Belarusian
/// </summary>
Belarusian,
/// <summary>
- /// Bulgarian.
+ /// Bulgarian
/// </summary>
Bulgarian,
/// <summary>
- /// Chinese.
+ /// Chinese
/// </summary>
Chinese,
/// <summary>
- /// Traditional Chinese.
+ /// Chinese (Traditional)
/// </summary>
ChineseTraditional,
/// <summary>
- /// Czech.
+ /// Czech
/// </summary>
Czech,
/// <summary>
- /// Dutch.
+ /// Dutch
/// </summary>
Dutch,
/// <summary>
- /// English.
+ /// English
/// </summary>
English,
/// <summary>
- /// Finnish.
+ /// Finnish
/// </summary>
Finnish,
/// <summary>
- /// French.
+ /// French
/// </summary>
French,
/// <summary>
- /// German.
+ /// German
/// </summary>
German,
/// <summary>
- /// Greek.
+ /// Greek
/// </summary>
Greek,
/// <summary>
- /// Hungarian.
+ /// Hungarian
/// </summary>
Hungarian,
/// <summary>
- /// Indonesian.
+ /// Indonesian
/// </summary>
Indonesian,
/// <summary>
- /// Italian.
+ /// Italian
/// </summary>
Italian,
/// <summary>
- /// Japanese.
+ /// Japanese
/// </summary>
Japanese,
/// <summary>
- /// Korean.
+ /// Korean
/// </summary>
Korean,
/// <summary>
- /// Nothern Sami.
+ /// Nothern Sami
/// </summary>
NorthernSami,
/// <summary>
- /// Persian.
+ /// Persian
/// </summary>
Persian,
/// <summary>
- /// Polish.
+ /// Polish
/// </summary>
Polish,
/// <summary>
- /// Portuguese.
+ /// Portuguese
/// </summary>
Portuguese,
/// <summary>
- /// Romanian.
+ /// Romanian
/// </summary>
Romanian,
/// <summary>
- /// Russian.
+ /// Russian
/// </summary>
Russian,
/// <summary>
- /// Serbian.
+ /// Serbian
/// </summary>
Serbian,
/// <summary>
- /// Spanish.
+ /// Spanish
/// </summary>
Spanish,
/// <summary>
- /// Swedish.
+ /// Swedish
/// </summary>
Swedish,
/// <summary>
- /// Thai.
+ /// Thai
/// </summary>
Thai,
/// <summary>
- /// Turkish.
+ /// Turkish
/// </summary>
Turkish,
/// <summary>
- /// Vietnamese.
+ /// Vietnamese
/// </summary>
Vietnamese,
/// <summary>
- /// The current system value.
+ /// Current System Value
/// </summary>
System
}
/// <summary>
- /// Enumeration for the region types.
+ /// Enumeration for region type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum Region
{
/// <summary>
- /// Aland Islands.
+ /// Aland Islands
/// </summary>
AlandIslands,
/// <summary>
- /// Albania.
+ /// Albania
/// </summary>
Albania,
/// <summary>
- /// Algeria.
+ /// Algeria
/// </summary>
Algeria,
/// <summary>
- /// American Samoa.
+ /// American Samoa
/// </summary>
AmericanSamoa,
/// <summary>
- /// Angola.
+ /// Angola
/// </summary>
Angola,
/// <summary>
- /// Anguilla.
+ /// Anguilla
/// </summary>
Anguilla,
/// <summary>
- /// Argentina.
+ /// Argentina
/// </summary>
Argentina,
/// <summary>
- /// Armenia.
+ /// Armenia
/// </summary>
Armenia,
/// <summary>
- /// Ascension Island.
+ /// Ascension Island
/// </summary>
AscensionIsland,
/// <summary>
- /// Antigua and Barbuda.
+ /// Antigua and Barbuda
/// </summary>
AntiguaAndBarbuda,
/// <summary>
- /// Austria.
+ /// Austria
/// </summary>
Austria,
/// <summary>
- /// Bahamas.
+ /// Bahamas
/// </summary>
Bahamas,
/// <summary>
- /// Barbados.
+ /// Barbados
/// </summary>
Barbados,
/// <summary>
- /// Belarus.
+ /// Belarus
/// </summary>
Belarus,
/// <summary>
- /// Belgium.
+ /// Belgium
/// </summary>
Belgium,
/// <summary>
- /// Benin.
+ /// Benin
/// </summary>
Benin,
/// <summary>
- /// Bermuda.
+ /// Bermuda
/// </summary>
Bermuda,
/// <summary>
- /// Bonaire, Sint Eustatius, and Saba.
+ /// Bonaire, Sint Eustatius and Saba
/// </summary>
BonaireSintEustatiusAndSaba,
/// <summary>
- /// Botswana.
+ /// Botswana
/// </summary>
Botswana,
/// <summary>
- /// Brazil.
+ /// Brazil
/// </summary>
Brazil,
/// <summary>
- /// Bulgaria.
+ /// Bulgaria
/// </summary>
Bulgaria,
/// <summary>
- /// Burkina Faso.
+ /// Burkina Faso
/// </summary>
BurkinaFaso,
/// <summary>
- /// Burundi.
+ /// Burundi
/// </summary>
Burundi,
/// <summary>
- /// Cape Verde (Cabo Verde).
+ /// Cape Verde (Cabo Verde)
/// </summary>
CapeVerde,
/// <summary>
- /// Cameroon.
+ /// Cameroon
/// </summary>
Cameroon,
/// <summary>
- /// Canada.
+ /// Canada
/// </summary>
Canada,
/// <summary>
- /// Cayman Islands.
+ /// Cayman Island
/// </summary>
CaymanIsland,
/// <summary>
- /// Chile.
+ /// Chile
/// </summary>
Chile,
/// <summary>
- /// China.
+ /// China
/// </summary>
China,
/// <summary>
- /// Colombia.
+ /// Colombia
/// </summary>
Colombia,
/// <summary>
- /// Comoros.
+ /// Comoros
/// </summary>
Comoros,
/// <summary>
- /// Congo.
+ /// Congo
/// </summary>
Congo,
/// <summary>
- /// Ivory Coast (Cote d'Ivoire).
+ /// Ivory Coast (Cote d'Ivoire)
/// </summary>
IvoryCoast,
/// <summary>
- /// Cuba.
+ /// Cuba
/// </summary>
Cuba,
/// <summary>
- /// Curacao.
+ /// Curacao
/// </summary>
Curacao,
/// <summary>
/// Czech Republic
- /// </summary>.
+ /// </summary>
CzechRepublic,
/// <summary>
- /// Democratic Republic of the Congo.
+ /// Congo, Democratic Republic of the
/// </summary>
DemocraticRepublicOfTheCongo,
/// <summary>
- /// Dominica.
+ /// Dominica
/// </summary>
Dominica,
/// <summary>
- /// Dominican Republic.
+ /// Dominican Republic
/// </summary>
DominicanRepublic,
/// <summary>
- /// Egypt.
+ /// Egypt
/// </summary>
Egypt,
/// <summary>
- /// Estonia.
+ /// Estonia
/// </summary>
Estonia,
/// <summary>
- /// Ethiopia.
+ /// Ethiopia
/// </summary>
Ethiopia,
/// <summary>
- /// Finland.
+ /// Finland
/// </summary>
Finland,
/// <summary>
- /// France.
+ /// France
/// </summary>
France,
/// <summary>
- /// Gabon.
+ /// Gabon
/// </summary>
Gabon,
/// <summary>
- /// Gambia.
+ /// Gambia
/// </summary>
Gambia,
/// <summary>
- /// Germany.
+ /// Germany
/// </summary>
Germany,
/// <summary>
- /// Ghana.
+ /// Ghana
/// </summary>
Ghana,
/// <summary>
- /// Greece.
+ /// Greece
/// </summary>
Greece,
/// <summary>
- /// Greenland.
+ /// Greenland
/// </summary>
Greenland,
/// <summary>
- /// Grenada.
+ /// Grenada
/// </summary>
Grenada,
/// <summary>
- /// Guam.
+ /// Guam
/// </summary>
Guam,
/// <summary>
- /// Guernsey.
+ /// Guernsey
/// </summary>
Guernsey,
/// <summary>
- /// Guinea.
+ /// Guinea
/// </summary>
Guinea,
/// <summary>
- /// Guinea-Bissau.
+ /// Guinea-Bissau
/// </summary>
GuineaBissau,
/// <summary>
- /// Hungary.
+ /// Hungary
/// </summary>
Hungary,
/// <summary>
- /// Iceland.
+ /// Iceland
/// </summary>
Iceland,
/// <summary>
- /// India.
+ /// India
/// </summary>
India,
/// <summary>
- /// Indonesia.
+ /// Indonesia
/// </summary>
Indonesia,
/// <summary>
- /// Ireland.
+ /// Ireland
/// </summary>
Ireland,
/// <summary>
- /// Islamic Republic of Iran.
+ /// Iran, Islamic Republic of
/// </summary>
Iran,
/// <summary>
- /// Isle of Man.
+ /// Isle of Man
/// </summary>
IsleOfMan,
/// <summary>
- /// Italy.
+ /// Italy
/// </summary>
Italy,
/// <summary>
- /// Jamaica.
+ /// Jamaica
/// </summary>
Jamaica,
/// <summary>
- /// Japan.
+ /// Japan
/// </summary>
Japan,
/// <summary>
- /// Jersey.
+ /// Jersey
/// </summary>
Jersey,
/// <summary>
- /// Jordan.
+ /// Jordan
/// </summary>
Jordan,
/// <summary>
- /// Kazakhstan.
+ /// Kazakhstan
/// </summary>
Kazakhstan,
/// <summary>
- /// Kenya.
+ /// Kenya
/// </summary>
Kenya,
/// <summary>
- /// Kiribati.
+ /// Kiribati
/// </summary>
Kiribati,
/// <summary>
- /// Latvia.
+ /// Latvia
/// </summary>
Latvia,
/// <summary>
- /// Lesotho.
+ /// Lesotho
/// </summary>
Lesotho,
/// <summary>
- /// Lithuania.
+ /// Lithuania
/// </summary>
Lithuania,
/// <summary>
- /// Luxembourg.
+ /// Luxembourg
/// </summary>
Luxembourg,
/// <summary>
- /// Madagascar.
+ /// Madagascar
/// </summary>
Madagascar,
/// <summary>
- /// Mauritania.
+ /// Mauritania
/// </summary>
Mauritania,
/// <summary>
- /// Mauritius.
+ /// Mauritius
/// </summary>
Mauritius,
/// <summary>
- /// Montserrat.
+ /// Montserrat
/// </summary>
Montserrat,
/// <summary>
- /// Morocco.
+ /// Morocco
/// </summary>
Morocco,
/// <summary>
- /// Mozambique.
+ /// Mozambique
/// </summary>
Mozambique,
/// <summary>
- /// Namibia.
+ /// Namibia
/// </summary>
Namibia,
/// <summary>
- /// Netherlands.
+ /// Netherlands
/// </summary>
Netherlands,
/// <summary>
- /// Nigeria.
+ /// Nigeria
/// </summary>
Nigeria,
/// <summary>
- /// Northern Mariana Islands.
+ /// Northern Mariana Islands
/// </summary>
NorthernMarianaIslands,
/// <summary>
- /// Norway.
+ /// Norway
/// </summary>
Norway,
/// <summary>
- /// Peru.
+ /// Peru
/// </summary>
Peru,
/// <summary>
- /// Poland.
+ /// Poland
/// </summary>
Poland,
/// <summary>
- /// Portugal.
+ /// Portugal
/// </summary>
Portugal,
/// <summary>
- /// Puerto Rico.
+ /// Puerto Rico
/// </summary>
PuertoRico,
/// <summary>
- /// Republic of Korea.
+ /// Korea (Republic of)
/// </summary>
Korea,
/// <summary>
- /// Republic of Moldova.
+ /// Moldova (Republic of)
/// </summary>
Moldova,
/// <summary>
- /// Romania.
+ /// Romania
/// </summary>
Romania,
/// <summary>
- /// Russian Federation.
+ /// Russian Federation
/// </summary>
RussianFederation,
/// <summary>
- /// Saint Helena, Ascension and Tristan da Cunha.
+ /// Saint Helena, Ascension and Tristan da Cunha
/// </summary>
SaintHelena,
/// <summary>
- /// Saint Kitts and Nevis.
+ /// Saint Kitts and Nevis
/// </summary>
SaintKittsAndNevis,
/// <summary>
- /// Saint Lucia.
+ /// Saint Lucia
/// </summary>
SaintLucia,
/// <summary>
- /// Saint Vincent and the Grenadines.
+ /// Saint Vincent and the Grenadines
/// </summary>
SaintVicentAndTheGrenadines,
/// <summary>
- /// Saint Thomas And Principe (Sao Tome and Principe).
+ /// Saint Thomas And Principe (Sao Tome and Principe)
/// </summary>
SaintThomasAndPrincipe,
/// <summary>
- /// Saudi Arabia.
+ /// Saudi Arabia
/// </summary>
SaudiArabia,
/// <summary>
- /// Senegal.
+ /// Senegal
/// </summary>
Senegal,
/// <summary>
- /// Serbia.
+ /// Serbia
/// </summary>
Serbia,
/// <summary>
- /// Sierra Leone.
+ /// Sierra Leone
/// </summary>
SierraLeone,
/// <summary>
- /// Saint Martin (Sint Maarten), Dutch part.
+ /// Saint Martin (Sint Maarten), Dutch part
/// </summary>
SintMaarten,
/// <summary>
- /// Slovakia.
+ /// Slovakia
/// </summary>
Slovakia,
/// <summary>
- /// Somalia.
+ /// Somalia
/// </summary>
Somalia,
/// <summary>
- /// South Africa.
+ /// South Africa
/// </summary>
SouthAfrica,
/// <summary>
- /// Spain.
+ /// Spain
/// </summary>
Spain,
/// <summary>
- /// Sri Lanka.
+ /// Sri Lanka
/// </summary>
SriLanka,
/// <summary>
- /// Sudan.
+ /// Sudan
/// </summary>
Sudan,
/// <summary>
- /// Svalbard and Jan Mayen.
+ /// Svalbard and Jan Mayen
/// </summary>
SvalbardAndJanMayen,
/// <summary>
- /// Swaziland.
+ /// Swaziland
/// </summary>
Swaziland,
/// <summary>
- /// Sweden.
+ /// Sweden
/// </summary>
Sweden,
/// <summary>
- /// Switzerland.
+ /// Switzerland
/// </summary>
Switzerland,
/// <summary>
- /// Taiwan, Province of China.
+ /// Taiwan, Province of China
/// </summary>
Taiwan,
/// <summary>
- /// Thailand.
+ /// Thailand
/// </summary>
Thailand,
/// <summary>
- /// The Former Yugoslav Republic of Macedonia.
+ /// Macedonia (the Former Yugoslav Republic of)
/// </summary>
Macedonia,
/// <summary>
- /// Togo.
+ /// Togo
/// </summary>
Togo,
/// <summary>
- /// Trinidad and Tobago.
+ /// Trinidad and Tobago
/// </summary>
TrinidadAndTobago,
/// <summary>
- /// Tristan da Cunha.
+ /// Tristan da Cunha
/// </summary>
TristanDaCunha,
/// <summary>
- /// Tunisia.
+ /// Tunisia
/// </summary>
Tunisia,
/// <summary>
- /// Turkey.
+ /// Turkey
/// </summary>
Turkey,
/// <summary>
- /// Turks and Caicos Islands.
+ /// Turks and Caicos Islands
/// </summary>
TurksAndCaicosIslands,
/// <summary>
- /// Uganda.
+ /// Uganda
/// </summary>
Uganda,
/// <summary>
- /// United Kingdom.
+ /// United Kingdom
/// </summary>
UnitedKingdom,
/// <summary>
- /// United States of America.
+ /// United States of America
/// </summary>
UnitedStatesOfAmerica,
/// <summary>
- /// Venezuela.
+ /// Venezuela
/// </summary>
Venezuela,
/// <summary>
- /// Viet Nam.
+ /// Viet Nam
/// </summary>
VietNam,
/// <summary>
- /// British Virgin Islands.
+ /// Virgin Island (British)
/// </summary>
VirginIslandBritish,
/// <summary>
- /// U.S. Virgin Islands.
+ /// Virgin Island (U.S.)
/// </summary>
VirginIslandUs,
/// <summary>
- /// Western Sahara.
+ /// Western Sahara
/// </summary>
WesternSahara,
/// <summary>
- /// Zambia.
+ /// Zambia
/// </summary>
Zambia,
/// <summary>
- /// Zimbabwe.
+ /// Zimbabwe
/// </summary>
Zimbabwe,
/// <summary>
- /// Andorra.
+ /// Andorra
/// </summary>
Andorra,
/// <summary>
- /// United Arab Emirates.
+ /// United Arab Emirates
/// </summary>
UnitedArabEmirates,
/// <summary>
- /// Afghanistan.
+ /// Afghanistan
/// </summary>
Afghanistan,
/// <summary>
- /// Australia.
+ /// Australia
/// </summary>
Australia,
/// <summary>
- /// Aruba.
+ /// Aruba
/// </summary>
Aruba,
/// <summary>
- /// Azerbaijan.
+ /// Azerbaijan
/// </summary>
Azerbaijan,
/// <summary>
- /// Bosnia and Herzegovina.
+ /// Bosnia and Herzegovina
/// </summary>
BosniaAndHerzegovina,
/// <summary>
- /// Bangladesh.
+ /// Bangladesh
/// </summary>
Bangladesh,
/// <summary>
- /// Bahrain.
+ /// Bahrain
/// </summary>
Bahrain,
/// <summary>
- /// Saint Barthelemy, French Antilles.
+ /// Saint Barthelemy, French Antilles
/// </summary>
SaintBarthelemy,
/// <summary>
- /// Brunei Darussalam.
+ /// Brunei Darussalam
/// </summary>
BruneiDarussalam,
/// <summary>
- /// Bolivia.
+ /// Bolivia
/// </summary>
Bolivia,
/// <summary>
- /// Bhutan.
+ /// Bhutan
/// </summary>
Bhutan,
/// <summary>
- /// Belize.
+ /// Belize
/// </summary>
Belize,
/// <summary>
- /// Cocos Islands.
+ /// Cocos Islands
/// </summary>
CocosIslands,
/// <summary>
- /// Central African Republic.
+ /// Central African Republic
/// </summary>
CentralAfricanRepublic,
/// <summary>
- /// Cook Islands.
+ /// Cook Islands
/// </summary>
CookIslands,
/// <summary>
- /// Costa Rica.
+ /// Costa Rica
/// </summary>
CostaRica,
/// <summary>
- /// Christmas Islands.
+ /// Christmas Islands
/// </summary>
ChristmasIslands,
/// <summary>
- /// Cyprus.
+ /// Cyprus
/// </summary>
Cyprus,
/// <summary>
- /// Djibouti.
+ /// Djibouti
/// </summary>
Djibouti,
/// <summary>
- /// Denmark.
+ /// Denmark
/// </summary>
Denmark,
/// <summary>
- /// Ecuador.
+ /// Ecuador
/// </summary>
Ecuador,
/// <summary>
- /// Eritrea.
+ /// Eritrea
/// </summary>
Eritrea,
/// <summary>
- /// Fiji.
+ /// Fiji
/// </summary>
Fiji,
/// <summary>
- /// Falkland Islands.
+ /// Falkland Islands
/// </summary>
FalklandIslands,
/// <summary>
- /// Federated States of Micronesia.
+ /// Micronesia, Federated States of
/// </summary>
Micronesia,
/// <summary>
- /// Faroe Islands.
+ /// Faroe Islands
/// </summary>
FaroeIslands,
/// <summary>
- /// Georgia.
+ /// Georgia
/// </summary>
Georgia,
/// <summary>
- /// French Guiana.
+ /// French Guiana
/// </summary>
FrenchGuiana,
/// <summary>
- /// Gibraltar.
+ /// Gibraltar
/// </summary>
Gibraltar,
/// <summary>
- /// Guadeloupe.
+ /// Guadeloupe
/// </summary>
Guadeloupe,
/// <summary>
- /// Equatorial Guinea.
+ /// Equatorial Guinea
/// </summary>
EquatorialGuinea,
/// <summary>
- /// Guatemala.
+ /// Guatemala
/// </summary>
Guatemala,
/// <summary>
- /// Guyana.
+ /// Guyana
/// </summary>
Guyana,
/// <summary>
- /// Hong Kong.
+ /// Hong Kong
/// </summary>
HongKong,
/// <summary>
- /// Honduras.
+ /// Honduras
/// </summary>
Honduras,
/// <summary>
- /// Croatia.
+ /// Croatia
/// </summary>
Croatia,
/// <summary>
- /// Haiti.
+ /// Haiti
/// </summary>
Haiti,
/// <summary>
- /// Israel.
+ /// Israel
/// </summary>
Israel,
/// <summary>
- /// British Indian Ocean Territory/Diego Garcia.
+ /// British Indian Ocean Territory / Diego Garcia
/// </summary>
DiegoGarcia,
/// <summary>
- /// Iraq.
+ /// Iraq
/// </summary>
Iraq,
/// <summary>
- /// Kyrgyzstan.
+ /// Kyrgyzstan
/// </summary>
Kyrgyzstan,
/// <summary>
- /// Cambodia.
+ /// Cambodia
/// </summary>
Cambodia,
/// <summary>
- /// Democratic People's Republic of Korea.
+ /// Korea, Dem. People's Rep. of
/// </summary>
NorthKorea,
/// <summary>
- /// Kuwait.
+ /// Kuwait
/// </summary>
Kuwait,
/// <summary>
- /// Lao People's Democratic Republic.
+ /// Lao People's Dem. Rep.
/// </summary>
Laos,
/// <summary>
- /// Lebanon.
+ /// Lebanon
/// </summary>
Lebanon,
/// <summary>
- /// Liechtenstein.
+ /// Liechtenstein
/// </summary>
Liechtenstein,
/// <summary>
- /// Liberia.
+ /// Liberia
/// </summary>
Liberia,
/// <summary>
- /// Libya, The Socialist People's Libyan Arab Jamahiriva.
+ /// Libya (Soc. People's Libyan Arab Jamahiriva)
/// </summary>
Libya,
/// <summary>
- /// Monaco.
+ /// Monaco
/// </summary>
Monaco,
/// <summary>
- /// Montenegro.
+ /// Montenegro
/// </summary>
Montenegro,
/// <summary>
- /// Saint Martin, French part.
+ /// Saint Martin, French part
/// </summary>
SaintMartin,
/// <summary>
- /// Marshall Islands.
+ /// Marshall Islands
/// </summary>
MarshallIslands,
/// <summary>
- /// Mali.
+ /// Mali
/// </summary>
Mali,
/// <summary>
- /// Myanmar.
+ /// Myanmar
/// </summary>
Myanmar,
/// <summary>
- /// Mongolia.
+ /// Mongolia
/// </summary>
Mongolia,
/// <summary>
- /// Macao, China.
+ /// Macao, China
/// </summary>
Macao,
/// <summary>
- /// French Department of Martinique.
+ /// Martinique (French Dept. of)
/// </summary>
Martinique,
/// <summary>
- /// Malta.
+ /// Malta
/// </summary>
Malta,
/// <summary>
- /// Maldives.
+ /// Maldives
/// </summary>
Maldives,
/// <summary>
- /// Malawi.
+ /// Malawi
/// </summary>
Malawi,
/// <summary>
- /// Mexico.
+ /// Mexico
/// </summary>
Mexico,
/// <summary>
- /// Malaysia.
+ /// Malaysia
/// </summary>
Malaysia,
/// <summary>
- /// New Caledonia.
+ /// New Caledonia
/// </summary>
NewCaledonia,
/// <summary>
- /// Niger.
+ /// Niger
/// </summary>
Niger,
/// <summary>
- /// Norfolk Island.
+ /// Norfolk Island
/// </summary>
NorfolkIsland,
/// <summary>
- /// Nicaragua.
+ /// Nicaragua
/// </summary>
Nicaragua,
/// <summary>
- /// Nepal.
+ /// Nepal
/// </summary>
Nepal,
/// <summary>
- /// Nauru.
+ /// Nauru
/// </summary>
Nauru,
/// <summary>
- /// Niue.
+ /// Niue
/// </summary>
Niue,
/// <summary>
- /// New Zealand.
+ /// New Zealand
/// </summary>
NewZealand,
/// <summary>
- /// Oman.
+ /// Oman
/// </summary>
Oman,
/// <summary>
- /// Panama.
+ /// Panama
/// </summary>
Panama,
/// <summary>
- /// French Polynesia.
+ /// French Polynesia
/// </summary>
FrenchPolynesia,
/// <summary>
- /// Papua New Guinea.
+ /// Papua New Guinea
/// </summary>
PapuaNewGuinea,
/// <summary>
- /// Philippines.
+ /// Philippines
/// </summary>
Philippines,
/// <summary>
- /// Pakistan.
+ /// Pakistan
/// </summary>
Pakistan,
/// <summary>
- /// Saint Pierre and Miquelon.
+ /// Saint Pierre and Miquelon
/// </summary>
SaintPierreAndMiquelon,
/// <summary>
- /// Palestine.
+ /// Palestine
/// </summary>
Palestine,
/// <summary>
- /// Palau.
+ /// Palau
/// </summary>
Palau,
/// <summary>
- /// Paraguay.
+ /// Paraguay
/// </summary>
Paraguay,
/// <summary>
- /// Qatar.
+ /// Qatar
/// </summary>
Qatar,
/// <summary>
- /// Reunion.
+ /// Reunion
/// </summary>
Reunion,
/// <summary>
- /// Rwanda.
+ /// Rwanda
/// </summary>
Rwanda,
/// <summary>
- /// Solomon Islands.
+ /// Solomon Islands
/// </summary>
SolomonIslands,
/// <summary>
- /// Seychelles.
+ /// Seychelles
/// </summary>
Seychelles,
/// <summary>
- /// Singapore.
+ /// Singapore
/// </summary>
Singapore,
/// <summary>
- /// Slovenia.
+ /// Slovenia
/// </summary>
Slovenia,
/// <summary>
- /// San Marino.
+ /// San Marino
/// </summary>
SanMarino,
/// <summary>
- /// Suriname.
+ /// Suriname
/// </summary>
Suriname,
/// <summary>
- /// South Sudan.
+ /// South Sudan
/// </summary>
SouthSudan,
/// <summary>
- /// El Salvador.
+ /// El Salvador
/// </summary>
ElSalvador,
/// <summary>
- /// Syrian Arab Republic.
+ /// Syrian Arab Republic
/// </summary>
SyrianArabRepublic,
/// <summary>
- /// Chad.
+ /// Chad
/// </summary>
Chad,
/// <summary>
- /// Tajikistan.
+ /// Tajikistan
/// </summary>
Tajikistan,
/// <summary>
- /// Tokelau.
+ /// Tokelau
/// </summary>
Tokelau,
/// <summary>
- /// Timor-Leste (East Timor).
+ /// Timor-Leste (East Timor)
/// </summary>
TimorLeste,
/// <summary>
- /// Turkmenistan.
+ /// Turkmenistan
/// </summary>
Turkmenistan,
/// <summary>
- /// Tonga.
+ /// Tonga
/// </summary>
Tonga,
/// <summary>
- /// Tuvalu.
+ /// Tuvalu
/// </summary>
Tuvalu,
/// <summary>
- /// Tanzania.
+ /// Tanzania
/// </summary>
Tanzania,
/// <summary>
- /// Ukraine.
+ /// Ukraine
/// </summary>
Ukraine,
/// <summary>
- /// Uruguay.
+ /// Uruguay
/// </summary>
Uruguay,
/// <summary>
- /// Uzbekistan.
+ /// Uzbekistan
/// </summary>
Uzbekistan,
/// <summary>
- /// Vatican City.
+ /// Vatican City
/// </summary>
VaticanCity,
/// <summary>
- /// Vanuatu.
+ /// Vanuatu
/// </summary>
Vanuatu,
/// <summary>
- /// Wallis and Futuna.
+ /// Wallis and Futuna
/// </summary>
WallisAndFutuna,
/// <summary>
- /// Samoa.
+ /// Samoa
/// </summary>
Samoa,
/// <summary>
- /// Yemen.
+ /// Yemen
/// </summary>
Yemen,
/// <summary>
- /// Mayotte.
+ /// Mayotte
/// </summary>
Mayotte,
/// <summary>
- /// The current system value.
+ /// Current System Value
/// </summary>
System
}
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// The CalendarDatabase provides methods to manage calendar information from/to the database.
+ /// CalendarDatabase provides methods to manage calendar information from/to the database.
/// </summary>
/// <remarks>
- /// This class allows user to access/create/update/delete database operations for the calendar information.
- /// The CalendarDatabase is created by the CalendarManager.
+ /// This class allows user to access/create/update/delete db operations for calendar information.
+ /// CalendarDatabase is created by CalendarManager.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public class CalendarDatabase
}
/// <summary>
- /// Gets the last successful changed calendar database version on the current connection.
+ /// Gets last successful changed calendar database version on the current connection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <returns>The last successful changed calendar database version on the current connection.</returns>
+ /// <returns>The last successful changed calendar database version on the current connection</returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <value>The last successful changed calendar database version on the current connection.</value>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int LastChangeVersion
/// Inserts a record into the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be inserted.</param>
- /// <returns>The ID of inserted record.</returns>
+ /// <param name="record">The record to be inserted</param>
+ /// <returns>The ID of inserted record</returns>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(CalendarRecord record)
{
/// Gets a record from the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of a record.</param>
- /// <param name="recordId">The record ID.</param>
+ /// <param name="viewUri">The view URI of a record</param>
+ /// <param name="recordId">The record ID</param>
/// <returns>
- /// The record associated with the record ID.
+ /// The record associated with the record ID
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarRecord Get(string viewUri, int recordId)
/// Updates a record in the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be updated.</param>
+ /// <param name="record">The record to be updated</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarRecord record)
{
/// Deletes a record from the calendar database with related child records.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of a record.</param>
- /// <param name="recordId">The record ID to be deleted.</param>
+ /// <param name="viewUri">The view URI of a record</param>
+ /// <param name="recordId">The record ID to be deleted</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int recordId)
/// Replaces a record in the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be replaced.</param>
- /// <param name="id">The record ID.</param>
+ /// <param name="record">The record to be replaced</param>
+ /// <param name="id">the record id</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarRecord record, int id)
{
}
/// <summary>
- /// Retrieves all the records as a list.
+ /// Retrieves all records as a list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from.</param>
- /// <param name="offset">The index from which results are received.</param>
- /// <param name="limit">The maximum number of results (value 0 is used for all the records).</param>
+ /// <param name="viewUri">The view URI to get records from</param>
+ /// <param name="offset">The index from which results are received</param>
+ /// <param name="limit">The maximum number of results(value 0 is used for all records)</param>
/// <returns>
- /// The record list.
+ /// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetAll(string viewUri, int offset, int limit)
}
/// <summary>
- /// Retrieves the records using a query.
+ /// Retrieves records using a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="query">The query used to filter results.</param>
- /// <param name="offset">The index from which results are received.</param>
- /// <param name="limit">The maximum number of results (value 0 is used for all the records).</param>
+ /// <param name="query">The query used to filter results</param>
+ /// <param name="offset">The index from which results are received</param>
+ /// <param name="limit">The maximum number of results(value 0 is used for all records)</param>
/// <returns>
- /// CalendarList.
+ /// CalendarList
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public CalendarList GetRecordsWithQuery(CalendarQuery query, int offset, int limit)
{
/// Inserts multiple records into the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list.</param>
+ /// <param name="list">The record list</param>
/// <returns>
- /// The inserted record ID array.
+ /// The inserted record id array
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(CalendarList list)
{
/// Updates multiple records into the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list.</param>
+ /// <param name="list">The record list</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarList list)
{
}
/// <summary>
- /// Deletes multiple records with the related child records from the calendar database as a batch operation.
+ /// Deletes multiple records with related child records from the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the records to delete.</param>
- /// <param name="idArray">The record IDs to delete.</param>
+ /// <param name="viewUri">The view URI of the records to delete</param>
+ /// <param name="idArray">The record IDs to delete</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int[] idArray)
}
/// <summary>
- /// Deletes multiple records with the related child records from the calendar database as a batch operation.
+ /// Deletes multiple records with related child records from the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list.</param>
+ /// <param name="list">The record list</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
public void Delete(CalendarList list)
{
CalendarRecord record = null;
/// Replaces multiple records in the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list.</param>
- /// <param name="idArray">The record IDs.</param>
+ /// <param name="list">The record list</param>
+ /// <param name="idArray">The record IDs</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarList list, int[] idArray)
{
}
/// <summary>
- /// Retrieves the records with the given calendar database version.
+ /// Retrieves records with the given calendar database version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from.</param>
- /// <param name="BookId">The calendar book ID to filter.</param>
- /// <param name="calendarDBVersion">The calendar database version.</param>
- /// <param name="currentDBVersion">The current calendar database version.</param>
+ /// <param name="viewUri">The view URI to get records from</param>
+ /// <param name="BookId">The calendar book ID to filter</param>
+ /// <param name="calendarDBVersion">The calendar database version</param>
+ /// <param name="currentDBVersion">The current calendar database version</param>
/// <returns>
- /// The record list.
+ /// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetChangesByVersion(string viewUri, int BookId, int calendarDBVersion, out int currentDBVersion)
/// Gets the record count of a specific view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from.</param>
+ /// <param name="viewUri">The view URI to get records from</param>
/// <returns>
- /// The count of records.
+ /// The count of records
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
/// Gets the record count with a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="query">The query used for filtering the results.</param>
+ /// <param name="query">The query used for filtering the results</param>
/// <returns>
- /// The count of records.
+ /// The count of records
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
/// Registers a callback function to be invoked when a record changes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the record to subscribe for change notifications.</param>
- /// <param name="DBChanged">The EventHandler to register.</param>
+ /// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
+ /// <param name="DBChanged">The EventHandler to register</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
/// Deregisters a callback function.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the record to subscribe for change notifications.</param>
- /// <param name="DBChanged">The EventHandler to deregister.</param>
+ /// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
+ /// <param name="DBChanged">The EventHandler to deregister</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
}
/// <summary>
- /// Links a record to another record.
+ /// Link a record to another record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="baseId">The base record ID.</param>
- /// <param name="recordId">The record ID to link to.</param>
+ /// <param name="baseId">The base record ID</param>
+ /// <param name="recordId">The record ID to link to</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
public void LinkRecord(int baseId, int recordId)
{
}
/// <summary>
- /// Unlinks a record from the base record.
+ /// Unlink a record from base record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="recordId">The record ID to unlink.</param>
+ /// <param name="recordId">The record ID to unlink</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void UnlinkRecord(int recordId)
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue)
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for a long type.
+ /// Creates a filter with a condition for long type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for a double type.
+ /// Creates a filter with a condition for double type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for the CalendarTime type.
+ /// Creates a filter with a condition for CalendarTime type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue)
{
}
/// <summary>
- /// Destroys the filter.
+ /// Destroy filter.
/// </summary>
~CalendarFilter()
{
public enum StringMatchType
{
/// <summary>
- /// Full string, case-sensitive.
+ /// Full string, case-sensitive
/// </summary>
Exactly,
/// <summary>
- /// Full string, case-insensitive.
+ /// Full string, case-insensitive
/// </summary>
FullString,
/// <summary>
- /// Sub-string, case-insensitive.
+ /// Sub string, case-insensitive
/// </summary>
Contains,
/// <summary>
- /// Starts with, case-insensitive.
+ /// Start with, case-insensitive
/// </summary>
StartsWith,
/// <summary>
- /// Ends with, case-insensitive.
+ /// End with, case-insensitive
/// </summary>
EndsWith,
/// <summary>
- /// IS NOT NULL.
+ /// IS NOT NUL
/// </summary>
Exists,
}
/// </summary>
LessThanOrEqual,
/// <summary>
- /// <>, this flag can yield poor performance.
+ /// <>, this flag can yield poor performance
/// </summary>
NotEqual,
/// <summary>
- /// IS NULL.
+ /// IS NULL
/// </summary>
None,
}
public enum LogicalOperator
{
/// <summary>
- /// And.
+ /// AND
/// </summary>
And,
/// <summary>
- /// Or.
+ /// OR
/// </summary>
Or,
}
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Dispose.
+ /// Dispose
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the CalendarFilter.
- /// It should be called after having finished using the object.
+ /// Releases all resources used by the CalendarFilter.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="filter">The child filter.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="filter">The child filter</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddFilter(LogicalOperator logicalOperator, CalendarFilter filter)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
public CalendarList()
{
int error = Interop.List.Create(out _listHandle);
/// The count of the calendar entity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The count of the calendar entity.</value>
+ /// <value>The count of calendar entity.</value>
public int Count
{
get
}
/// <summary>
- /// Destroys the CalendarList resource.
+ /// Destroy CalendarList resource.
/// </summary>
~CalendarList()
{
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Disposes off the resources (other than memory) used by the CalendarList.
+ /// Disposes of the resources (other than memory) used by the CalendarList.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
/// <summary>
/// Releases all resources used by the CalendarList.
- /// It should be called after it has finished using the object.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// Adds a record to the calendar list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be added.</param>
+ /// <param name="record">The record to be added</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public void AddRecord(CalendarRecord record)
{
int error = Interop.List.Add(_listHandle, record._recordHandle);
/// Removes a record from the calendar list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be removed.</param>
+ /// <param name="record">The record to be removed</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public void RemoveRecord(CalendarRecord record)
{
int error = Interop.List.Remove(_listHandle, record._recordHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// The calendar record.
+ /// calendar record
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public CalendarRecord GetCurrentRecord()
{
IntPtr handle;
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// If the cursor is moved to the end, it returns false.
+ /// if cursor is moved to the end, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public bool MovePrevious()
{
int error = Interop.List.Prev(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// If the cursor is moved to the end, it returns false.
+ /// if cursor is moved to the end, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public bool MoveNext()
{
int error = Interop.List.Next(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public void MoveFirst()
{
int error = Interop.List.First(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public void MoveLast()
{
int error = Interop.List.Last(_listHandle);
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A class for managing the calendar information. It allows the applications to use the calendar service.
+ /// A class for managing calendar information. It allows applications to use calendar service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CalendarManager : IDisposable
private CalendarDatabase _db = null;
/// <summary>
- /// Creates a manager.
+ /// Create a manager.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
public CalendarManager()
{
int error = Interop.Service.Connect();
}
/// <summary>
- /// Destroys the CalendarManager resource.
+ /// Destroy CalendarManager resource.
/// </summary>
~CalendarManager()
{
}
#region IDisposable Support
- /// To detect redundant calls.
+ /// To detect redundant calls
private bool disposedValue = false;
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarManager.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the CalendarManager.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the CalendarManager.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Gets the database.
+ /// Get database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The database instance.</value>
+ /// <value>The database instance</value>
public CalendarDatabase Database
{
get
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A query is used to retrieve the data, which satisfies the given criteria.
+ /// A query is used to retrieve data which satisfies given criteria.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// A query is used to retrieve the calendar data, which satisfies a given criteria,
+ /// A query is used to retrieve calendar data which satisfies a given criteria,
/// such as an integer property being greater than a given value,
/// or a string property containing a given substring.
- /// A query needs a filter, which can set the conditions for the search.
+ /// A query needs a filter which can set the conditions for the search.
/// </remarks>
public class CalendarQuery:IDisposable
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a query.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI of a query</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarQuery(string viewUri)
{
}
/// <summary>
- /// Destructor.
+ /// Destructor
/// </summary>
~CalendarQuery()
{
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarQuery.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the CalendarQuery.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the CalendarQuery.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Adds the property IDs for projection.
+ /// Adds property IDs for projection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyIdArray">The property ID array.</param>
+ /// <param name="propertyIdArray">The property ID array </param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void SetProjection(uint[] propertyIdArray)
{
if (propertyIdArray == null)
/// Sets the "distinct" option for projection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="set">If true it is set, otherwise if false it is unset.</param>
+ /// <param name="set">If true it is set, otherwise if false it is unset</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
public void SetDistinct(bool set)
{
int error = Interop.Query.SetDistinct(_queryHandle, set);
/// Sets the filter for a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="filter">The filter.</param>
+ /// <param name="filter">The filter</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void SetFilter(CalendarFilter filter)
{
int error = Interop.Query.SetFilter(_queryHandle, filter._filterHandle);
/// Sets the sort mode for a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID to sort.</param>
- /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order.</param>
+ /// <param name="propertyId">The property ID to sort</param>
+ /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void SetSort(uint propertyId, bool isAscending)
{
int error = Interop.Query.SetSort(_queryHandle, propertyId, isAscending);
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A record represents an actual record in the database.
+ /// A record represents an actual record in the database
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
/// A record represents an actual record in the database,
- /// but you can also consider it a piece of information, such as an alarm, attendee, and extended.
+ /// but you can also consider it a piece of information, such as an alarm, attendee and extended.
/// A record can be a complex set of data, containing other data.
/// For example, a calendar record contains the alarm property, which is a reference to an alarm record.
/// An alarm record could belong to a event record,
- /// and its alarm ID property is set to the identifier of the corresponding event.
- /// In this case, the alarm is the child record of the event, and the event is the parent record.
+ /// and its alarm id property is set to the identifier of the corresponding event.
+ /// In this case, the alarm is the child record of the event and the event is the parent record.
/// </remarks>
public class CalendarRecord : IDisposable
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI.</param>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="viewUri">The view URI</param>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarRecord(string viewUri)
{
}
/// <summary>
- /// Destructor.
+ /// Destructor
/// </summary>
~CalendarRecord()
{
}
#region IDisposable Support
- /// To detect redundant calls.
+ /// To detect redundant calls
internal bool _disposedValue = false;
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarRecord.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the CalendarRecord.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the CalendarRecord.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// A cloned record.
+ /// A cloned record
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
public CalendarRecord Clone()
{
IntPtr _clonedRecordHandle;
/// Adds a child record to the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="childRecord">The child record.</param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="childRecord">The child record</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void AddChildRecord(uint propertyId, CalendarRecord childRecord)
{
int error = Interop.Record.AddChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
/// Removes a child record from the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="childRecord">The child record.</param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="childRecord">The child record</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public void RemoveChildRecord(uint propertyId, CalendarRecord childRecord)
{
int error = Interop.Record.RemoveChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
}
/// <summary>
- /// Gets a child record from the parent record.
+ /// Gets a child record from the parent record
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID.</param>
+ /// <param name="propertyId">The property ID</param>
/// <returns>
- /// The number of child records corresponding to property ID.
+ /// The number of child records corresponding to property ID
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public int GetChildRecordCount(uint propertyId)
{
int count = 0;
}
/// <summary>
- /// Gets a child record from the parent record.
+ /// Gets a child record from the parent record
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="index">The child record index.</param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="index">The child record index</param>
/// <returns>
- /// The record.
+ /// The record
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public CalendarRecord GetChildRecord(uint propertyId, int index)
{
IntPtr handle;
}
/// <summary>
- /// Clones a child record list corresponding to property ID.
+ /// Clones a child record list corresponding to property ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID.</param>
+ /// <param name="propertyId">The property ID</param>
/// <returns>
- /// The record list.
+ /// the record list
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
public CalendarList CloneChildRecordList(uint propertyId)
{
IntPtr listHandle;
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A class for the reminder for an event.
+ /// A class for reminder for event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// The client who wants to be alerted at a specific time should register MIME ("application/x-tizen.calendar.reminder") type in manifest.xml file.
+ /// The client who wants to be alerted at specific time should register MIME("application/x-tizen.calendar.reminder") type in manifest.xml file.
/// </remarks>
public class CalendarReminder:IDisposable
{
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarReminder.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the CalendarReminder.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the CalendarReminder.
+ /// It should be called after having finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
private static event EventHandler<ReminderAlertedEventArgs> s_reminderAlerted;
/// <summary>
- /// The Reminder event is triggered when the alarm is alerted.
+ /// Reminder event is triggered when the alarm is alerted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<ReminderAlertedEventArgs> ReminderAlerted
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A class for the time to set, get, or calculate.
+ /// A class for time to set, get or calculate.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CalendarTime:IComparable<CalendarTime>
public enum Type
{
/// <summary>
- /// UTC time.
+ /// UTC time
/// </summary>
/// <since_tizen> 4 </since_tizen>
Utc,
/// <summary>
- /// Local time.
+ /// Local time
/// </summary>
/// <since_tizen> 4 </since_tizen>
Local
}
/// <summary>
- /// Creates the UTC CalendarTime.
+ /// Create UTC CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="utcTime">The UTC epoch time. 0 is 1971/01/01.</param>
+ /// <param name="utcTime">UTC epoch time. 0 is 1971/01/01</param>
public CalendarTime(long utcTime)
{
_type = (int)Type.Utc;
}
/// <summary>
- /// Creates the local CalendarTime
+ /// Create Local CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="year">The year.</param>
- /// <param name="month">The month.</param>
- /// <param name="day">The day.</param>
- /// <param name="hour">The hour.</param>
- /// <param name="minute">The minute.</param>
- /// <param name="second">The second.</param>
+ /// <param name="year">year</param>
+ /// <param name="month">month</param>
+ /// <param name="day">day</param>
+ /// <param name="hour">hour</param>
+ /// <param name="minute">minute</param>
+ /// <param name="second">second</param>
public CalendarTime(int year, int month, int day, int hour, int minute, int second)
{
_type = (int)Type.Local;
}
/// <summary>
- /// Gets the UtcTime.
+ /// Get UtcTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The UTC time.</value>
+ /// <value>The Utc time</value>
public DateTime UtcTime
{
get;
}
/// <summary>
- /// Gets the LocalTime
+ /// Get localTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The local time.</value>
+ /// <value>The Localtime</value>
public DateTime LocalTime
{
get;
}
/// <summary>
- /// Compares the CalendarTime.
+ /// Compare CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="other">The CalendarTime to be compared.</param>
+ /// <param name="other">The CalendarTime to be compared</param>
/// <returns>
/// A 32-bit signed integer that indicates the relative order of the objects being compared.
/// </returns>
}
/// <summary>
- /// Equals the CalendarTime.
+ /// Equals CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="obj">The CalendarTime to be compared.</param>
+ /// <param name="obj">The CalendarTime to be compared</param>
/// <returns>
/// A 32-bit signed integer that indicates the relative order of the objects being compared.
/// </returns>
}
/// <summary>
- /// The GetHashCode for the CalendarTime.
+ /// GetHashCode CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// This class provides enumerations about the calendar information.
+ /// This class provides enumerations about calendar information.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// Most enumerations are based on vCalendar and iCalendar(ver 2.0) specification.
+ /// Most enumerations are based on vcalendar, icalendar(ver 2.0) specification.
/// https://www.ietf.org/rfc/rfc2445.txt
/// </remarks>
public static class CalendarTypes
{
/// <summary>
- /// Enumeration for the default books.
+ /// Enumeration for Default book
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DefaultBook
{
/// <summary>
- /// The default event calendar book.
+ /// Default event calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event,
/// <summary>
- /// The default todo calendar book.
+ /// Default Todo calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Todo,
/// <summary>
- /// The default birthday calendar book.
+ /// Default Birthday calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Birthday,
}
/// <summary>
- /// Enumeration for the store types.
+ /// Enumeration for Store type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum StoreType
{
/// <summary>
- /// Book type.
+ /// Book type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Book,
/// <summary>
- /// Event type.
+ /// Event type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event,
/// <summary>
- /// Todo type.
+ /// Todo type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Todo,
}
/// <summary>
- /// Enumeration for the book modes.
+ /// Enumeration for the book mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum BookMode
{
/// <summary>
- /// All modules can read and write records of this calendar book.
+ /// All modules can read and write records of this calendar_book
/// </summary>
/// <since_tizen> 4 </since_tizen>
Default,
/// <summary>
- /// All modules can only read records of this calendar book.
+ /// All modules can only read records of this calendar book
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReadOnly,
public enum EventStatus
{
/// <summary>
- /// No status.
+ /// No status
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x01,
/// <summary>
- /// The event is tentative.
+ /// The event is tentative
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative = 0x02,
/// <summary>
- /// The event is confirmed.
+ /// The event is confirmed
/// </summary>
/// <since_tizen> 4 </since_tizen>
Confirmed = 0x04,
/// <summary>
- /// The event is cancelled.
+ /// The event is cancelled
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled = 0x08,
}
/// <summary>
- /// Enumeration for the status of a to-do.
+ /// Enumeration for for the status of a to-do.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TodoStatus
{
/// <summary>
- /// No status.
+ /// No status
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x0100,
/// <summary>
- /// Needs action status.
+ /// Needs action status
/// </summary>
/// <since_tizen> 4 </since_tizen>
NeedAction = 0x0200,
/// <summary>
- /// Completed status.
+ /// Completed status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Completed = 0x0400,
/// <summary>
- /// Work in process status.
+ /// Work in process status
/// </summary>
/// <since_tizen> 4 </since_tizen>
InProcess = 0x0800,
/// <summary>
- /// Cancelled status.
+ /// Cancelled status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled = 0x1000,
public enum BusyStatus
{
/// <summary>
- /// The free status.
+ /// The free status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Free,
/// <summary>
- /// The busy status.
+ /// The busy status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Busy,
/// <summary>
- /// The unavailable status.
+ /// The unavailable status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Unavailable,
/// <summary>
- /// The tentative status.
+ /// The tentative status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative,
public enum Sensitivity
{
/// <summary>
- /// Public sensitivity.
+ /// Public Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
Public,
/// <summary>
- /// Private sensitivity.
+ /// Private Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
Private,
/// <summary>
- /// Confidential sensitivity.
+ /// Confidential Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
Confidential,
public enum MeetingStatus
{
/// <summary>
- /// No meeting.
+ /// No meeting
/// </summary>
/// <since_tizen> 4 </since_tizen>
NoMeeting,
/// <summary>
- /// Meeting exists.
+ /// Meeting exists
/// </summary>
/// <since_tizen> 4 </since_tizen>
Meeting,
/// <summary>
- /// Meeting received.
+ /// Meeting received
/// </summary>
/// <since_tizen> 4 </since_tizen>
Received,
/// <summary>
- /// Meeting canceled.
+ /// Meeting cancelled
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled,
}
/// <summary>
- /// Enumeration for the calendar event item's priority.
+ /// Enumeration for the calendar event item's priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Priority
{
/// <summary>
- /// No priority.
+ /// No priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x01,
/// <summary>
- /// Low priority.
+ /// Low priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
High = 0x02,
/// <summary>
- /// Normal priority.
+ /// Normal priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
Normal = 0x04,
/// <summary>
- /// High priority.
+ /// High priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
Low = 0x08,
public enum Recurrence
{
/// <summary>
- /// No recurrence event.
+ /// No recurrence event
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// An event occurs every day.
+ /// An event occurs every day
/// </summary>
/// <since_tizen> 4 </since_tizen>
Daily,
/// <summary>
- /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week.
+ /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week
/// </summary>
/// <since_tizen> 4 </since_tizen>
Weekly,
/// <summary>
- /// An event occurs on the same day of every month.
+ /// An event occurs on the same day of every month
/// </summary>
/// <since_tizen> 4 </since_tizen>
Monthly,
/// <summary>
- /// An event occurs on the same day of every year.
+ /// An event occurs on the same day of every year
/// </summary>
/// <since_tizen> 4 </since_tizen>
Yearly,
}
/// <summary>
- /// Enumeration for the range types.
+ /// Enumeration for the range type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum RangeType
{
/// <summary>
- /// Range until.
+ /// Range until
/// </summary>
/// <since_tizen> 4 </since_tizen>
Until,
/// <summary>
- /// Range count.
+ /// Range count
/// </summary>
/// <since_tizen> 4 </since_tizen>
Count,
/// <summary>
- /// No range.
+ /// No range
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
}
/// <summary>
- /// Enumeration for the system types.
+ /// Enumeration for the system type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SystemType
{
/// <summary>
- /// Locale's default calendar.
+ /// Locale's default calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
Default,
/// <summary>
- /// Locale's default calendar.
+ /// Locale's default calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
Gregorian,
/// <summary>
- /// East Asian lunisolar calendar.
+ /// East Asian lunisolar calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
Lunisolar,
public enum TickUnit
{
/// <summary>
- /// No reminder set.
+ /// No reminder set
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = -1,
/// <summary>
- /// Specific in seconds.
+ /// Specific in seconds
/// </summary>
/// <since_tizen> 4 </since_tizen>
Specific = 1,
/// <summary>
- /// Alarm time unit in minutes.
+ /// Alarm time unit in minutes
/// </summary>
/// <since_tizen> 4 </since_tizen>
Minute = 60,
/// <summary>
- /// Alarm time unit in hours.
+ /// Alarm time unit in hours
/// </summary>
/// <since_tizen> 4 </since_tizen>
Hour = 3600,
/// <summary>
- /// Alarm time unit in days.
+ /// Alarm time unit in days
/// </summary>
/// <since_tizen> 4 </since_tizen>
Day = 86400,
/// <summary>
- /// Alarm time unit in weeks.
+ /// Alarm time unit in weeks
/// </summary>
/// <since_tizen> 4 </since_tizen>
Week = 604800,
public enum WeekDay
{
/// <summary>
- /// Sunday.
+ /// Sunday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sunday = 1,
/// <summary>
- /// Monday.
+ /// Monday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Monday,
/// <summary>
- /// Tuesday.
+ /// Tuesday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tuesday,
/// <summary>
- /// Wednesday.
+ /// Wednesday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Wednesday,
/// <summary>
- /// Thursday.
+ /// Thursday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Thursday,
/// <summary>
- /// Friday.
+ /// Friday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Friday,
/// <summary>
- /// Saturday.
+ /// Saturday
/// </summary>
/// <since_tizen> 4 </since_tizen>
Saturday,
}
/// <summary>
- /// Enumeration to specify the type of calendar user, specified by the property.
+ /// Enumeration to specify the type of calendar user specified by the property.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Cutype
{
/// <summary>
- /// An individual.
+ /// An individual
/// </summary>
/// <since_tizen> 4 </since_tizen>
Individual,
/// <summary>
- /// A group of individuals.
+ /// A group of individuals
/// </summary>
/// <since_tizen> 4 </since_tizen>
Group,
/// <summary>
- /// A physical resource.
+ /// A physical resource
/// </summary>
/// <since_tizen> 4 </since_tizen>
Resource,
/// <summary>
- /// A room resource.
+ /// A room resource
/// </summary>
/// <since_tizen> 4 </since_tizen>
Room,
/// <summary>
- /// Otherwise not known.
+ /// Otherwise not known
/// </summary>
/// <since_tizen> 4 </since_tizen>
Unknown,
}
/// <summary>
- /// Enumeration for the attendee roles.
+ /// Enumeration for the attendee role.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AttendeeRole
{
/// <summary>
- /// Participation is required.
+ /// Participation is required
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReqParticipant,
/// <summary>
- /// Accepted status.
+ /// Accepted status
/// </summary>
/// <since_tizen> 4 </since_tizen>
OptParticipant,
/// <summary>
- /// Non-Participant.
+ /// Non-Participant
/// </summary>
/// <since_tizen> 4 </since_tizen>
NonParticipant,
/// <summary>
- /// Chairperson.
+ /// Chairperson
/// </summary>
/// <since_tizen> 4 </since_tizen>
Chair,
public enum AttendeeStatus
{
/// <summary>
- /// Pending status.
+ /// Pending status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Pending,
/// <summary>
- /// Accepted status.
+ /// Accepted status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Accepted,
/// <summary>
- /// Declined status.
+ /// Declined status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Declined,
/// <summary>
- /// Tentative status.
+ /// Tentative status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative,
/// <summary>
- /// Delegated status.
+ /// Delegated status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Delegated,
/// <summary>
- /// Completed status.
+ /// Completed status
/// </summary>
/// <since_tizen> 4 </since_tizen>
Completed,
/// <summary>
- /// In process status.
+ /// In process status
/// </summary>
/// <since_tizen> 4 </since_tizen>
InProcess,
}
/// <summary>
- /// Enumeration for the alarm actions.
+ /// Enumeration for the alarm action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Action
{
/// <summary>
- /// Audio action.
+ /// Audio action
/// </summary>
/// <since_tizen> 4 </since_tizen>
Audio,
/// <summary>
- /// Display action.
+ /// Display action
/// </summary>
/// <since_tizen> 4 </since_tizen>
Display,
/// <summary>
- /// Email action.
+ /// Email action
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email,
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// Parsing the vCalendar file callback function.
+ /// Parsing vcalendar file callback function.
/// </summary>
- /// <param name="record">The record.</param>
- /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop.</returns>
+ /// <param name="record">The record</param>
+ /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop</returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool ParseCallback(CalendarRecord record);
/// <summary>
- /// A class for parsing and composing the vCalendar.
+ /// A class for parsing and composing vCalendar.
/// </summary>
/// <remarks>
- /// It's based on the vCalendar v2.0 specification.
+ /// It's based on the vCalendar v2.0 specification
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public static class CalendarVcalendar
{
/// <summary>
- /// Retrieves a vCalendar stream from a calendar list.
+ /// Retrieves a vcalendar stream from a calendar list.
/// </summary>
- /// <param name="list">The calendar list.</param>
+ /// <param name="list">The calendar list</param>
/// <returns>
/// The composed stream.
/// </returns>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
public static string Compose(CalendarList list)
{
}
/// <summary>
- /// Retrieves all the calendars from a vCalendar stream.
+ /// Retrieves all calendars from a vcalendar stream.
/// </summary>
- /// <param name="stream">The vCalendar stream.</param>
+ /// <param name="stream">The vcalendar stream</param>
/// <returns>
- /// The record list.
+ /// the record list
/// </returns>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
public static CalendarList Parse(string stream)
{
}
/// <summary>
- /// Parses the vCalendar file with ForEach.
+ /// Parse vcalendar file with ForEach
/// </summary>
- /// <param name="path">The file path of the vCalendar stream file.</param>
- /// <param name="callback">The callback function to invoke.</param>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <param name="path">The file path of the vCalendar stream file</param>
+ /// <param name="callback">he callback function to invoke</param>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
public static void ParseForEach(string path, ParseCallback callback)
{
}
/// <summary>
- /// Describes the properties of a Book record.
+ /// Describes properties of a Book record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Book
{
/// <summary>
- /// Identifier of this calendar book view.
+ /// Identifier of this calendar book view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.book";
/// <summary>
- /// Database record ID of the calendar book.
+ /// DB record ID of the calendar book
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.BookId;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.BookUid;
/// <summary>
- /// Calendar book name.
+ /// Calendar book name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.BookName;
/// <summary>
- /// Calendar book description.
+ /// Calendar book description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.BookDescription;
/// <summary>
- /// Calendar book color for UX.
+ /// Calendar book color for UX
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Color = (uint)Property.Id.BookColor;
/// <summary>
- /// Location of the event.
+ /// Location of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.BookLocation;
/// <summary>
- /// Visibility of the calendar book for UX.
+ /// Visibility of the calendar book for UX
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Visibility = (uint)Property.Id.BookVisibility;
/// <summary>
- /// Currently not used.
+ /// Currently NOT Used
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncEvent = (uint)Property.Id.BookSyncEvent;
/// <summary>
- /// Account for this calendar.
+ /// Account for this calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AccountId = (uint)Property.Id.BookAccountId;
/// <summary>
- /// Type of calendar contents (refer to the CalendarTypes.StoreType).
+ /// Type of calendar contents(refer to the CalendarTypes.StoreType)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StoreType = (uint)Property.Id.BookStoreType;
/// <summary>
- /// Generic data for use by syncing.
+ /// Generic data for use by syncing
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.BookSyncData1;
/// <summary>
- /// Generic data for use by syncing.
+ /// Generic data for use by syncing
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.BookSyncData2;
/// <summary>
- /// Generic data for use by syncing.
+ /// Generic data for use by syncing
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.BookSyncData3;
/// <summary>
- /// Generic data for use by syncing.
+ /// Generic data for use by syncing
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.BookSyncData4;
/// <summary>
- /// Calendar book mode (refer to the CalendarTypes.BookMode).
+ /// Calendar book mode(refer to the CalendarTypes.BookMode)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mode = (uint)Property.Id.BookMode;
}
/// <summary>
- /// Describes the properties of a Event record.
+ /// Describes properties of a Event record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")]
public static class Event
{
/// <summary>
- /// Identifier of this event view.
+ /// Identifier of this event view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.event";
/// <summary>
- /// Database record ID of the event.
+ /// DB record ID of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EventId;
/// <summary>
- /// ID of the calendar book to which the event belongs.
+ /// ID of the calendar book to which the event belongs
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.EventBookId;
/// <summary>
- /// The short description of the event.
+ /// The short description of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.EventSummary;
/// <summary>
- /// The description of the event.
+ /// The description of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.EventDescription;
/// <summary>
- /// The location of the event.
+ /// The location of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.EventLocation;
/// <summary>
- /// The category of the event. For example, appointment, birthday.
+ /// The category of the event. For example APPOINTMENT, BIRTHDAY
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.EventCategories;
/// <summary>
- /// The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma.
+ /// The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Exdate = (uint)Property.Id.EventExdate;
/// <summary>
- /// The status of event (refer to the CalendarTypes.EventStatus).
+ /// The status of event(refer to the CalendarTypes.EventStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.EventEventStatus;
/// <summary>
- /// The priority of event (refer to the CalendarTypes.Priority).
+ /// The priority of event(refer to the CalendarTypes.Priority).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.EventPriority;
/// <summary>
- /// The timezone_id of the event, if it exists.
+ /// The timezone_id of the event if it exists.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Timezone = (uint)Property.Id.EventTimezone;
/// <summary>
- /// The person_id of the event if the event is a birthday. Refer to the contacts-service.
+ /// The person_id of the event if the event is a birthday. Refer to the contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EventContactId;
/// <summary>
- /// The busy status of event (refer to the CalendarTypes.BusyStatus).
+ /// The busy status of event(refer to the CalendarTypes.BusyStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.EventBusyStatus;
/// <summary>
- /// The sensitivity of event (refer to the CalendarTypes.Sensitivity).
+ /// The Sensitivity of event(refer to the CalendarTypes.Sensitivity).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.EventSensitivity;
/// <summary>
- /// The unique ID of the event.
+ /// The unique ID of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.EventUid;
/// <summary>
- /// The name of organizer of the event.
+ /// The name of organizer of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.EventOrganizerName;
/// <summary>
- /// The email address of the organizer of the event.
+ /// The email address of the organizer of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerEmail = (uint)Property.Id.EventOrganizerEmail;
/// <summary>
- /// The meeting status of event (refer to the CalendarTypes.MeetingStatus).
+ /// The meeting status of event(refer to the CalendarTypes.MeetingStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MeetingStatus = (uint)Property.Id.EventMeetingStatus;
/// <summary>
- /// The ID of the original event, if the event is an exception.
+ /// The ID of the original event if the event is an exception.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.EventOriginalEventId;
/// <summary>
- /// The latitude of the location of the event.
+ /// The latitude of the location of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.EventLatitude;
/// <summary>
- /// The longitude of the location of the event.
+ /// The longitude of the location of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.EventLongitude;
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EventEmailId;
/// <summary>
- /// The time when the event is created.
+ /// The time when the event is created
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CreatedTime = (uint)Property.Id.EventCreatedTime;
/// <summary>
- /// The time when the event is updated.
+ /// The time when the event is updated
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.EventLastModifiedTime;
/// <summary>
- /// Whether or not the event is deleted.
+ /// Whether or not the event is deleted
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDeleted = (uint)Property.Id.EventIsDeleted;
/// <summary>
- /// The frequent type of event recurrence (refer to the CalendarTypes.Recurrence).
+ /// The frequent type of event recurrence(refer to the CalendarTypes.Recurrence).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Freq = (uint)Property.Id.EventFreq;
/// <summary>
- /// The range type of event recurrence (refer to the CalendarTypes.RangeType).
+ /// The range type of event recurrence(refer to the CalendarTypes.RangeType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RangeType = (uint)Property.Id.EventRangeType;
/// <since_tizen> 4 </since_tizen>
public const uint Count = (uint)Property.Id.EventCount;
/// <summary>
- /// The interval of the event recurrence.
+ /// The interval of the event recurrence
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Interval = (uint)Property.Id.EventInterval;
/// <summary>
- /// The second list of the event recurrence. The value can be from 0 to 59. The list is separated by commas.
+ /// The second list of the event recurrence. The value can be from 0 to 59. The list is separated by comma
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysecond = (uint)Property.Id.EventBysecond;
/// <summary>
- /// The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas.
+ /// The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byminute = (uint)Property.Id.EventByminute;
/// <summary>
- /// The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas.
+ /// The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byhour = (uint)Property.Id.EventByhour;
/// <since_tizen> 4 </since_tizen>
public const uint Bymonthday = (uint)Property.Id.EventBymonthday;
/// <summary>
- /// The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas.
+ /// The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byyearday = (uint)Property.Id.EventByyearday;
/// <summary>
- /// The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas.
+ /// The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byweekno = (uint)Property.Id.EventByweekno;
/// <summary>
- /// The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas.
+ /// The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonth = (uint)Property.Id.EventBymonth;
/// <summary>
- /// The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas.
+ /// The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysetpos = (uint)Property.Id.EventBysetpos;
/// <summary>
- /// The start day of the week (refer to the CalendarTypes.WeekDay).
+ /// The start day of the week(refer to the CalendarTypes.WeekDay).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Wkst = (uint)Property.Id.EventWkst;
/// <summary>
- /// RECURRENCE-ID of RFC #2445.
+ /// RECURRENCE-ID of RFC #2445
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RecurrenceId = (uint)Property.Id.EventRecurrenceId;
/// <summary>
- /// RDATE of RFC #2445.
+ /// RDATE of RFC #2445
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Rdate = (uint)Property.Id.EventRdate;
/// <summary>
- /// Whether or not the event has an attendee list.
+ /// Whether or not the event has an attendee list
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.EventHasAttendee;
/// <summary>
- /// Whether or not the event has an alarm list.
+ /// Whether or not the event has an alarm list
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.EventHasAlarm;
/// <summary>
- /// The sync data of the event. If the developers need to save some information related to the event, they can use this property.
+ /// The sync data of the event. If developer need to save some information related to the event, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.EventSyncData1;
/// <summary>
- /// The sync data of the event. If the developers need to save some information related to the event, they can use this property.
+ /// The sync data of the event. If developer need to save some information related to the event, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.EventSyncData2;
/// <summary>
- /// The sync data of the event. If the developers need to save some information related to the event, they can use this property.
+ /// The sync data of the event. If developer need to save some information related to the event, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.EventSyncData3;
/// <summary>
- /// The sync data of the event. If the developers need to save some information related to the event, they can use this property.
+ /// The sync data of the event. If developer need to save some information related to the event, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.EventSyncData4;
/// <summary>
- /// The start time of the event.
+ /// The start time of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.EventStart;
/// <summary>
- /// The end time of the event.
+ /// The end time of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.EventEnd;
/// <since_tizen> 4 </since_tizen>
public const uint Attendee = (uint)Property.Id.EventAttendee;
/// <summary>
- /// The calendar system type (refer to the CalendarTypes.SystemType).
+ /// The Calendar system type(refer to the CalendarTypes.SystemType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarSystemType = (uint)Property.Id.EventCalendarSystemType;
/// <summary>
- /// The timezone of the start_time.
+ /// The timezone of the start_time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StartTzid = (uint)Property.Id.EventStartTzid;
/// <summary>
- /// The timezone of the end_time.
+ /// The timezone of the end_time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EndTzid = (uint)Property.Id.EventEndTzid;
/// <summary>
- /// The exception mod event list of the event.
+ /// The exception mod event list of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Exception = (uint)Property.Id.EventException;
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.EventExtended;
/// <summary>
- /// The event is an allday event or not.
+ /// The event is an allday event or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.EventIsAllday;
/// <summary>
- /// The linked event count.
+ /// The linked event count
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.EventLinkCount;
/// <summary>
- /// The event is an base linked event.
+ /// The event is an base linked event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkBaseId = (uint)Property.Id.EventLinkBaseId;
}
/// <summary>
- /// Describes the properties of a Todo record.
+ /// Describes properties of a Todo record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Todo
{
/// <summary>
- /// Identifier of this todo view.
+ /// Identifier of this todo view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.todo";
/// <summary>
- /// Database record ID of the todo.
+ /// DB record ID of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.TodoId;
/// <summary>
- /// ID of the calendar book to which the todo belongs to.
+ /// ID of the calendar book to which the todo belongs
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.TodoBookId;
/// <summary>
- /// The short description of the todo.
+ /// The short description of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.TodoSummary;
/// <summary>
- /// The description of the todo.
+ /// The description of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.TodoDescription;
/// <summary>
- /// The location of the todo.
+ /// The location of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.TodoLocation;
/// <summary>
- /// The category of the todo. For example, APPOINTMENT, BIRTHDAY.
+ /// The category of the todo. i.g. APPOINTMENT, BIRTHDAY
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.TodoCategories;
/// <summary>
- /// The status of the todo (refer to the CalendarTypes.TodoStatus).
+ /// The status of todo(refer to the CalendarTypes.TodoStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TodoStatus = (uint)Property.Id.TodoStatus;
/// <summary>
- /// The priority of the todo (refer to the CalendarTypes.Priority).
+ /// The Priority of todo(refer to the CalendarTypes.Priority).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.TodoPriority;
/// <summary>
- /// The sensitivity of the todo (refer to the CalendarTypes.Sensitivity).
+ /// The Sensitivity of todo(refer to the CalendarTypes.Sensitivity).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.TodoSensitivity;
/// <summary>
- /// The unique ID of the todo.
+ /// The unique ID of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.TodoUid;
/// <summary>
- /// The latitude of the location of the todo.
+ /// The latitude of the location of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.TodoLatitude;
/// <summary>
- /// The longitude of the location of the todo.
+ /// The longitude of the location of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.TodoLongitude;
/// <summary>
- /// The progression of the todo. The value can be from 0 to 100.
+ /// The progression of the todo. The value can be from 0 to 100
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Progress = (uint)Property.Id.TodoProgress;
/// <summary>
- /// The time when the todo is created.
+ /// The time when the todo is create
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CreatedTime = (uint)Property.Id.TodoCreatedTime;
/// <summary>
- /// The time when the todo is updated.
+ /// The time when the todo is updated
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.TodoLastModifiedTime;
/// <summary>
- /// The time when the todo is completed.
+ /// The time when the todo is completed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CompletedTime = (uint)Property.Id.TodoCompletedTime;
/// <summary>
- /// Whether or not the todo is deleted.
+ /// Whether or not the todo is deleted
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDeleted = (uint)Property.Id.TodoIsDeleted;
/// <summary>
- /// The frequent type of the todo recurrence (refer to the CalendarTypes.Recurrence).
+ /// The frequent type of todo recurrence(refer to the CalendarTypes.Recurrence).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Freq = (uint)Property.Id.TodoFreq;
/// <summary>
- /// The range type of the todo recurrence (refer to the CalendarTypes.RangeType).
+ /// The range type of todo recurrence(refer to the CalendarTypes.RangeType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RangeType = (uint)Property.Id.TodoRangeType;
/// <summary>
- /// The end time of the todo recurrence. Only if this is used with RangeType.Until..
+ /// The end time of the todo recurrence. Only if this is used with RangeType.Until.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Until = (uint)Property.Id.TodoUntil;
/// <since_tizen> 4 </since_tizen>
public const uint Count = (uint)Property.Id.TodoCount;
/// <summary>
- /// The interval of the todo recurrence.
+ /// The interval of the todo recurrence
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Interval = (uint)Property.Id.TodoInterval;
/// <summary>
- /// The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas.
+ /// The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysecond = (uint)Property.Id.TodoBysecond;
/// <summary>
- /// The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas.
+ /// The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byminute = (uint)Property.Id.TodoByminute;
/// <summary>
- /// The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas.
+ /// The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byhour = (uint)Property.Id.TodoByhour;
/// <summary>
- /// The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas.
+ /// The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byday = (uint)Property.Id.TodoByday;
/// <summary>
- /// The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas.
+ /// The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonthday = (uint)Property.Id.TodoBymonthday;
/// <summary>
- /// The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas.
+ /// The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byyearday = (uint)Property.Id.TodoByyearday;
/// <summary>
- /// The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas.
+ /// The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byweekno = (uint)Property.Id.TodoByweekno;
/// <summary>
- /// The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas.
+ /// The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonth = (uint)Property.Id.TodoBymonth;
/// <summary>
- /// The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas.
+ /// The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysetpos = (uint)Property.Id.TodoBysetpos;
/// <summary>
- /// The start day of the week (refer to the CalendarTypes.WeekDay).
+ /// The start day of the week(refer to the CalendarTypes.WeekDay).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Wkst = (uint)Property.Id.TodoWkst;
/// <summary>
- /// Whether or not the todo has an alarm list.
+ /// Whether or not the todo has an alarm list
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.TodoHasAlarm;
/// <summary>
- /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property.
+ /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.TodoSyncData1;
/// <summary>
- /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property.
+ /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.TodoSyncData2;
/// <summary>
- /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property.
+ /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.TodoSyncData3;
/// <summary>
- /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property.
+ /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.TodoSyncData4;
/// <summary>
- /// The start time of the todo.
+ /// The start time of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.TodoStart;
/// <summary>
- /// The due time of the todo.
+ /// The due time of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Due = (uint)Property.Id.TodoDue;
/// <since_tizen> 4 </since_tizen>
public const uint Alarm = (uint)Property.Id.TodoAlarm;
/// <summary>
- /// The timezone of the start_time.
+ /// The timezone of the start_time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StartTzid = (uint)Property.Id.TodoStartTzid;
/// <summary>
- /// The timezone of the due_time.
+ /// The timezone of the due_time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DueTzid = (uint)Property.Id.TodoDueTzid;
/// <summary>
- /// The name of the organizer of the event.
+ /// The name of the organizer of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.TodoOrganizerName;
/// <summary>
- /// The email address of the organizer of the todo.
+ /// The email address of the organizer of the todo
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerEmail = (uint)Property.Id.TodoOrganizerEmail;
/// <summary>
- /// Whether or not the todo has an attendee list.
+ /// Whether or not the todo has an attendee list
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.TodoHasAttendee;
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.TodoExtended;
/// <summary>
- /// The todo is an allday event or not.
+ /// The todo is an allday event or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.TodoIsAllday;
}
/// <summary>
- /// Describes the properties of a timezone record.
+ /// Describes properties of a Timezone record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Timezone
{
/// <summary>
- /// Identifier of this timezone view.
+ /// Identifier of this timezone view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.timezone";
/// <summary>
- /// Database record ID of the timezone.
+ /// DB record ID of the timezone
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.TimezoneId;
/// <summary>
- /// UTC offset, which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00).
+ /// UTC offset which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TzOffsetFromGmt = (uint)Property.Id.TimezoneTzOffsetFromGmt;
/// <summary>
- /// Name of the standard time.
+ /// Name of the Standard Time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StandardName = (uint)Property.Id.TimezoneStandardName;
/// <summary>
- /// Starting month of the standard time. Month is 0-based. For example, 0 for January.
+ /// Starting month of the Standard Time. Month is 0-based. eg, 0 for January
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartMonth = (uint)Property.Id.TimezoneStdStartMonth;
/// <summary>
- /// Starting day-of-week-in-month of the standard time. Day is 1-based.
+ /// Starting day-of-week-in-month of the Standard Time. Day is 1-based
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartPositionOfWeek = (uint)Property.Id.TimezoneStdStartPositionOfWeek;
/// <summary>
- /// Starting day-of-week of the standard time. Valid values are 1 (SUNDAY) to 7 (SATURDAY).
+ /// Starting day-of-week of the Standard Time. Valid values are 1(SUNDAY) to 7(SATURDAY)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartDay = (uint)Property.Id.TimezoneStdStartDay;
/// <summary>
- /// Starting hour of the standard time. Valid values are 0 to 23.
+ /// Starting hour of the Standard Time. Valid values are 0 to 23
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartHour = (uint)Property.Id.TimezoneStdStartHour;
/// <summary>
- /// The number of minutes added during the standard time.
+ /// The number of minutes added during the Standard Time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StandardBias = (uint)Property.Id.TimezoneStandardBias;
/// <summary>
- /// Name of the Daylight.
+ /// Name of Daylight
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightName = (uint)Property.Id.TimezoneDayLightName;
/// <summary>
- /// Starting month of the Daylight. Month is 0-based. For example, 0 for January.
+ /// Starting month of Daylight. Month is 0-based. eg, 0 for January
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartMonth = (uint)Property.Id.TimezoneDayLightStartMonth;
/// <summary>
- /// Starting day-of-week-in-month of the Daylight. Day is 1-based.
+ /// Starting day-of-week-in-month of Daylight. Day is 1-based
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartPositionOfWeek = (uint)Property.Id.TimezoneDayLightStartPositionOfWeek;
/// <summary>
- /// Starting day-of-week of the Daylight. Valid values are 1 (SUNDAY) to 7 (SATURDAY).
+ /// Starting day-of-week of Daylight. Valid values are 1(SUNDAY) to 7(SATURDAY)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartDay = (uint)Property.Id.TimezoneDayLightStartDay;
/// <summary>
- /// Starting hour of the Daylight. Valid values are 0 to 23.
+ /// Starting hour of Daylight. Valid values are 0 to 23
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartHour = (uint)Property.Id.TimezoneDayLightStartHour;
/// <summary>
- /// The number of minutes added during the Daylight time.
+ /// The number of minutes added during Daylight Time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightBias = (uint)Property.Id.TimezoneDayLightBias;
/// <summary>
- /// Database record ID of a related calendar book.
+ /// DB record ID of a related calendar book
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarId = (uint)Property.Id.TimezoneCalendarId;
}
/// <summary>
- /// Describes the properties of an Attendee record.
+ /// Describes properties of a Attendee record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Attendee
{
/// <summary>
- /// Identifier of this calendar attendee view.
+ /// Identifier of this calendar attendee view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.attendee";
/// <summary>
- /// The number of the attendee.
+ /// The number of the attendee
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.AttendeeNumber;
/// <summary>
- /// The type of attendee (refer to the CalendarTypes.Cutype).
+ /// The type of attendee(refer to the CalendarTypes.Cutype).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Cutype = (uint)Property.Id.AttendeeCutype;
/// <summary>
- /// CtIndex.
+ /// CtIndex
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CtIndex = (uint)Property.Id.AttendeeCtIndex;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.AttendeeUid;
/// <summary>
- /// Group.
+ /// Group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Group = (uint)Property.Id.AttendeeGroup;
/// <summary>
- /// The email address of the attendee.
+ /// The email address of the attendee
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.AttendeeEmail;
/// <summary>
- /// Attendee role (refer to the CalendarTypes.AttendeeRole).
+ /// Attendee role(refer to the CalendarTypes.AttendeeRole).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Role = (uint)Property.Id.AttendeeRole;
/// <summary>
- /// Attendee status (refer to the CalendarTypes.AttendeeStatus).
+ /// Attendee status(refer to the CalendarTypes.AttendeeStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.AttendeeStatus;
/// <summary>
- /// RSVP invitation reply (one of true, false).
+ /// RSVP invitation reply (one of true, false)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Rsvp = (uint)Property.Id.AttendeeRsvp;
/// <summary>
- /// Delegatee (DELEGATED-TO).
+ /// Delegatee (DELEGATED-TO)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DelegateeUri = (uint)Property.Id.AttendeeDelegateeUri;
/// <summary>
- /// Delegator (DELEGATED-FROM).
+ /// Delegator (DELEGATED-FROM)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DelegatorUri = (uint)Property.Id.AttendeeDelegatorUri;
/// <summary>
- /// Attendee name.
+ /// Attendee name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.AttendeeName;
/// <summary>
- /// Group that the attendee belongs to.
+ /// Group that the attendee belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Member = (uint)Property.Id.AttendeeMember;
/// <summary>
- /// Event/TODO that the attendee belongs to.
+ /// Event/TODO that the attendee belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ParentId = (uint)Property.Id.AttendeeParentId;
}
/// <summary>
- /// Describes the properties of an Alarm record.
+ /// Describes properties of a Alarm record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Alarm
{
/// <summary>
- /// Identifier of this calendar alarm view.
+ /// Identifier of this calendar alarm view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.alarm";
/// <summary>
- /// The number of unit before start time. This must be used with one of TickUnit.
+ /// The number of unit before start time. This MUST be used with one of TickUnit.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Tick = (uint)Property.Id.AlarmTick;
/// <summary>
- /// Reminder tick time unit (refer to the CalendarTypes.TickUnit).
+ /// Reminder tick time unit(refer to the CalendarTypes.TickUnit).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TickUnit = (uint)Property.Id.AlarmTickUnit;
/// <summary>
- /// Alarm description.
+ /// Alarm description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.AlarmDescription;
/// <summary>
- /// Event that the alarm belongs to.
+ /// Event that the alarm belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ParentId = (uint)Property.Id.AlarmParentId;
/// <summary>
- /// Alarm summary.
+ /// Alarm summary
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.AlarmSummary;
/// <summary>
- /// Action of alarm (refer to the CalendarTypes.Action).
+ /// Action of alarm(refer to the CalendarTypes.Action).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Action = (uint)Property.Id.AlarmAction;
/// <summary>
- /// Alarm tone path.
+ /// Alarm tone path
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Attach = (uint)Property.Id.AlarmAttach;
/// <summary>
- /// The alarm time.
+ /// The alarm time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AlarmTime = (uint)Property.Id.AlarmAlarm;
}
/// <summary>
- /// Describes the properties of an InstanceUtimeBook record.
+ /// Describes properties of a InstanceUtimeBook record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view.</remarks>
+ /// <remarks>Read only view</remarks>
public static class InstanceUtimeBook
{
/// <summary>
- /// Identifier of this instance utime book.
+ /// Identifier of this instance utime book
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.instance_utime/book";
/// <summary>
- /// Event ID.
+ /// Event id
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceUtimeBookEventId;
/// <summary>
- /// Start time.
+ /// Start time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceUtimeBookStart;
/// <summary>
- /// End time.
+ /// End time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceUtimeBookEnd;
/// <summary>
- /// Summary.
+ /// Summary
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceUtimeBookSummary;
/// <summary>
- /// Location.
+ /// Location
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceUtimeBookLocation;
/// <summary>
- /// Book ID.
+ /// Book id
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceUtimeBookBookId;
/// <summary>
- /// Description.
+ /// Description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceUtimeBookDescription;
/// <summary>
- /// BusyStatus.
+ /// BusyStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookBusyStatus;
/// <summary>
- /// EventStatus.
+ /// EventStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookEventStatus;
/// <summary>
- /// Priority.
+ /// Priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceUtimeBookPriority;
/// <summary>
- /// Sensitivity.
+ /// Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookSensitivity;
/// <summary>
- /// HasRrule.
+ /// HasRrule
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookHasRrule;
/// <summary>
- /// Latitude.
+ /// Latitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceUtimeBookLatitude;
/// <summary>
- /// Longitude.
+ /// Longitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceUtimeBookLongitude;
/// <summary>
- /// HasAlarm.
+ /// HasAlarm
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookHasAlarm;
/// <summary>
- /// OriginalEventId.
+ /// OriginalEventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookOriginalEventId;
/// <summary>
- /// LastModifiedtime.
+ /// LastModifiedtime
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedtime = (uint)Property.Id.InstanceUtimeBookLastModifiedTime;
/// <summary>
- /// SyncData1.
+ /// SyncData1
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookSyncData1;
}
/// <summary>
- /// Describes the properties of an InstanceLocaltimeBook record.
+ /// Describes properties of a InstanceLocaltimeBook record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view.</remarks>
+ /// <remarks>Read only view</remarks>
public static class InstanceLocaltimeBook
{
/// <summary>
- /// URI.
+ /// Uri
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.instance_localtime/book";
/// <summary>
- /// EventId.
+ /// EventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookEventId;
/// <summary>
- /// Start.
+ /// Start
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceLocaltimeBookStart;
/// <summary>
- /// End.
+ /// End
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceLocaltimeBookEnd;
/// <summary>
- /// Summary.
+ /// Summary
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookSummary;
/// <summary>
- /// Location.
+ /// Location
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceLocaltimeBookLocation;
/// <summary>
- /// BookId.
+ /// BookId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookBookId;
/// <summary>
- /// Description.
+ /// Description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceLocaltimeBookDescription;
/// <summary>
- /// BusyStatus.
+ /// BusyStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookBusyStatus;
/// <summary>
- /// EventStatus.
+ /// EventStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookEventStatus;
/// <summary>
- /// Priority.
+ /// Priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookPriority;
/// <summary>
- /// Sensitivity.
+ /// Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookSensitivity;
/// <summary>
- /// HasRrule.
+ /// HasRrule
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookHasRrule;
/// <summary>
- /// Latitude.
+ /// Latitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookLatitude;
/// <summary>
- /// Longitude.
+ /// Longitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookLongitude;
/// <summary>
- /// HasAlarm.
+ /// HasAlarm
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookHasAlarm;
/// <summary>
- /// OriginalEventId.
+ /// OriginalEventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookOriginalEventId;
/// <summary>
- /// LastModifiedTime.
+ /// LastModifiedTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookLastModifiedTime;
/// <summary>
- /// SyncData1.
+ /// SyncData1
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookSyncData1;
/// <summary>
- /// IsAllday.
+ /// IsAllday
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookIsAllday;
}
/// <summary>
- /// Describes the properties of an InstanceUtimeBookExtended record.
+ /// Describes properties of a InstanceUtimeBookExtended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view.</remarks>
+ /// <remarks>Read only view</remarks>
public static class InstanceUtimeBookExtended
{
/// <summary>
- /// URI.
+ /// Uri
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended/instance_utime/book";
/// <summary>
- /// EventId.
+ /// EventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceUtimeBookExtendedEventId;
/// <summary>
- /// Start.
+ /// Start
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceUtimeBookExtendedStart;
/// <summary>
- /// End.
+ /// End
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceUtimeBookExtendedEnd;
/// <summary>
- /// Summary.
+ /// Summary
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceUtimeBookExtendedSummary;
/// <summary>
- /// Location.
+ /// Location
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceUtimeBookExtendedLocation;
/// <summary>
- /// BookId.
+ /// BookId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceUtimeBookExtendedBookId;
/// <summary>
- /// Description.
+ /// Description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceUtimeBookExtendedDescription;
/// <summary>
- /// BusyStatus.
+ /// BusyStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookExtendedBusyStatus;
/// <summary>
- /// EventStatus.
+ /// EventStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookExtendedEventStatus;
/// <summary>
- /// Priority.
+ /// Priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceUtimeBookExtendedPriority;
/// <summary>
- /// Sensitivity.
+ /// Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookExtendedSensitivity;
/// <summary>
- /// HasRrule.
+ /// HasRrule
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookExtendedHasRrule;
/// <summary>
- /// Latitude.
+ /// Latitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceUtimeBookExtendedLatitude;
/// <summary>
- /// Longitude.
+ /// Longitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceUtimeBookExtendedLongitude;
/// <summary>
- /// HasAlarm.
+ /// HasAlarm
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookExtendedHasAlarm;
/// <summary>
- /// OriginalEventId.
+ /// OriginalEventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookExtendedOriginalEventId;
/// <summary>
- /// LastModifiedTime.
+ /// LastModifiedTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceUtimeBookExtendedLastModifiedTime;
/// <summary>
- /// SyncData1.
+ /// SyncData1
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData1;
/// <summary>
- /// OrganizerName.
+ /// OrganizerName
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.InstanceUtimeBookExtendedOrganizerName;
/// <summary>
- /// Categories.
+ /// Categories
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.InstanceUtimeBookExtendedCategories;
/// <summary>
- /// HasAttendee.
+ /// HasAttendee
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.InstanceUtimeBookExtendedHasAttendee;
/// <summary>
- /// SyncData2.
+ /// SyncData2
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData2;
/// <summary>
- /// SyncData3.
+ /// SyncData3
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData3;
/// <summary>
- /// SyncData4.
+ /// SyncData4
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData4;
}
/// <summary>
- /// Describes the properties of an InstanceLocaltimeBookExtended record.
+ /// Describes properties of a InstanceLocaltimeBookExtended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view.</remarks>
+ /// <remarks>Read only view</remarks>
public static class InstanceLocaltimeBookExtended
{
/// <summary>
- /// URI.
+ /// Uri
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended/instance_localtime/book";
/// <summary>
- /// EventId.
+ /// EventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookExtendedEventId;
/// <summary>
- /// Start.
+ /// Start
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceLocaltimeBookExtendedStart;
/// <summary>
- /// End.
+ /// End
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceLocaltimeBookExtendedEnd;
/// <summary>
- /// Summary.
+ /// Summary
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookExtendedSummary;
/// <summary>
- /// Location.
+ /// Location
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceLocaltimeBookExtendedLocation;
/// <summary>
- /// BookId.
+ /// BookId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookExtendedBookId;
/// <summary>
- /// Description.
+ /// Description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceLocaltimeBookExtendedDescription;
/// <summary>
- /// BusyStatus.
+ /// BusyStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedBusyStatus;
/// <summary>
- /// EventStatus.
+ /// EventStatus
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedEventStatus;
/// <summary>
- /// Priority.
+ /// Priority
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookExtendedPriority;
/// <summary>
- /// Sensitivity.
+ /// Sensitivity
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookExtendedSensitivity;
/// <summary>
- /// HasRrule.
+ /// HasRrule
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookExtendedHasRrule;
/// <summary>
- /// Latitude.
+ /// Latitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLatitude;
/// <summary>
- /// Longitude.
+ /// Longitude
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLongitude;
/// <summary>
- /// HasAlarm.
+ /// HasAlarm
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAlarm;
/// <summary>
- /// OriginalEventId.
+ /// OriginalEventId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookExtendedOriginalEventId;
/// <summary>
- /// LastModifiedTime.
+ /// LastModifiedTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookExtendedLastModifiedTime;
/// <summary>
- /// SyncData1.
+ /// SyncData1
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData1;
/// <summary>
- /// OrganizerName.
+ /// OrganizerName
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.InstanceLocaltimeBookExtendedOrganizerName;
/// <summary>
- /// Categories.
+ /// Categories
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.InstanceLocaltimeBookExtendedCategories;
/// <summary>
- /// HasAttendee.
+ /// HasAttendee
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAttendee;
/// <summary>
- /// SyncData2.
+ /// SyncData2
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData2;
/// <summary>
- /// SyncData3.
+ /// SyncData3
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData3;
/// <summary>
- /// SyncData4.
+ /// SyncData4
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData4;
/// <summary>
- /// IsAllday.
+ /// IsAllday
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookExtendedIsAllday;
}
/// <summary>
- /// Describes the properties of an UpdatedInfo record.
+ /// Describes properties of a UpdatedInfo record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view.</remarks>
+ /// <remarks>Read only view</remarks>
public static class UpdatedInfo
{
/// <summary>
- /// Identifier of this UpdatedInfo view.
+ /// Identifier of this updatedInfo view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.updated_info";
/// <summary>
- /// Modified event (or todo) record ID.
+ /// Modified event(or todo) record ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Calendar book ID of the modified event (or todo) record.
+ /// Calendar book ID of the modified event(or todo) record
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarId = (uint)Property.Id.UpdateInfoCalendarId;
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Version after change.
+ /// Version after change
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes the properties of an Extended record.
+ /// Describes properties of a Extended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Extended
{
/// <summary>
- /// Identifier of this extended_property view.
+ /// Identifier of this extended_property view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended_property";
/// <summary>
- /// Database record ID of the extended_property.
+ /// DB record ID of the extended_property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ExtendedId;
/// <summary>
- /// Related record ID.
+ /// Related record ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RecordId = (uint)Property.Id.ExtendedRecordId;
/// <since_tizen> 4 </since_tizen>
public const uint RecordType = (uint)Property.Id.ExtendedRecordType;
/// <summary>
- /// The key of the property.
+ /// The key of the property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Key = (uint)Property.Id.ExtendedKey;
/// <summary>
- /// The value of the property.
+ /// The value of the property
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Value = (uint)Property.Id.ExtendedValue;
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// The event arguments passed when the calendar database is changed.
+ /// Event arguments passed when calendar database is changed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBChangedEventArgs : EventArgs
}
/// <summary>
- /// The calendar view URI is changed.
+ /// The calendar view URI changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ViewUri
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// The event arguments passed when the alarm is alerted.
+ /// Event arguments passed when alarm is alerted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReminderAlertedEventArgs : EventArgs
}
/// <summary>
- /// The parameter which the data is combined.
+ /// The parameter which data is combined.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <value>
- /// The combination of the reminder data (Value string like id=value&time=value&tick=value&unit=value&type=value).
+ /// The combination of reminder data(Value string like id=value&time=value&tick=value&unit=value&type=value)
/// </value>
public string Param
{
using System.Runtime.InteropServices;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Contacts Interop class.
+ /// Contacts Interop Class
/// </summary>
internal static class Group
{
*/
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Contacts Interop class.
+ /// Contacts Interop Class
/// </summary>
internal static class Service
{
using Tizen.Pims.Contacts;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
{
/// <summary>
- /// The ContactsDatabase provides methods to manage contacts information from/to the database.
+ /// ContactsDatabase provides methods to manage contacts information from/to the database.
/// </summary>
/// <remarks>
- /// This class allows the user to access/create/update database operations for the contacts information.
+ /// This class allows user to access/create/update db operations for contacts information.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public class ContactsDatabase
}
/// <summary>
- /// Enumeration for the contacts database status.
+ /// Enumeration for contacts database status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DBStatus
{
/// <summary>
- /// Normal.
+ /// Normal
/// </summary>
/// <since_tizen> 4 </since_tizen>
Normal,
}
/// <summary>
- /// Enumeration for the contacts search range.
+ /// Enumeration for Contacts search range.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum SearchRanges
{
/// <summary>
- /// None.
+ /// None
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0,
/// <summary>
- /// Search record from name.
+ /// Search record from name
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name = 0x00000001,
/// <summary>
- /// Search record from number.
+ /// Search record from number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number = 0x00000002,
/// <summary>
- /// Search record from data.
+ /// Search record from data
/// </summary>
/// <since_tizen> 4 </since_tizen>
Data = 0x00000004,
/// <summary>
- /// Search record from email. Now, support only PersonEmail view.
+ /// Search record from email. Now, support only PersonEmail view
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email = 0x00000008,
}
/// <summary>
- /// Occurs when the contacts database status is changed.
+ /// Occurs when contacts database status is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<DBStatusChangedEventArgs> DBStatusChanged
/// <summary>
/// Inserts a record into the contacts database.
/// </summary>
- /// <param name="record">The record to insert.</param>
- /// <returns>The ID of inserted record.</returns>
+ /// <param name="record">The record to insert</param>
+ /// <returns>The ID of inserted record</returns>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(ContactsRecord record)
/// <summary>
/// Inserts multiple records into the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list.</param>
- /// <returns>The inserted record ID array.</returns>
+ /// <param name="list">The record list</param>
+ /// <returns>The inserted record ID array</returns>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(ContactsList list)
/// <summary>
/// Gets a record from the contacts database.
/// </summary>
- /// <param name="viewUri">The view URI of a record.</param>
- /// <param name="recordId">The record ID.</param>
+ /// <param name="viewUri">The view URI of a record</param>
+ /// <param name="recordId">The record ID</param>
/// <returns>The record associated with the record ID</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Updates a record in the contacts database.
/// </summary>
- /// <param name="record">The record to update.</param>
+ /// <param name="record">The record to update</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsRecord record)
/// <summary>
/// Updates multiple records in the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list.</param>
+ /// <param name="list">The record list</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsList list)
}
/// <summary>
- /// Deletes a record from the contacts database with the related child records.
+ /// Deletes a record from the contacts database with related child records.
/// </summary>
- /// <param name="viewUri">The view URI of a record.</param>
- /// <param name="recordId">The record ID to delete.</param>
+ /// <param name="viewUri">The view URI of a record</param>
+ /// <param name="recordId">The record ID to delete</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Deletes multiple records with the related child records from the contacts database as a batch operation.
+ /// Deletes multiple records with related child records from the contacts database as a batch operation.
/// </summary>
- /// <param name="viewUri">The view URI of the records to delete.</param>
- /// <param name="idArray">The record IDs to delete.</param>
+ /// <param name="viewUri">The view URI of the records to delete</param>
+ /// <param name="idArray">The record IDs to delete</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Replaces a record in the contacts database.
/// </summary>
- /// <param name="record">The record to replace.</param>
- /// <param name="recordId">The record ID to be replaced.</param>
+ /// <param name="record">The record to replace</param>
+ /// <param name="recordId">the record ID to be replaced</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation<./exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsRecord record, int recordId)
/// <summary>
/// Replaces multiple records in the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list to replace.</param>
- /// <param name="idArray">The record IDs to be replaced.</param>
+ /// <param name="list">The record list to replace</param>
+ /// <param name="idArray">The record IDs to be replaced</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsList list, int[] idArray)
}
/// <summary>
- /// Retrieves all the records as a list.
+ /// Retrieves all records as a list.
/// </summary>
- /// <param name="viewUri">The view URI to get records.</param>
- /// <param name="offset">The index from which results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="viewUri">The view URI to get records</param>
+ /// <param name="offset">The index from which results</param>
+ /// <param name="limit">The number to limit results(value 0 is used for all records)</param>
/// <returns>
- /// The record list.
+ /// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Retrieves the records using a query.
+ /// Retrieves records using a query.
/// </summary>
- /// <param name="query">The query to filter the results.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="query">The query to filter the results</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
/// <returns>
/// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList GetRecordsWithQuery(ContactsQuery query, int offset, int limit)
}
/// <summary>
- /// Retrieves the records changes since the given database version.
+ /// Retrieves records changes since the given database version.
/// </summary>
- /// <param name="viewUri">The view URI to get records.</param>
- /// <param name="addressBookId">The address book ID to filter.</param>
- /// <param name="contactsDBVersion">The contacts database version.</param>
- /// <param name="currentDBVersion">The current contacts database version.</param>
+ /// <param name="viewUri">The view URI to get records</param>
+ /// <param name="addressBookId">The address book ID to filter</param>
+ /// <param name="contactsDBVersion">The contacts database version</param>
+ /// <param name="currentDBVersion">The current contacts database version</param>
/// <returns>
- /// The record list.
+ /// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds the records based on a given keyword.
+ /// Finds records based on a given keyword.
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned.
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned.
/// </remarks>
- /// <param name="viewUri">The view URI to find records.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="viewUri">The view URI to find records</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
/// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds the records based on a given query and keyword.
+ /// Finds records based on given query and keyword.
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned.
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned.
/// </remarks>
- /// <param name="query">The query to filter.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
- /// <returns>The record list.</returns>
+ /// <param name="query">The query to filter</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
+ /// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit)
}
/// <summary>
- /// Finds the records based on a keyword and range.
+ /// Finds records based on a keyword and range.
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber, and PersonEmail.
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail
/// </remarks>
- /// <param name="viewUri">The view URI.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
- /// <param name="range">The search range should be an element of the SearchRange or bitwise OR operation of them.</param>
- /// <returns>The record list.</returns>
+ /// <param name="viewUri">The view URI</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
+ /// <param name="range">The search range, it should be a element of SearchRange or bitwise OR operation of them</param>
+ /// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds the records based on a given keyword for the snippet.
+ /// Finds records based on a given keyword for snippet
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned.
- /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (string viewUri, string keyword, int offset, int limit).
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned.
+ /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit).
/// </remarks>
- /// <param name="viewUri">The view URI to find records.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
- /// <param name="startMatch">The text, which is inserted into the fragment before the keyword (If NULL, default is "[".)</param>
- /// <param name="endMatch">The text, which is inserted into the fragment after the keyword (If NULL, default is "]")</param>
- /// <param name="tokenNumber">The one side extra number of tokens near keyword (If negative value, full sentence is printed. For example, if the token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home").</param>
+ /// <param name="viewUri">The view URI to find records</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
+ /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
+ /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
+ /// <param name="tokenNumber">The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home")</param>
/// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds the records based on a given query and keyword for the snippet.
+ /// Finds records based on given query and keyword for snippet.
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned.
- /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (ContactsQuery query, string keyword, int offset, int limit).
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned.
+ /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(ContactsQuery query, string keyword, int offset, int limit).
/// </remarks>
- /// <param name="query">The query to filter.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
- /// <param name="startMatch">The text, which is inserted into the fragment before a keyword (If NULL, default is "[").</param>
- /// <param name="endMatch">The text, which is inserted into the fragment after a keyword (If NULL, default is "]".)</param>
- /// <param name="tokenNumber">The one side extra number of tokens near a keyword (If negative value, full sentence is printed. For example, if the token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home").</param>
- /// <returns>The record list.</returns>
+ /// <param name="query">The query to filter</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
+ /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
+ /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
+ /// <param name="tokenNumber">The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home")</param>
+ /// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit, string startMatch, string endMatch, int tokenNumber)
}
/// <summary>
- /// Finds the records based on a keyword and range for the snippet.
+ /// Finds records based on a keyword and range for snippet.
/// </summary>
/// <remarks>
- /// This API works only for the views below:
- /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber, and PersonEmail,
- /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (string viewUri, string keyword, int offset, int limit, int range).
+ /// This API works only for the Views below.
+ /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail
+ /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit, int range).
/// </remarks>
- /// <param name="viewUri">The view URI.</param>
- /// <param name="keyword">The keyword.</param>
- /// <param name="offset">The index from which to get results.</param>
- /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
- /// <param name="range">The search range should be an element of the SearchRange or bitwise OR operation of them.</param>
- /// <param name="startMatch">The text, which is inserted into the fragment before a keyword (If NULL, default is "[").</param>
- /// <param name="endMatch">The text, which is inserted into the fragment after a keyword (If NULL, default is "]").</param>
- /// <param name="tokenNumber">The one side extra number of tokens near a keyword (If negative value, full sentence is printed. For example, if a token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home").</param>
- /// <returns>The record list.</returns>
+ /// <param name="viewUri">The view URI</param>
+ /// <param name="keyword">The keyword</param>
+ /// <param name="offset">The index from which to get results</param>
+ /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
+ /// <param name="range">The search range, it should be a element of SearchRange or bitwise OR operation of them</param>
+ /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
+ /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
+ /// <param name="tokenNumber">The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home")</param>
+ /// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Gets the number of records in a specific view.
+ /// Gets the number of records in a specific view
/// </summary>
- /// <param name="viewUri">The view URI.</param>
- /// <returns>The count of records.</returns>
+ /// <param name="viewUri">The view URI</param>
+ /// <returns>The count of records</returns>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Gets the number of records matching a query.
/// </summary>
- /// <param name="query">The query used for filtering the results.</param>
- /// <returns>The count of records.</returns>
+ /// <param name="query">The query used for filtering the results</param>
+ /// <returns>The count of records</returns>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int GetCount(ContactsQuery query)
}
/// <summary>
- /// Registers an EventHandler to be invoked when a record changes.
+ /// Registers a EventHandler to be invoked when a record changes.
/// </summary>
- /// <param name="viewUri">The view URI of records whose changes are monitored.</param>
- /// <param name="DBChanged">The EventHandler to register.</param>
+ /// <param name="viewUri">The view URI of records whose changes are monitored</param>
+ /// <param name="DBChanged">The EventHandler to register</param>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
}
/// <summary>
- /// Deregisters an EventHandler.
+ /// Deregisters a EventHandler.
/// </summary>
- /// <param name="viewUri">The view URI of records whose changes are monitored.</param>
- /// <param name="DBChanged">The EventHandler to deregister.</param>
+ /// <param name="viewUri">The view URI of records whose changes are monitored</param>
+ /// <param name="DBChanged">The EventHandler to deregister</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A filter includes the conditions for the search.
+ /// A filter includes the conditions for the search
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsFilter:IDisposable
/// <summary>
/// Creates a filter with a condition for a string type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue)
/// <summary>
/// Creates a filter with a condition for an integer type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue)
/// <summary>
/// Creates a filter with a condition for a long type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue)
/// <summary>
/// Creates a filter with a condition for a double type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue)
/// <summary>
/// Creates a filter with a condition for a boolean type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="viewUri">The view URI of a filter</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, bool matchValue)
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsFilter()
}
/// <summary>
- /// Enumeration for the filter match types of a string.
+ /// Enumeration for the filter match type of a string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum StringMatchType
{
/// <summary>
- /// Full string, case-sensitive.
+ /// Full string, case-sensitive
/// </summary>
/// <since_tizen> 4 </since_tizen>
Exactly,
/// <summary>
- /// Full string, case-insensitive.
+ /// Full string, case-insensitive
/// </summary>
/// <since_tizen> 4 </since_tizen>
FullString,
/// <summary>
- /// Sub string, case-insensitive.
+ /// Sub string, case-insensitive
/// </summary>
/// <since_tizen> 4 </since_tizen>
Contains,
/// <summary>
- /// Start with, case-insensitive.
+ /// Start with, case-insensitive
/// </summary>
/// <since_tizen> 4 </since_tizen>
StartsWith,
/// <summary>
- /// End with, case-insensitive.
+ /// End with, case-insensitive
/// </summary>
/// <since_tizen> 4 </since_tizen>
EndsWith,
/// <summary>
- /// Is not null.
+ /// IS NOT NUL
/// </summary>
/// <since_tizen> 4 </since_tizen>
Exists,
}
/// <summary>
- /// Enumeration for the filter match types of an integer.
+ /// Enumeration for the filter match type of an integer.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum IntegerMatchType
/// <since_tizen> 4 </since_tizen>
LessThanOrEqual,
/// <summary>
- /// <>, this flag can yield poor performance.
+ /// <>, this flag can yield poor performance
/// </summary>
/// <since_tizen> 4 </since_tizen>
NotEqual,
/// <summary>
- /// Is null.
+ /// IS NULL
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
public enum LogicalOperator
{
/// <summary>
- /// And.
+ /// AND
/// </summary>
/// <since_tizen> 4 </since_tizen>
And,
/// <summary>
- /// Or.
+ /// OR
/// </summary>
/// <since_tizen> 4 </since_tizen>
Or,
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all the resources used by the ContactsFilter.
+ /// Releases all resources used by the ContactsFilter.
/// </summary>
- /// <param name="disposing">Disposing by the user.</param>
+ /// <param name="disposing">Disposing by User</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the ContactsFilter.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the ContactsFilter.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Adds a condition for a string type property.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue)
{
}
/// <summary>
- /// Adds a condition for an integer type property.
+ /// Adds a condition for a integer type property.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue)
{
/// <summary>
/// Adds a condition for a long type property.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue)
{
/// <summary>
/// Adds a condition for a double type property.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchType">The match flag.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchType">The match flag</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue)
{
/// <summary>
/// Adds a condition for a boolean type property.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="propertyId">The property ID to add a condition.</param>
- /// <param name="matchValue">The match value.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="propertyId">The property ID to add a condition</param>
+ /// <param name="matchValue">The match value</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, bool matchValue)
{
/// <summary>
/// Adds a child filter to a parent filter.
/// </summary>
- /// <param name="logicalOperator">The operator type.</param>
- /// <param name="filter">The child filter.</param>
+ /// <param name="logicalOperator">The operator type</param>
+ /// <param name="filter">The child filter</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddFilter(LogicalOperator logicalOperator, ContactsFilter filter)
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A list of records with the same type.
+ /// A list of records with the same type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsList:IDisposable
/// Creates a contacts record list.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsList()
{
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsList()
}
/// <summary>
- /// The count of the contact entity.
+ /// The count of contact entity.
/// </summary>
- /// <value>The count of the contact entity.</value>
+ /// <value>The count of contact entity.</value>
/// <since_tizen> 4 </since_tizen>
public int Count
{
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all the resources used by the ContactsList.
+ /// Releases all resources used by the ContactsList.
/// </summary>
- /// <param name="disposing">Disposing by the user.</param>
+ /// <param name="disposing">Disposing by User</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the ContactsList.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the ContactsList.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Adds a record to the contacts list.
/// </summary>
- /// <param name="record">The record to add.</param>
+ /// <param name="record">The record to add</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddRecord(ContactsRecord record)
{
/// <summary>
/// Removes a record from the contacts list.
/// </summary>
- /// <param name="record">The record to remove.</param>
+ /// <param name="record">The record to remove</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void RemoveRecord(ContactsRecord record)
{
/// Retrieves a record from the contacts list.
/// </summary>
/// <returns>
- /// The contacts record.
+ /// contacts record
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord GetCurrentRecord()
{
/// When the cursor is already at the first position, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public bool MovePrevious()
{
/// When the cursor is already at the last position, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public bool MoveNext()
{
/// Moves a contacts list to the first position.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public void MoveFirst()
{
/// Moves a contacts list to the last position.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public void MoveLast()
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Enumeration for the name display order.
+ /// Enumeration for name display order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ContactDisplayOrder
{
/// <summary>
- /// First name comes at the first.
+ /// First name comes at the first
/// </summary>
/// <since_tizen> 4 </since_tizen>
FirstLast,
/// <summary>
- /// First name comes at the last.
+ /// First name comes at the last
/// </summary>
/// <since_tizen> 4 </since_tizen>
LastFirst
};
/// <summary>
- /// Enumeration for the name sorting order.
+ /// Enumeration for name sorting order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ContactSortingOrder
{
/// <summary>
- /// Contacts are first sorted based on the first name.
+ /// Contacts are first sorted based on the first name
/// </summary>
/// <since_tizen> 4 </since_tizen>
FirstLast,
/// <summary>
- /// Contacts are first sorted based on the last name.
+ /// Contacts are first sorted based on the last name
/// </summary>
/// <since_tizen> 4 </since_tizen>
LastFirst
};
/// <summary>
- /// A class for managing the contact information. It allows the applications to access the contacts database.
+ /// A class for managing contact information. It allows applications to access contacts database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsManager : IDisposable
/// Creates a ContactsManager.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsManager()
{
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsManager()
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all the resources used by the ContactsManager.
+ /// Releases all resources used by the ContactsManager.
/// </summary>
- /// <param name="disposing">Disposing by the user.</param>
+ /// <param name="disposing">Disposing by User</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the ContactsManager.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the ContactsManager.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
private EventHandler<NameSortingOrderChangedEventArgs> _nameSortingOrderChanged;
/// <summary>
- /// (event) NameDisplayOrderChanged is raised when changing the setting value of the contacts name display order.
+ /// (event) NameDisplayOrderChanged is raised when changing setting value of contacts name display order
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// (event) NameSortingOrderChanged is raised when changing the setting value of the contacts name sorting order.
+ /// (event) NameSortingOrderChanged is raised when changing setting value of contacts name sorting order
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// A ContactsDatabase.
+ /// A ContactsDatabase
/// </summary>
- /// <value>A ContactsDatabase.</value>
+ /// <value>A ContactsDatabase</value>
/// <since_tizen> 4 </since_tizen>
public ContactsDatabase Database
{
}
/// <summary>
- /// A setting value of the contacts name display order.
+ /// A setting value of contacts name display order
/// </summary>
- /// <value>A setting value of the contacts name display order.</value>
+ /// <value>A setting value of contacts name display order</value>
/// <remarks>
- /// DisplayName of the contacts returned from the database is determined by this property.
+ /// DisplayName of contacts returned from database are determined by this property
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
}
/// <summary>
- /// A setting value of the contacts name sorting order.
+ /// A setting value of contacts name sorting order
/// </summary>
- /// <value>A setting value of the contacts name sorting order.</value>
+ /// <value>A setting value of contacts name sorting order</value>
/// <remarks>
- /// Contacts returned from the database are first sorted based on the first name or last name by this property.
+ /// Contacts returned from database are first sorted based on the first name or last name by this property
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A query is used to retrieve the data, which satisfies a given criteria.
+ /// A query is used to retrieve data which satisfies given criteria
/// </summary>
/// <remarks>
- /// A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring.
+ /// A query is used to retrieve person, group, speed dial, and log data which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring.
/// A query needs a filter which can set the conditions for the search.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Creates a query.
/// </summary>
- /// <param name="viewUri">The view URI of a query.</param>
+ /// <param name="viewUri">The view URI of a query</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsQuery(string viewUri)
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsQuery()
private bool disposedValue = false;
/// <summary>
- /// Releases all the resources used by the ContactsQuery.
+ /// Releases all resources used by the ContactsQuery.
/// </summary>
- /// <param name="disposing">Disposing by the user.</param>
+ /// <param name="disposing">Disposing by User</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the ContactsQuery.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the ContactsQuery.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Adds the property IDs for projection.
+ /// Adds property IDs for projection.
/// </summary>
- /// <param name="propertyIdArray">The property ID array.</param>
+ /// <param name="propertyIdArray">The property ID array </param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void SetProjection(uint[] propertyIdArray)
{
/// <summary>
/// Sets the "distinct" option for projection.
/// </summary>
- /// <param name="set">If true it is set, otherwise if false it is unset.</param>
+ /// <param name="set">If true it is set, otherwise if false it is unset</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public void SetDistinct(bool set)
{
/// <summary>
/// Sets the filter for a query.
/// </summary>
- /// <param name="filter">The filter.</param>
+ /// <param name="filter">The filter</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void SetFilter(ContactsFilter filter)
{
/// <summary>
/// Sets the sort mode for a query.
/// </summary>
- /// <param name="propertyId">The property ID to sort.</param>
- /// <param name="isAscending">If true it sorts in ascending order, otherwise if false it sorts in descending order.</param>
+ /// <param name="propertyId">The property ID to sort</param>
+ /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void SetSort(uint propertyId, bool isAscending)
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A record represents an actual record in the database.
+ /// A record represents an actual record in the database
/// </summary>
/// <remarks>
/// A record represents an actual record in the database, but you can also consider it a piece of information, such as an address, a phone number, or a group of contacts.
/// <summary>
/// Creates a record.
/// </summary>
- /// <param name="viewUri">The view URI.</param>
+ /// <param name="viewUri">The view URI</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsRecord(string viewUri)
}
/// <summary>
- /// The destructor.
+ /// Destructor
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsRecord()
}
/// <summary>
- /// The URI of the record.
+ /// The URI of the record
/// </summary>
- /// <value>The URI of the record.</value>
+ /// <value>The URI of the record</value>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")]
public string Uri
internal bool _disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all the resources used by the ContactsRecord.
+ /// Releases all resources used by the ContactsRecord.
/// </summary>
- /// <param name="disposing">Disposing by the user.</param>
+ /// <param name="disposing">Disposing by User</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all the resources used by the ContactsRecord.
- /// It should be called after it has finished using the object.
+ /// Releases all resources used by the ContactsRecord.
+ /// It should be called after finished using of the object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Makes a clone of a record.
/// </summary>
- /// <returns>A cloned record.</returns>
+ /// <returns>A cloned record</returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord Clone()
{
/// <summary>
/// Gets a value of the property from a record.
/// </summary>
- /// <param name="propertyId">The property ID.</param>
+ /// <param name="propertyId">The property ID</param>
/// <returns>
- /// The value of the property corresponding to a property ID.
+ /// The value of the property corresponding to property id.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public T Get<T>(uint propertyId)
{
/// Sets a value of the property to a record.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="value">The value to set.</param>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="value">The value to set</param>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void Set<T>(uint propertyId, T value)
{
/// <summary>
/// Adds a child record to the parent record.
/// </summary>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="childRecord">The child record to add to the parent record<./param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="childRecord">The child record to add to parent record</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void AddChildRecord(uint propertyId, ContactsRecord childRecord)
{
/// <summary>
/// Removes a child record from the parent record.
/// </summary>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="childRecord">The child record to remove from the parent record.</param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="childRecord">The child record to remove from parent record</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)
{
/// <summary>
/// Gets the number of child records of a parent record.
/// </summary>
- /// <param name="propertyId">The property ID.</param>
- /// <returns>The number of child records corresponding to the property ID.</returns>
+ /// <param name="propertyId">The property ID</param>
+ /// <returns>The number of child records corresponding to property ID</returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public int GetChildRecordCount(uint propertyId)
{
}
/// <summary>
- /// Gets a child record from the parent record.
+ /// Gets a child record from the parent record
/// </summary>
- /// <param name="propertyId">The property ID.</param>
- /// <param name="index">The index of the child record.</param>
+ /// <param name="propertyId">The property ID</param>
+ /// <param name="index">The index of child record</param>
/// <returns>The record </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord GetChildRecord(uint propertyId, int index)
{
}
/// <summary>
- /// Clones a child record list corresponding to the property ID.
+ /// Clones a child record list corresponding to property ID
/// </summary>
- /// <param name="propertyId">The property ID.</param>
+ /// <param name="propertyId">The property ID</param>
/// <returns>
- /// The record list.
+ /// The record list
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsList CloneChildRecordList(uint propertyId)
{
using ContactsViews;
/// <summary>
- /// Delegates for getting a record parsed from a vCard file.
+ /// Delegate for getting a record parsed from a vCard file
/// </summary>
- /// <param name="record">The contacts record.</param>
- /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop.</returns>
+ /// <param name="record">The contacts record</param>
+ /// <returns> true to continue with the next iteration of the loop, otherwise false to break out of the loop</returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool ParseCallback(ContactsRecord record);
/// <summary>
- /// A class for parsing and making the vCards.
+ /// A class for parsing and making vCards.
/// </summary>
/// <remarks>
- /// It's based on the vCard v3.0 specification.
+ /// It's based on the vCard v3.0 specification
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactsVcard
/// <summary>
/// Retrieves the vCard stream from a contacts record.
/// </summary>
- /// <param name="record">The contacts record.</param>
+ /// <param name="record">The contacts record</param>
/// <returns>
/// The vCard stream.
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public static string Compose(ContactsRecord record)
{
}
/// <summary>
- /// Retrieves all the contacts with a contacts list from a vCard stream.
+ /// Retrieves all contacts with a contacts list from a vCard stream
/// </summary>
- /// <param name="stream">The vCard stream.</param>
+ /// <param name="stream">The vCard stream</param>
/// <returns>
- /// The contacts list.
+ /// The contacts list
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public static ContactsList Parse(string stream)
{
}
/// <summary>
- /// Retrieves all the contacts with a record from a vCard file.
+ /// Retrieves all contacts with a record from a vCard file.
/// </summary>
- /// <param name="path">The file path of a vCard stream file.</param>
- /// <param name="callback">The callback function to invoke.</param>
+ /// <param name="path">The file path of vCard stream file</param>
+ /// <param name="callback">The callback function to invoke</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
- /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
/// <since_tizen> 4 </since_tizen>
public static void ParseForEach(string path, ParseCallback callback)
{
namespace ContactsViews
{
/// <summary>
- /// This namespace provides information about the views with properties.
+ /// This namespace provides information about views with properties.
/// </summary>
/// <remarks>
/// Views are provided to access and handle entities. A view is a structure, which has property elements.
/// A view is almost the same as a database "VIEW", which limits access and guarantees performance.
/// A "record" represents a single row of the views.
- /// A record can have basic properties of five types: integer, string, boolean, long, and double.
+ /// A record can have basic properties of five types: integer, string, boolean, long, double.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Enumeration for the contact change states.
+ /// Enumeration for contact change state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ChangeType
{
/// <summary>
- /// Inserted.
+ /// Inserted
/// </summary>
/// <since_tizen> 4 </since_tizen>
Inserted,
/// <summary>
- /// Updated.
+ /// Updated
/// </summary>
/// <since_tizen> 4 </since_tizen>
Updated,
/// <summary>
- /// Deleted.
+ /// Deleted
/// </summary>
/// <since_tizen> 4 </since_tizen>
Deleted,
}
/// <summary>
- /// Describes the properties of an address book record.
+ /// Describes properties of a Address book record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class AddressBook
{
/// <summary>
- /// Identifier of this contacts address book view.
+ /// Identifier of this contacts address book view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.addressbook";
/// <summary>
- /// Integer, read only, database record ID of the address book.
+ /// integer, read only, DB record ID of the address book
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.AddressBookId;
/// <summary>
- /// Integer, read/write once, account ID that the address book belongs to.
+ /// integer, read/write once, Account ID that the address book belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AccountId = (uint)Property.Id.AddressBookAccountId;
/// <summary>
- /// String, read/write, it cannot be null. Duplicate names are not allowed.
+ /// string, read/write, It cannot be NULL. Duplicate names are not allowed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.AddressBookName;
/// <summary>
- /// Integer, read/write, AddressBook mode, refer to the ModeValue.
+ /// integer, read/write, AddressBook mode, refer to the ModeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Enumeration for the address book modes.
+ /// Enumeration for Address book mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ModeValue
{
/// <summary>
- /// All modules can read and write the contacts of this address_book.
+ /// All module can read and write contacts of this address_book
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// All modules can only read the contacts of this address_book.
+ /// All module can only read contacts of this address_book
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReadOnly,
}
/// <summary>
- /// Describes the properties of a Group record.
+ /// Describes properties of a Group record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Group
{
/// <summary>
- /// Identifier of this contacts group view.
+ /// Identifier of this contacts group view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group";
/// <summary>
- /// Database record ID of the group.
+ /// DB record ID of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.GroupId;
/// <summary>
- /// AddressBook ID that the group belongs to.
+ /// AddressBook ID that the group belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.GroupAddressBookId;
/// <summary>
- /// Group name.
+ /// Group name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.GroupName;
/// <summary>
- /// Ringtone path of the group.
+ /// Ringtone path of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.GroupRingtone;
/// <summary>
- /// Image path of the group.
+ /// Image path of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ImagePath = (uint)Property.Id.GroupImage;
/// <summary>
- /// Vibration path of the group.
+ /// Vibration path of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.GroupVibration;
/// <summary>
- /// Extra data for the default group name.
+ /// Extra data for default group name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData = (uint)Property.Id.GroupExtraData;
/// <summary>
- /// The group is read-only or not.
+ /// The group is read only or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsReadOnly = (uint)Property.Id.GroupIsReadOnly;
/// <summary>
- /// Message alert path of the group.
+ /// Message alert path of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.GroupMessageAlert;
}
/// <summary>
- /// Describes the properties of a Person record.
+ /// Describes properties of a Person record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Person
{
/// <summary>
- /// Identifier of this contacts person view.
+ /// Identifier of this contacts person view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to.
+ /// Display contact ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person.
+ /// Ringtone path of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person.
+ /// Image thumbnail path of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person.
+ /// Vibration path of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person.
+ /// Message alert path of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of the social account.
+ /// Status of social account
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The priority of the favorite contacts. It can be used as a sorting key.
+ /// The priority of favorite contacts. it can be used as sorting key
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint FavoritePriority = (uint)Property.Id.PersonFavoritePriority;
/// <summary>
- /// Link count of the contact records (projection).
+ /// Link count of contact records (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection).
+ /// AddressBook IDs that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Keyword matched data type.
+ /// keyword matched data type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
}
/// <summary>
- /// Describes the properties of a Contact record.
+ /// Describes properties of a Contact record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Contact
{
/// <summary>
- /// Identifier of this contacts view.
+ /// Identifier of this contact view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.contact";
/// <summary>
- /// Database record ID of the contact.
+ /// DB record ID of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact.
+ /// Display name of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of the display name, refer to the DisplayNameSourceType.
+ /// The source type of display name, refer to the DisplayNameSourceType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the contact belongs to.
+ /// AddressBook ID that the contact belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Ringtone path of the contact.
+ /// Ringtone path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path of the contact.
+ /// Image thumbnail path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// The contact is a favorite or not.
+ /// The contact is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite;
/// <summary>
- /// The contact has a phone number or not.
+ /// The contact has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber;
/// <summary>
- /// The contact has an email or not.
+ /// The contact has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.ContactHasEmail;
/// <summary>
- /// Person ID that the contact belongs to. If set when inserting, a contact will be linked to the person.
+ /// Person ID that the contact belongs to. If set when inserting, a contact will be linked to person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ContactUId;
/// <summary>
- /// Vibration path of the contact.
+ /// Vibration path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.ContactVibration;
/// <summary>
- /// Message alert path of the contact.
+ /// Message alert path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert;
/// <summary>
- /// Last changed contact time.
+ /// Last changed contact time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.ContactChangedTime;
/// <summary>
- /// The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored.
+ /// The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkMode = (uint)Property.Id.ContactLinkMode;
/// <summary>
- /// Name child record (single).
+ /// Name child record (single)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.ContactName;
/// <summary>
- /// Company child record (multiple).
+ /// Company child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Company = (uint)Property.Id.ContactCompany;
/// <summary>
- /// Note child record (multiple).
+ /// Note child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Note = (uint)Property.Id.ContactNote;
/// <summary>
- /// Number child record (multiple).
+ /// Number child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.ContactNumber;
/// <summary>
- /// Email child record (multiple).
+ /// Email child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.ContactEmail;
/// <summary>
- /// Event child record (multiple).
+ /// Event child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Event = (uint)Property.Id.ContactEvent;
/// <summary>
- /// Messenger child record (multiple).
+ /// Messenger child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Messenger = (uint)Property.Id.ContactMessenger;
/// <summary>
- /// Address child record (multiple).
+ /// Address child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.ContactAddress;
/// <summary>
- /// URL child record (multiple).
+ /// URL child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URL = (uint)Property.Id.ContactURL;
/// <summary>
- /// Nickname child record (multiple).
+ /// Nickname child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Nickname = (uint)Property.Id.ContactNickname;
/// <summary>
- /// Profile child record (multiple).
+ /// Profile child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Profile = (uint)Property.Id.ContactProfile;
/// <summary>
- /// Relationship child record (multiple).
+ /// Relationship child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Relationship = (uint)Property.Id.ContactRelationship;
/// <summary>
- /// Image child record (multiple).
+ /// Image child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Image = (uint)Property.Id.ContactImage;
/// <summary>
- /// GroupRelation child record (multiple).
+ /// GroupRelation child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupRelation = (uint)Property.Id.ContactGroupRelation;
/// <summary>
- /// Extension child record (multiple).
+ /// Extension child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extension = (uint)Property.Id.ContactExtension;
/// <summary>
- /// SIP child record (multiple).
+ /// Sip child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sip = (uint)Property.Id.ContactSip;
/// <summary>
- /// Enumeration for the link modes when inserting the contact.
+ /// Enumeration for link mode when inserting contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LinkModeValue
{
/// <summary>
- /// Auto link immediately.
+ /// Auto link immediately
/// </summary>
/// <since_tizen> 4 </since_tizen>
Auto,
/// <summary>
- /// Do not auto link when the contact is inserted.
+ /// Do not auto link when the contact is inserted
/// </summary>
/// <since_tizen> 4 </since_tizen>
None
}
/// <summary>
- /// Enumeration for the Contact display name source types.
+ /// Enumeration for Contact display name source type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DisplayNameSourceType
{
/// <summary>
- /// Invalid source of the display name.
+ /// Invalid source of display name
/// </summary>
/// <since_tizen> 4 </since_tizen>
Invalid,
/// <summary>
- /// Produced display name from the email record.
+ /// Produced display name from email record
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email,
/// <summary>
- /// Produced display name from the number record.
+ /// Produced display name from number record
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number,
/// <summary>
- /// Produced display name from the nickname record.
+ /// Produced display name from nickname record
/// </summary>
/// <since_tizen> 4 </since_tizen>
Nickname,
/// <summary>
- /// Produced display name from the company record.
+ /// Produced display name from company record
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company,
/// <summary>
- /// Produced display name from the name record.
+ /// Produced display name from name record
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name,
}
/// <summary>
- /// Enumeration for the contacts data types.
+ /// Enumeration for contacts data type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DataType
{
/// <summary>
- /// None.
+ /// None
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Name.
+ /// Name
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name = 1,
/// <summary>
- /// Address.
+ /// Address
/// </summary>
/// <since_tizen> 4 </since_tizen>
Address = 2,
/// <summary>
- /// Messenger.
+ /// Messenger
/// </summary>
/// <since_tizen> 4 </since_tizen>
Messenger = 3,
/// <summary>
- /// URL.
+ /// URL
/// </summary>
/// <since_tizen> 4 </since_tizen>
URL = 4,
/// <summary>
- /// Event.
+ /// Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event = 5,
/// <summary>
- /// Company.
+ /// Company
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company = 6,
/// <summary>
- /// Nickname.
+ /// Nickname
/// </summary>
/// <since_tizen> 4 </since_tizen>
Nickname = 7,
/// <summary>
- /// Number.
+ /// Number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number = 8,
/// <summary>
- /// Email.
+ /// Email
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email = 9,
/// <summary>
- /// Profile.
+ /// Profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
Profile = 10,
/// <summary>
- /// Relationship.
+ /// Relationship
/// </summary>
/// <since_tizen> 4 </since_tizen>
Relationship = 11,
/// <summary>
- /// Note.
+ /// Note
/// </summary>
/// <since_tizen> 4 </since_tizen>
Note = 12,
/// <summary>
- /// Image.
+ /// Image
/// </summary>
/// <since_tizen> 4 </since_tizen>
Image = 13,
/// <summary>
- /// SIP.
+ /// SIP
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sip = 14,
/// <summary>
- /// Extension.
+ /// Extension
/// </summary>
/// <since_tizen> 4 </since_tizen>
Extension = 100
}
/// <summary>
- /// Describes the properties of a Simple contact record.
+ /// Describes properties of a Simple contact record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class SimpleContact
{
/// <summary>
- /// Identifier of this simple contact view.
+ /// Identifier of this simple contact view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact";
/// <summary>
- /// Database record ID of the contact.
+ /// DB record ID of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact.
+ /// Display name of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of the display name, refer to the Contact.DisplayNameSourceType
+ /// The source type of display name, refer to the Contact.DisplayNameSourceType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook that the contact belongs to.
+ /// AddressBook that the contact belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Ringtone path of the contact.
+ /// Ringtone path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path of the contact.
+ /// Image thumbnail path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// The contact is a favorite or not.
+ /// The contact is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite;
/// <summary>
- /// The contact has a phone number or not.
+ /// The contact has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber;
/// <summary>
- /// The contact has an email or not.
+ /// The contact has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.ContactHasEmail;
/// <summary>
- /// Person ID that the contact belongs to.
+ /// Person ID that the contact belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ContactUId;
/// <summary>
- /// Vibration path of the contact.
+ /// Vibration path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.ContactVibration;
/// <summary>
- /// Message alert path of the contact.
+ /// Message alert path of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert;
/// <summary>
- /// Last changed contact time.
+ /// Last changed contact time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.ContactChangedTime;
}
/// <summary>
- /// Describes the properties of My profile record.
+ /// Describes properties of a My profile record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class MyProfile
{
/// <summary>
- /// Identifier of this my profile view.
+ /// Identifier of this my profile view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.my_profile";
/// <summary>
- /// Database record ID of the my profile.
+ /// DB record ID of the my profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.MyProfileId;
/// <summary>
- /// Display name of the profile.
+ /// Display name of the profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.MyProfileDisplayName;
/// <summary>
- /// AddressBook ID that the profile belongs to.
+ /// AddressBook ID that the profile belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.MyProfileAddressBookId;
/// <summary>
- /// Image thumbnail path of the profile.
+ /// Image thumbnail path of the profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.MyProfileThumbnail;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.MyProfileUId;
/// <summary>
- /// Last changed profile time.
+ /// Last changed profile time
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.MyProfileChangedTime;
/// <summary>
- /// Name child record (single).
+ /// Name child record (single)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.MyProfileName;
/// <summary>
- /// Company child record (multiple).
+ /// Company child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Company = (uint)Property.Id.MyProfileCompany;
/// <summary>
- /// Note child record (multiple).
+ /// Note child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Note = (uint)Property.Id.MyProfileNote;
/// <summary>
- /// Number child record (multiple).
+ /// Number child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.MyProfileNumber;
/// <summary>
- /// Email child record (multiple).
+ /// Email child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.MyProfileEmail;
/// <summary>
- /// Event child record (multiple).
+ /// Event child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Event = (uint)Property.Id.MyProfileEvent;
/// <summary>
- /// Messenger child record (multiple).
+ /// Messenger child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Messenger = (uint)Property.Id.MyProfileMessenger;
/// <summary>
- /// Address child record (multiple).
+ /// Address child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.MyProfileAddress;
/// <summary>
- /// URL child record (multiple).
+ /// URL child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URL = (uint)Property.Id.MyProfileURL;
/// <summary>
- /// Nickname child record (multiple).
+ /// Nickname child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Nickname = (uint)Property.Id.MyProfileNickname;
/// <summary>
- /// Profile child record (multiple).
+ /// Profile child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Profile = (uint)Property.Id.MyProfileProfile;
/// <summary>
- /// Relationship child record (multiple).
+ /// Relationship child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Relationship = (uint)Property.Id.MyProfileRelationship;
/// <summary>
- /// Image child record (multiple).
+ /// Image child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Image = (uint)Property.Id.MyProfileImage;
/// <summary>
- /// Extension child record (multiple).
+ /// Extension child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extension = (uint)Property.Id.MyProfileExtension;
/// <summary>
- /// SIP child record (multiple).
+ /// Sip child record (multiple)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sip = (uint)Property.Id.MyProfileSip;
}
/// <summary>
- /// Describes the properties of a Name record.
+ /// Describes properties of a Name record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Name
{
/// <summary>
- /// Identifier of this contacts name view.
+ /// Identifier of this contacts name view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.name";
/// <summary>
- /// Database record ID of the name.
+ /// DB record ID of the name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NameId;
/// <summary>
- /// Contacts ID that the name record belongs to.
+ /// Contacts ID that the name record belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NameContactId;
/// <summary>
- /// First name.
+ /// First name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint First = (uint)Property.Id.NameFirst;
/// <summary>
- /// Last name.
+ /// Last name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Last = (uint)Property.Id.NameLast;
/// <summary>
- /// Middle name.
+ /// Middle name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Addition = (uint)Property.Id.NameAddition;
/// <summary>
- /// Suffix.
+ /// Suffix
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Suffix = (uint)Property.Id.NameSuffix;
/// <summary>
- /// Prefix.
+ /// Prefix
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Prefix = (uint)Property.Id.NamePrefix;
/// <summary>
- /// Pronounce the first name.
+ /// Pronounce the first name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticFirst = (uint)Property.Id.NamePhoneticFirst;
/// <summary>
- /// Pronounce the middle name.
+ /// Pronounce the middle name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticMiddle = (uint)Property.Id.NamePhoneticMiddle;
/// <summary>
- /// Pronounce the last name.
+ /// Pronounce the last name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticLast = (uint)Property.Id.NamePhoneticLast;
}
/// <summary>
- /// Describes the properties of a Number record.
+ /// Describes properties of a Number record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Number
{
/// <summary>
- /// Identifier of this contacts number view.
+ /// Identifier of this contacts number view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.number";
/// <summary>
- /// Database record ID of the number.
+ /// DB record ID of the number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NumberId;
/// <summary>
- /// Contact ID that the number belongs to.
+ /// Contact ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NumberContactId;
/// <summary>
- /// Number type, refer to the Types.
+ /// Number type, refer to the Types
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// Custom number type label, when the number type is Types.Custom.
+ /// Custom number type label, when the number type is Types.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is the default number or not.
+ /// The number is default number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.NumberIsDefault;
/// <summary>
- /// Number.
+ /// Number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberData = (uint)Property.Id.NumberNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// Enumeration for the number types.
+ /// Enumeration for number type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other number type.
+ /// Other number type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom number type.
+ /// Custom number type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// A telephone number associated with a residence.
+ /// A telephone number associated with a residence
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// A telephone number associated with a place of work.
+ /// A telephone number associated with a place of work
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A voice telephone number.
+ /// A voice telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Voice = 1 << 3,
/// <summary>
- /// A facsimile telephone number.
+ /// A facsimile telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Fax = 1 << 4,
/// <summary>
- /// The telephone number has voice messaging support.
+ /// The telephone number has voice messaging support
/// </summary>
/// <since_tizen> 4 </since_tizen>
Message = 1 << 5,
/// <summary>
- /// A cellular telephone number.
+ /// A cellular telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cell = 1 << 6,
/// <summary>
- /// A paging device telephone number.
+ /// A paging device telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Pager = 1 << 7,
/// <summary>
- /// A bulletin board system telephone number.
+ /// A bulletin board system telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
BBS = 1 << 8,
/// <summary>
- /// A modem connected telephone number.
+ /// A MODEM connected telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Modem = 1 << 9,
/// <summary>
- /// A car-phone telephone number.
+ /// A car-phone telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Car = 1 << 10,
/// <summary>
- /// An ISDN service telephone number.
+ /// An ISDN service telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
ISDN = 1 << 11,
/// <summary>
- /// A video conferencing telephone number.
+ /// A video conferencing telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Video = 1 << 12,
/// <summary>
- /// A personal communication services telephone number.
+ /// A personal communication services telephone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
PCS = 1 << 13,
/// <summary>
- /// A company main number.
+ /// A company main number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company = 1 << 14,
/// <summary>
- /// A radio phone number.
+ /// A radio phone number
/// </summary>
/// <since_tizen> 4 </since_tizen>
Radio = 1 << 15,
/// <summary>
- /// An additional type for the main.
+ /// An additional type for main
/// </summary>
/// <since_tizen> 4 </since_tizen>
Main = 1 << 29,
/// <summary>
- /// An additional type for the assistant.
+ /// An additional type for assistant
/// </summary>
/// <since_tizen> 4 </since_tizen>
Assistant = 1 << 30,
}
/// <summary>
- /// Describes the properties of an Email record.
+ /// Describes properties of a Email record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Email
{
/// <summary>
- /// Identifier of this contacts email view.
+ /// Identifier of this contacts email view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.email";
/// <summary>
- /// Database record ID of the email.
+ /// DB record ID of the email
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EmailId;
/// <summary>
- /// Contact ID that the email belongs to.
+ /// Contact ID that the email belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EmailContactId;
/// <summary>
- /// Email type, refer to the Types.
+ /// Email type, refer to the Types
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// Custom mail type label, when the email type is Types.Custom.
+ /// Custom mail type label, when the email type is Types.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// The email is default email or not.
+ /// The email is default email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.EmailIsDefault;
/// <summary>
- /// Email address.
+ /// Email address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.EmailEmail;
/// <summary>
- /// Enumeration for the contact email types.
+ /// Enumeration for Contact email type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other email type.
+ /// Other email type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom email type.
+ /// Custom email type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// An email address associated with a residence.
+ /// An email address associated with a residence
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// An email address associated with a place of work.
+ /// An email address associated with a place of work
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A mobile email address.
+ /// A mobile email address
/// </summary>
/// <since_tizen> 4 </since_tizen>
Mobile = 1 << 3,
}
/// <summary>
- /// Describes the properties of an Address record.
+ /// Describes properties of a Address record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Address
{
/// <summary>
- /// Identifier of this contacts address view.
+ /// Identifier of this contacts address view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.address";
/// <summary>
- /// Database record ID of the address.
+ /// DB record ID of the address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.AddressId;
/// <summary>
- /// Contact ID that the address belongs to.
+ /// Contact ID that the address belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.AddressContactId;
/// <summary>
- /// Address type, refer to the Types.
+ /// Address type, refer to the Types
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.AddressType;
/// <summary>
- /// Address type label, when the address type is Types.Custom.
+ /// Address type label, when the address type is Types.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.AddressLabel;
/// <summary>
- /// Post office box.
+ /// Post office box
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Postbox = (uint)Property.Id.AddressPostbox;
/// <summary>
- /// Postal code.
+ /// Postal code
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PostalCode = (uint)Property.Id.AddressPostalCode;
/// <summary>
- /// Region.
+ /// Region
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Region = (uint)Property.Id.AddressRegion;
/// <summary>
- /// Locality.
+ /// Locality
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Locality = (uint)Property.Id.AddressLocality;
/// <summary>
- /// Street.
+ /// Street
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Street = (uint)Property.Id.AddressStreet;
/// <summary>
- /// Country.
+ /// Country
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Country = (uint)Property.Id.AddressCountry;
/// <summary>
- /// Extended address.
+ /// Extended address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.AddressExtended;
/// <summary>
- /// The address is the default or not.
+ /// The address is default or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.AddressIsDefault;
/// <summary>
- /// Enumeration for the contact address types.
+ /// Enumeration for Contact address type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other address type.
+ /// Other address type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom address type.
+ /// Custom address type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// A delivery address for a residence.
+ /// A delivery address for a residence
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// A delivery address for a place of work.
+ /// A delivery address for a place of work
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A domestic delivery address.
+ /// A domestic delivery address
/// </summary>
/// <since_tizen> 4 </since_tizen>
Domestic = 1 << 3,
/// <summary>
- /// An international delivery address.
+ /// An international delivery address
/// </summary>
/// <since_tizen> 4 </since_tizen>
International = 1 << 4,
/// <summary>
- /// A postal delivery address.
+ /// A postal delivery address
/// </summary>
/// <since_tizen> 4 </since_tizen>
Postal = 1 << 5,
/// <summary>
- /// A parcel delivery address.
+ /// A parcel delivery address
/// </summary>
/// <since_tizen> 4 </since_tizen>
Parcel = 1 << 6,
}
/// <summary>
- /// Describes the properties of a Note record.
+ /// Describes properties of a Note record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Note
{
/// <summary>
- /// Identifier of this contacts note view.
+ /// Identifier of this contacts note view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.note";
/// <summary>
- /// Database record ID of the note.
+ /// DB record ID of the note
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NoteId;
/// <summary>
- /// Contact ID that the note belongs to.
+ /// Contact ID that the note belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NoteContactId;
/// <summary>
- /// Note contents.
+ /// Note contents
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Contents = (uint)Property.Id.NoteNote;
}
/// <summary>
- /// Describes the properties of a URL record.
+ /// Describes properties of a URL record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class URL
{
/// <summary>
- /// Identifier of this contacts URL view.
+ /// Identifier of this contacts URL view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.url";
/// <summary>
- /// Database record ID of the URL.
+ /// DB record ID of the URL
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.URLId;
/// <summary>
- /// Contact ID that the URL belongs to.
+ /// Contact ID that the URL belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.URLContactId;
/// <summary>
- /// URL type, refer to the TypeValue.
+ /// URL type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.URLType;
/// <summary>
- /// Custom URL type label, when the URL type is TypeValue.Custom.
+ /// Custom URL type label, when the URL type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.URLLabel;
/// <summary>
- /// URL.
+ /// URL
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URLData = (uint)Property.Id.URLData;
/// <summary>
- /// Enumeration for the Contact URL types.
+ /// Enumeration for Contact URL type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other URL type.
+ /// Other URL type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom URL type.
+ /// Custom URL type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Home URL type.
+ /// Home URL type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home,
/// <summary>
- /// Work URL type.
+ /// Work URL type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work,
}
/// <summary>
- /// Describes the properties of an Event record.
+ /// Describes properties of a Event record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")]
public static class Event
{
/// <summary>
- /// Identifier of this contacts event view.
+ /// Identifier of this contacts event view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.event";
/// <summary>
- /// Database record ID of the event.
+ /// DB record ID of the event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EventId;
/// <summary>
- /// Contact ID that the event belongs to.
+ /// Contact ID that the event belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EventContactId;
/// <summary>
- /// Event type, refer to the TypeValue.
+ /// Event type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EventType;
/// <summary>
- /// Custom event type label, when the event type is TypeValue.Custom.
+ /// Custom event type label, when the event type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EventLabel;
/// <summary>
- /// Event date(YYYYMMDD). For example, 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you should set the Gregorian date.
+ /// Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Date = (uint)Property.Id.EventDate;
/// <summary>
- /// Calendar type, refer to the CalendarType.
+ /// Calendar type, refer to the CalendarType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsLeapMonth = (uint)Property.Id.EventIsLeapMonth;
/// <summary>
- /// Enumeration for the Contact event types.
+ /// Enumeration for Contact event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other event type.
+ /// Other event type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom event type.
+ /// Custom event type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Birthday event type.
+ /// Birthday event type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Birthday,
/// <summary>
- /// Anniversary event type.
+ /// Anniversary event type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Anniversary
}
/// <summary>
- /// Enumeration for the Contact event calendar types.
+ /// Enumeration for Contact event calendar type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CalendarType
{
/// <summary>
- /// Gregorian calendar.
+ /// Gregorian calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
Gregorian,
/// <summary>
- /// Chinese calendar.
+ /// Chinese calendar
/// </summary>
/// <since_tizen> 4 </since_tizen>
Chinese
}
/// <summary>
- /// Describes the properties of a Relationship record.
+ /// Describes properties of a Relationship record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Relationship
{
/// <summary>
- /// Identifier of this relationship view.
+ /// Identifier of this relationship view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.relationship";
/// <summary>
- /// Database record ID of the relationship.
+ /// DB record ID of the relationship
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.RelationshipId;
/// <summary>
- /// Contact ID that the relationship belongs to.
+ /// Contact ID that the relationship belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.RelationshipContactId;
/// <summary>
- /// Relationship type, refer to the TypeValue.
+ /// Relationship type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.RelationshipType;
/// <summary>
- /// Custom relationship type label, when the relationship type is TypeValue.Custom.
+ /// Custom relationship type label, when the relationship type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.RelationshipLabel;
/// <summary>
- /// Selected contact name that the relationship belongs to.
+ /// Selected contact name that the relationship belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.RelationshipName;
/// <summary>
- /// Enumeration for the contact relationship types.
+ /// Enumeration for Contact relationship type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other relationship type.
+ /// Other relationship type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Assistant type.
+ /// Assistant type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Assistant,
/// <summary>
- /// Brother type.
+ /// Brother type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Brother,
/// <summary>
- /// Child type.
+ /// Child type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Child,
/// <summary>
- /// Domestic Partner type.
+ /// Domestic Partner type
/// </summary>
/// <since_tizen> 4 </since_tizen>
DomesticPartner,
/// <summary>
- /// Father type.
+ /// Father type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Father,
/// <summary>
- /// Friend type.
+ /// Friend type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Friend,
/// <summary>
- /// Manager type.
+ /// Manager type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Manager,
/// <summary>
- /// Mother type.
+ /// Mother type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Mother,
/// <summary>
- /// Parent type.
+ /// Parent type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Parent,
/// <summary>
- /// Partner type.
+ /// Partner type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Partner,
/// <summary>
- /// Referred by type.
+ /// Referred by type
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReferredBy,
/// <summary>
- /// Relative type.
+ /// Relative type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Relative,
/// <summary>
- /// Sister type.
+ /// Sister type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sister,
/// <summary>
- /// Spouse type.
+ /// Spouse type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Spouse,
/// <summary>
- /// Custom type.
+ /// Custom type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
}
/// <summary>
- /// Describes the properties of an Image record.
+ /// Describes properties of a Image record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Image
{
/// <summary>
- /// Identifier of this contacts image view.
+ /// Identifier of this contacts image view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.image";
/// <summary>
- /// Database record ID of the image.
+ /// DB record ID of the image
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ImageId;
/// <summary>
- /// Contact ID that the image belongs to.
+ /// Contact ID that the image belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ImageContactId;
/// <summary>
- /// Image type, refer to the TypeValue.
+ /// Image type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.ImageType;
/// <summary>
- /// Custom image type label, when the image type is TypeValue.Custom.
+ /// Custom image type label, when the image type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.ImageLabel;
/// <summary>
- /// Image thumbnail path.
+ /// Image thumbnail path
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Path = (uint)Property.Id.ImagePath;
/// <summary>
- /// The image is the default or not.
+ /// The Image is default or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.ImageIsDefault;
/// <summary>
- /// Enumeration for the contact image types.
+ /// Enumeration for Contact image type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other type.
+ /// Other type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom type.
+ /// Custom type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
}
/// <summary>
- /// Describes the properties of a Company record.
+ /// Describes properties of a Company record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Company
{
/// <summary>
- /// Identifier of this contacts company view.
+ /// Identifier of this contacts company view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.company";
/// <summary>
- /// Database record ID of the company.
+ /// DB record ID of the company
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.CompanyId;
/// <summary>
- /// Contact ID that the company belongs to.
+ /// Contact ID that the company belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.CompanyContactId;
/// <summary>
- /// Company type, refer to the TypeValue.
+ /// Company type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.CompanyType;
/// <summary>
- /// Custom company type label, when the company type is TypeValue.Custom.
+ /// Custom company type label, when the company type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.CompanyLabel;
/// <summary>
- /// Company name.
+ /// Company name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.CompanyName;
/// <summary>
- /// Department.
+ /// Department
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Department = (uint)Property.Id.CompanyDepartment;
/// <summary>
- /// Job title.
+ /// Job title
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint JobTitle = (uint)Property.Id.CompanyJobTitle;
/// <summary>
- /// Assistant name.
+ /// Assistant name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AssistantName = (uint)Property.Id.CompanyAssistantName;
/// <summary>
- /// Role.
+ /// Role
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Role = (uint)Property.Id.CompanyRole;
/// <summary>
- /// Company logo image file path.
+ /// Company logo image file path
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Logo = (uint)Property.Id.CompanyLogo;
/// <summary>
- /// Company location.
+ /// Company location
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.CompanyLocation;
/// <summary>
- /// Description.
+ /// Description
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.CompanyDescription;
/// <summary>
- /// Pronounce the company name.
+ /// Pronounce the company name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticName = (uint)Property.Id.CompanyPhoneticName;
/// <summary>
- /// Enumeration for the contact company types.
+ /// Enumeration for Contact company type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other type.
+ /// Other type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom type.
+ /// Custom type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// Work type.
+ /// Work type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 1,
}
/// <summary>
- /// Describes the properties of a Nickname record.
+ /// Describes properties of a Nickname record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Nickname
{
/// <summary>
- /// Identifier of this contacts nickname view.
+ /// Identifier of this contacts nickname view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.nickname";
/// <summary>
- /// Database record ID of the nickname.
+ /// DB record ID of the nickname
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NicknameId;
/// <summary>
- /// Contact ID that the nickname belongs to.
+ /// Contact ID that the nickname belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NicknameContactId;
/// <summary>
- /// Nickname.
+ /// Nickname
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.NicknameName;
}
/// <summary>
- /// Describes the properties of a Messenger record.
+ /// Describes properties of a Messenger record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Messenger
{
/// <summary>
- /// Identifier of this contacts messenger view.
+ /// Identifier of this contacts messenger view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.messenger";
/// <summary>
- /// Database record ID of the messenger.
+ /// DB record ID of the messenger
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.MessengerId;
/// <summary>
- /// Contact ID that the messenger belongs to.
+ /// Contact ID that the messenger belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.MessengerContactId;
/// <summary>
- /// Messenger type, refer to the TypeValue.
+ /// Messenger type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.MessengerType;
/// <summary>
- /// Custom messenger type label, when the messenger type is TypeValue.Custom.
+ /// Custom messenger type label, when the messenger type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.MessengerLabel;
/// <summary>
- /// Messenger ID (email address, email ID, and so on).
+ /// Messenger ID (email address or email ID...)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IMId = (uint)Property.Id.MessengerIMId;
/// <summary>
- /// Enumeration for the contact messenger types.
+ /// Enumeration for Contact messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other messenger type.
+ /// Other messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom messenger type.
+ /// Custom messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Google messenger type.
+ /// Google messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Google,
/// <summary>
- /// Windows Live messenger type.
+ /// Windows live messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
WindowsLive,
/// <summary>
- /// Yahoo messenger type.
+ /// Yahoo messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Yahoo,
/// <summary>
- /// Facebook messenger type.
+ /// Facebook messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Facebook,
/// <summary>
- /// ICQ type.
+ /// ICQ type
/// </summary>
/// <since_tizen> 4 </since_tizen>
ICQ,
/// <summary>
- /// AOL instance messenger type.
+ /// AOL instance messenger type
/// </summary>
/// <since_tizen> 4 </since_tizen>
AOL,
/// <summary>
- /// QQ type.
+ /// QQ type
/// </summary>
/// <since_tizen> 4 </since_tizen>
QQ,
/// <summary>
- /// Jabber type.
+ /// Jabber type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Jabber,
/// <summary>
- /// Skype type.
+ /// Skype type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Skype,
/// <summary>
- /// IRC type.
+ /// IRC type
/// </summary>
/// <since_tizen> 4 </since_tizen>
IRC,
}
/// <summary>
- /// Describes the properties of a Profile record.
+ /// Describes properties of a Profile record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces")]
public static class Profile
{
/// <summary>
- /// Identifier of this contacts profile view.
+ /// Identifier of this contacts profile view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.profile";
/// <summary>
- /// Database record ID of the profile.
+ /// DB record ID of profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ProfileId;
/// <summary>
- /// Contacts ID that the profile belongs to.
+ /// Contacts ID that the profile belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ProfileContactId;
/// <summary>
- /// Unique identifier.
+ /// Unique identifier
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ProfileUId;
/// <summary>
- /// Profile contents.
+ /// Profile contents
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Text = (uint)Property.Id.ProfileText;
/// <summary>
- /// Priority to display the profile.
+ /// Priority to display the profile
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Order = (uint)Property.Id.ProfileOrder;
/// <summary>
- /// Data for app_control_set_operation.
+ /// Data for app_control_set_operation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ServiceOperation = (uint)Property.Id.ProfileServiceOperation;
/// <summary>
- /// Data for app_control_set_mime.
+ /// Data for app_control_set_mime
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mime = (uint)Property.Id.ProfileMIME;
/// <summary>
- /// Data for app_control_set_app_id.
+ /// Data for app_control_set_app_id
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AppId = (uint)Property.Id.ProfileAppId;
/// <summary>
- /// Data for app_control_set_uri.
+ /// Data for app_control_set_uri
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ProfileUri = (uint)Property.Id.ProfileUri;
/// <summary>
- /// Data for app_control_set_category.
+ /// Data for app_control_set_category
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Category = (uint)Property.Id.ProfileCategory;
/// <summary>
- /// It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value.
+ /// It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData = (uint)Property.Id.ProfileExtraData;
}
/// <summary>
- /// Describes the properties of a SIP record.
+ /// Describes properties of a Sip record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Sip
{
/// <summary>
- /// Identifier of this contacts SIP view.
+ /// Identifier of this contacts sip view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.sip";
/// <summary>
- /// Database record ID of the SIP.
+ /// DB record ID of the sip
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.SipId;
/// <summary>
- /// Contact ID that the SIP belongs to.
+ /// Contact ID that the sip belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.SipContactId;
/// <summary>
- /// SIP address.
+ /// SIP address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.SipAddress;
/// <summary>
- /// SIP type, refer to the TypeValue.
+ /// sip type, refer to the TypeValue
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.SipType;
/// <summary>
- /// Custom SIP type label, when the SIP type is TypeValue.Custom.
+ /// Custom sip type label, when the sip type is TypeValue.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.SipLabel;
/// <summary>
- /// Enumeration for the contact SIP types.
+ /// Enumeration for Contact SIP type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other SIP type.
+ /// Other SIP type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom SIP type.
+ /// Custom SIP type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Home SIP type.
+ /// Home SIP type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home,
/// <summary>
- /// Work SIP type.
+ /// Work SIP type
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work,
}
/// <summary>
- /// Describes the properties of an Extension record.
+ /// Describes properties of a Extension record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Extension
{
/// <summary>
- /// Identifier of this contacts extension view.
+ /// Identifier of this contacts extension view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.extension";
/// <summary>
- /// Database record ID of the contact extension.
+ /// DB record ID of the contact extension
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ExtensionId;
/// <summary>
- /// Contact ID that the contact extension belongs to.
+ /// Contact ID that the contact extension belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ExtensionContactId;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data1 = (uint)Property.Id.ExtensionData1;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data2 = (uint)Property.Id.ExtensionData2;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data3 = (uint)Property.Id.ExtensionData3;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data4 = (uint)Property.Id.ExtensionData4;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data5 = (uint)Property.Id.ExtensionData5;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data6 = (uint)Property.Id.ExtensionData6;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data7 = (uint)Property.Id.ExtensionData7;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data8 = (uint)Property.Id.ExtensionData8;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data9 = (uint)Property.Id.ExtensionData9;
/// <summary>
- /// The extra child record format for the non-provided from thecontacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data10 = (uint)Property.Id.ExtensionData10;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data11 = (uint)Property.Id.ExtensionData11;
/// <summary>
- /// The extra child record format for the non-provided from the contacts-service.
+ /// The extra child record format for non-provided from contacts-service
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data12 = (uint)Property.Id.ExtensionData12;
}
/// <summary>
- /// Describes the properties of a Group relation record.
+ /// Describes properties of a Group relation record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class GroupRelation
{
/// <summary>
- /// Identifier of this relationship view.
+ /// Identifier of this relationship view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group_relation";
/// <summary>
- /// Database record ID of the group relation (cannot be used as a filter).
+ /// DB record ID of the group relation (can not be used as filter)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.GroupRelationId;
/// <summary>
- /// Database record ID of the group.
+ /// DB record ID of the group
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Database record ID of the contact.
+ /// DB record ID of the contact
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// Group name.
+ /// Group name
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.GroupRelationGroupName;
}
/// <summary>
- /// Describes the properties of a Speed dial record.
+ /// Describes properties of a Speed dial record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class SpeedDial
{
/// <summary>
- /// Identifier of this contacts speed dial view.
+ /// Identifier of this contact speed dial view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.speeddial";
/// <summary>
- /// Stored speed dial number.
+ /// Stored speed dial number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SpeedDialNumber = (uint)Property.Id.SpeedDialDialNumber;
/// <summary>
- /// Number ID that the speed dial belongs to.
+ /// Number ID that the speed dial belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.SpeedDialNumberId;
/// <summary>
- /// Contact number of the specified speed dial.
+ /// Contact number of specified speed dial
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.SpeedDialNumber;
/// <summary>
- /// Contact number label of the specified speed dial, when the number type is Number.Types.Custom.
+ /// Contact number label of specified speed dial, when the number type is Number.Types.Custom
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberLabel = (uint)Property.Id.SpeedDialNumberLabel;
/// <summary>
- /// Contact number type, refer to the Number.Types.
+ /// Contact number type, refer to the Number.Types
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberType = (uint)Property.Id.SpeedDialNumberType;
/// <summary>
- /// Person ID that the speed dial belongs to.
+ /// Person ID that the speed dial belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.SpeedDialPersonId;
/// <summary>
- /// Display name that the speed dial belongs to.
+ /// Display name that the speed dial belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.SpeedDialDisplayName;
/// <summary>
- /// Image thumbnail path that the speed dial belongs to.
+ /// Image thumbnail path that the speed dial belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.SpeedDialThumbnail;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.SpeedDialNormalizedNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.SpeedDialCleanedNumber;
/// <summary>
- /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly.
+ /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.SpeedDialNumberFilter;
}
/// <summary>
- /// Describes the properties of a Phone log record.
+ /// Describes properties of a Phone log record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class PhoneLog
{
/// <summary>
- /// Identifier of this phone log view.
+ /// Identifier of this phone log view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.phonelog";
/// <summary>
- /// Database record ID of phone log.
+ /// DB record ID of phone log
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.PhonelogId;
/// <summary>
- /// Person ID that the phone log belongs to.
+ /// Person ID that the phone log belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PhonelogPersonId;
/// <summary>
- /// Number or email that the phone log displays.
+ /// Number or Email that the phone log displays
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.PhonelogAddress;
/// <summary>
- /// Call end time. The value means the number of seconds since 1970-01-01 00:00:00 (UTC).
+ /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogTime = (uint)Property.Id.PhonelogLogTime;
/// <summary>
- /// Log type, refer to the Type.
+ /// Log type, refer to the Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogLogType;
/// <summary>
- /// You can set the related integer data (For example, message_id, email_id, or duration (seconds) of the call).
+ /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1;
/// <summary>
- /// You can set the related string data (For example, short message, subject).
+ /// You can set the related string data (e.g. short message, subject)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter;
/// <summary>
- /// You can set the related SIM slot number. SimSlotNo 0 means the first SIM card, SimSlotNo 1 means the second SIM.
+ /// You can set the related Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
/// <summary>
- /// Enumeration for the phone log types.
+ /// Enumeration for Phone log type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
- /// None.
+ /// None
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Incoming call.
+ /// Incoming call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceIncoming = 1,
/// <summary>
- /// Outgoing call.
+ /// Outgoing call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceOutgoing = 2,
/// <summary>
- /// Incoming video call.
+ /// Incoming video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoIncoming = 3,
/// <summary>
- /// Outgoing video call.
+ /// Outgoing video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoOutgoing = 4,
/// <summary>
- /// Not confirmed missed call.
+ /// Not confirmed missed call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceMissedUnseen = 5,
/// <summary>
- /// Confirmed missed call.
+ /// Confirmed missed call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceMissedSeen = 6,
/// <summary>
- /// Not confirmed missed video call.
+ /// Not confirmed missed video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoMissedUnseen = 7,
/// <summary>
- /// Confirmed missed video call.
+ /// Confirmed missed video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoMissedSeen = 8,
/// <summary>
- /// Rejected call.
+ /// Rejected call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceRejected = 9,
/// <summary>
- /// Rejected video call.
+ /// Rejected video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoRejected = 10,
/// <summary>
- /// Blocked call.
+ /// Blocked call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceBlocked = 11,
/// <summary>
- /// Blocked video call.
+ /// Blocked video call
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoBlocked = 12,
/// <summary>
- /// Incoming MMS.
+ /// Incoming MMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSIncoming = 101,
/// <summary>
- /// Outgoing MMS.
+ /// Outgoing MMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSOutgoing = 102,
/// <summary>
- /// Incoming SMS.
+ /// Incoming SMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSIncoming = 103,
/// <summary>
- /// Outgoing SMS.
+ /// Outgoing SMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSOutgoing = 104,
/// <summary>
- /// Blocked SMS.
+ /// Blocked SMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSBlocked = 105,
/// <summary>
- /// Blocked MMS.
+ /// Blocked MMS
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSBlocked = 106,
/// <summary>
- /// Received email.
+ /// Received email
/// </summary>
/// <since_tizen> 4 </since_tizen>
EmailReceived = 201,
/// <summary>
- /// Sent email.
+ /// Sent email
/// </summary>
/// <since_tizen> 4 </since_tizen>
EmailSent = 202,
}
/// <summary>
- /// Describes the properties of a Contact updated information record.
+ /// Describes properties of a Contact updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactUpdatedInfo
{
/// <summary>
- /// Identifier of this contacts updated information view.
+ /// Identifier of this contact updated info view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.contacts_updated_info";
/// <summary>
- /// Updated contact ID.
+ /// Updated contact ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// AddressBook ID that the updated contact belongs to.
+ /// AddressBook ID that the updated contact belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Contact change type, refer to the ContactsViews.ChangeType.
+ /// Contact change type, refer to the ContactsViews.ChangeType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version.
+ /// Updated version
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
/// <summary>
- /// Contact image is changed or not.
+ /// Contact image is changed or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ImageChanged = (uint)Property.Id.UpdateInfoImageChanged;
}
/// <summary>
- /// Describes the properties of a My profile updated information record.
+ /// Describes properties of a My profile updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class MyProfileUpdatedInfo
{
/// <summary>
- /// Identifier of this my profile updated information view.
+ /// Identifier of this my profile updated info view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.my_profile_updated_info";
/// <summary>
- /// Address book ID that the updated my profile belongs to.
+ /// Address book ID that the updated my profile belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// MyProfile change type, refer to the ContactsViews.ChangeType.
+ /// MyProfile change type, refer to the ContactsViews.ChangeType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastChangedType = (uint)Property.Id.UpdateInfoLastChangedType;
/// <summary>
- /// Updated version.
+ /// Updated version
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes the properties of a Group updated information record.
+ /// Describes properties of a Group updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupUpdatedInfo
{
/// <summary>
- /// Identifier of this groups updated information view.
+ /// Identifier of this group updated info view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.groups_updated_info";
/// <summary>
- /// Updated group ID.
+ /// Updated group ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Address book ID that the updated group belongs to.
+ /// Address book ID that the updated group belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Group change type, refer to the ContactsViews.ChangeType.
+ /// Group change type, refer to the ContactsViews.ChangeType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version.
+ /// Updated version
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes the properties of a Group Member updated information record.
+ /// Describes properties of a Group Member updated information record.
/// </summary>
- /// <remarks>Read-only view.</remarks>
+ /// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupMemberUpdatedInfo
{
/// <summary>
- /// Identifier of this group members updated information view.
+ /// Identifier of this group member updated info view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.groups_member_updated_info";
/// <summary>
- /// Updated group ID.
+ /// Updated group ID
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Address book ID that the updated group belongs to.
+ /// Address book ID that the updated group belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Updated version.
+ /// Updated version
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes the properties of a Relation updated information record.
+ /// Describes properties of a Relation updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupRelationUpdatedInfo
{
/// <summary>
- /// Identifier of this group relations updated information view.
+ /// Identifier of this group relation updated info view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group_relations_updated_info";
/// <summary>
- /// Group ID of the group relation.
+ /// Group ID of group relation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupId;
/// <summary>
- /// Contact ID of the updated group relation.
+ /// Contact ID of the updated group relation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Address book ID of the contacts updated group relation.
+ /// Address book ID of contact that the updated group relation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.AddressBookId;
/// <summary>
- /// Group relation change type, refer to the ContactsViews.ChangeType.
+ /// Group relation change type, refer to the ContactsViews.ChangeType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version.
+ /// Updated version
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes the properties of a PersonContact record.
+ /// Describes properties of a PersonContact record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonContact
{
/// <summary>
- /// Identifier of this person's contact view.
+ /// Identifier of this person contact view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of the social account (projection).
+ /// Status of social account (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// Link count of the contact records (projection).
+ /// Link count of contact records (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// Contact ID that the person belongs to.
+ /// Contact ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection).
+ /// AddressBook IDs that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// AddressBook ID that the person belongs to.
+ /// AddressBook ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode.
+ /// AddressBook mode, refer to the AddressBook.Mode
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// AddressBook name that the person belongs to.
+ /// AddressBook name that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookName = (uint)Property.Id.AddressBookName;
/// <summary>
- /// Keyword matched data type, refer to the Contact.DataType.
+ /// keyword matched data type, refer to the Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonNumber record.
+ /// Describes properties of a PersonNumber record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonNumber
{
/// <summary>
- /// Identifier of this person's number view.
+ /// Identifier of this person number view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/number";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Number ID that the person belongs to.
+ /// Number ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.NumberId;
/// <summary>
- /// Number type, refer to the Number.Types (projection).
+ /// Number type, refer to the Number.Types (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// Custom number type label, when the number type is Number.Types.Custom (projection).
+ /// Custom number type label, when the number type is Number.Types.Custom (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is the default number or not.
+ /// The number is default number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault;
/// <summary>
- /// Number.
+ /// Number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.NumberNumber;
/// <summary>
- /// If you add filter with this property, the string will be normalized as the minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly.
+ /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
/// <summary>
- /// Keyword matched data type, refer to they Contact.DataType.
+ /// keyword matched data type, refer to they Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonEmail record.
+ /// Describes properties of a PersonEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonEmail
{
/// <summary>
- /// Identifier of this person's email view.
+ /// Identifier of this person email view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/email";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Email ID that the person belongs to.
+ /// Email ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EmailId;
/// <summary>
- /// Email type, refer to the Email.Types (projection).
+ /// Email type, refer to the Email.Types (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// Custom mail type label, when the email type is Email.Types.Custom (projection).
+ /// Custom mail type label, when the email type is Email.Types.Custom (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// The email is the default email or not.
+ /// The email is default email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault;
/// <summary>
- /// Email address.
+ /// Email address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.EmailEmail;
/// <summary>
- /// Keyword matched data type, refer to they Contact.DataType.
+ /// keyword matched data type, refer to they Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonGroupRelation record.
+ /// Describes properties of a PersonGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupRelation
{
/// <summary>
- /// Identifier of this person's group relation view.
+ /// Identifier of this person group relation view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account (projection).
+ /// Status of social account (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of the contact records (projection).
+ /// Link count of contact records (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection).
+ /// AddressBook IDs that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to.
+ /// AddressBook ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook name that the person belongs to.
+ /// AddressBook name that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookName = (uint)Property.Id.AddressBookName;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode.
+ /// AddressBook mode, refer to the AddressBook.Mode
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Group ID that the person belongs to.
+ /// Group ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Contact ID that the person belongs to (projection).
+ /// Contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// Keyword matched data type, refer to they Contact.DataType.
+ /// keyword matched data type, refer to they Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonGroupAssigned record.
+ /// Describes properties of a PersonGroupAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupAssigned
{
/// <summary>
- /// Identifier of this person's group assigned view.
+ /// Identifier of this person group assigned view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group_assigned";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of the social account (projection).
+ /// Status of social account (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of the contact records (projection).
+ /// Link count of contact records (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the linked person belongs to (projection).
+ /// AddressBook IDs that the linked person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to.
+ /// AddressBook ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode.
+ /// AddressBook mode, refer to the AddressBook.Mode
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Group ID that the person belongs to.
+ /// Group ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Contact ID that the person belongs to (projection).
+ /// Contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// Keyword matched data type, refer to they Contact.DataType.
+ /// keyword matched data type, refer to they Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonGroupNotAssigned record.
+ /// Describes properties of a PersonGroupNotAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupNotAssigned
{
/// <summary>
- /// Identifier of this person's group not assigned view.
+ /// Identifier of this person group not assigned view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group_not_assigned";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of the social account (projection).
+ /// Status of social account (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of the contact records (projection).
+ /// Link count of contact records (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the linked person belongs to (projection).
+ /// AddressBook IDs that the linked person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to.
+ /// AddressBook ID that the person belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode.
+ /// AddressBook mode, refer to the AddressBook.Mode
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Contact ID that the person belongs to (projection).
+ /// Contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Keyword matched data type, refer to they Contact.DataType.
+ /// keyword matched data type, refer to they Contact.DataType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// Keyword matched data string.
+ /// keyword matched data string
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes the properties of a PersonPhoneLog record.
+ /// Describes properties of a PersonPhoneLog record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonPhoneLog
{
/// <summary>
- /// Identifier of this phone log view.
+ /// Identifier of this phone log view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/phonelog";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Database record ID of phone log.
+ /// DB record ID of phone log
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogId = (uint)Property.Id.PhonelogId;
/// <summary>
- /// Number or email that the phone log displays.
+ /// Number or Email that the phone log displays
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.PhonelogAddress;
/// <summary>
- /// Number or email type (projection).
+ /// Number or Email type (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressType = (uint)Property.Id.DataData1;
/// <summary>
- /// Call end time. The value means the number of seconds since 1970-01-01 00:00:00 (UTC).
+ /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogTime = (uint)Property.Id.PhonelogLogTime;
/// <summary>
- /// Log type, refer to the PhoneLog.Types.
+ /// Log type, refer to the PhoneLog.Types
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogLogType;
/// <summary>
- /// You can set the related integer data (For exmaple, message_id, email_id, or duration (seconds) of the call) (projection).
+ /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1;
/// <summary>
- /// You can set the related string data (For example, short message, subject) (projection).
+ /// You can set the related string data (e.g. short message, subject) (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter;
/// <summary>
- /// It is related to the Sim SIM number. SimSlotNo 0 means the first SIM card, SimSlotNo 1 means the second SIM.
+ /// It is related to the Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
};
/// <summary>
- /// Describes the properties of a Person Usage record.
+ /// Describes properties of a Person Usage record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonUsage
{
/// <summary>
- /// Identifier of this person's usage view.
+ /// Identifier of this person usage view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/usag";
/// <summary>
- /// Database record ID of the person.
+ /// DB record ID of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person.
+ /// Display name of the person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// The first character of the first string for grouping. This is normalized using ICU (projection).
+ /// The first character of first string for grouping. This is normalized using ICU (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection).
+ /// Display contact ID that the person belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection).
+ /// Ringtone path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection).
+ /// Image thumbnail path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection).
+ /// Vibration path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection).
+ /// Message alert path of the person (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is a favorite or not.
+ /// The person is favorite or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has a phone number or not.
+ /// The person has phone number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has an email or not.
+ /// The person has email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Usage type, refer to the Type.
+ /// Usage type, refer to the Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UsageType = (uint)Property.Id.PersonUsageType;
/// <summary>
- /// Usage number of the person.
+ /// Usage number of person
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TimesUsed = (uint)Property.Id.PersonTimesUsed;
/// <summary>
- /// Enumeration for the person usage types.
+ /// Enumeration for Person usage type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
- /// None.
+ /// None
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Outgoing call.
+ /// Outgoing call
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingCall,
/// <summary>
- /// Outgoing message.
+ /// Outgoing message
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingMessage,
/// <summary>
- /// Outgoing email.
+ /// Outgoing email
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingEmail,
/// <summary>
- /// Incoming call.
+ /// Incoming call
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingCall,
/// <summary>
- /// Incoming message.
+ /// Incoming message
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingMessage,
/// <summary>
- /// Incoming email.
+ /// Incoming email
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingEmail,
/// <summary>
- /// Missed call.
+ /// Missed call
/// </summary>
/// <since_tizen> 4 </since_tizen>
MissedCall,
/// <summary>
- /// Rejected call.
+ /// Rejected call
/// </summary>
/// <since_tizen> 4 </since_tizen>
RejectedCall,
/// <summary>
- /// Blocked call.
+ /// Blocked call
/// </summary>
/// <since_tizen> 4 </since_tizen>
BlockedCall,
/// <summary>
- /// Blocked message.
+ /// Blocked message
/// </summary>
/// <since_tizen> 4 </since_tizen>
BlockedMessage
};
/// <summary>
- /// Describes the properties of a ContactNumber record.
+ /// Describes properties of a ContactNumber record.
/// </summary>
- /// <remarks>Read-only view.</remarks>
+ /// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactNumber
{
/// <summary>
- /// Identifier of this contacts number view.
+ /// Identifier of this contacts number view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/number";
/// <summary>
- /// Contact ID that the number belongs to.
+ /// Contact ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact that the number belongs to.
+ /// Display name of contact that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection).
+ /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to.
+ /// AddressBook ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to.
+ /// Person ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection).
+ /// Ringtone path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection).
+ /// Image thumbnail path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// Database record ID of the number.
+ /// DB record ID of the number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.NumberId;
/// <summary>
- /// Number type, refer to the Number.Types (projection).
+ /// Number type, refer to the Number.Types (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// Custom number type label, when the number type is Number.Types.Custom (projection).
+ /// Custom number type label, when the number type is Number.Types.Custom (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is the default number or not.
+ /// The number is default number or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.NumberIsDefault;
/// <summary>
- /// Number.
+ /// Number
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.NumberNumber;
/// <summary>
- /// If you add a filter with this property, the string will be normalized as the minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly.
+ /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for the search filter.
+ /// You can only use this property for search filter
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
};
/// <summary>
- /// Describes the properties of a ContactEmail record.
+ /// Describes properties of a ContactEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactEmail
{
/// <summary>
- /// Identifier of this contacts email view.
+ /// Identifier of this contacts email view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/email";
/// <summary>
- /// Contact ID that the number belongs to.
+ /// Contact ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact that the number belongs to.
+ /// Display name of contact that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection).
+ /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to.
+ /// AddressBook ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to.
+ /// Person ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection).
+ /// Ringtone path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection).
+ /// Image thumbnail path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// Database record ID of the email.
+ /// DB record ID of the email
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EmailId;
/// <summary>
- /// Email type, refer to the Email.Types (projection).
+ /// Email type, refer to the Email.Types (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// Custom mail type label, when the email type is Email.Types.Custom (projection).
+ /// Custom mail type label, when the email type is Email.Types.Custom (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// The email is the default email or not.
+ /// Email is default email or not
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.EmailIsDefault;
/// <summary>
- /// Email address.
+ /// Email address
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.EmailEmail;
};
/// <summary>
- /// Describes the properties of a ContactGroupRelation record.
+ /// Describes properties of a ContactGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactGroupRelation
{
/// <summary>
- /// Identifier of this contacts group relation view.
+ /// Identifier of this contact group relation view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/group";
/// <summary>
- /// Contact ID that the number belongs to.
+ /// Contact ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact that the number belongs to.
+ /// Display name of contact that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection).
+ /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to.
+ /// AddressBook ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to.
+ /// Person ID that the number belongs to
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection).
+ /// Ringtone path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection).
+ /// Image thumbnail path that the number belongs to (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// Database record ID of the group relation.
+ /// DB record ID of the group relation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Group name (projection).
+ /// Group name (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupName = (uint)Property.Id.GroupRelationGroupName;
};
/// <summary>
- /// Describes the properties of a Phone Log Statistics record.
+ /// Describes properties of a Phone Log Statistics record.
/// </summary>
- /// <remarks>Read-only view.</remarks>
+ /// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PhoneLogStatistics
{
/// <summary>
- /// Identifier of this log statistics view.
+ /// Identifier of this log statistics view
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.phonelog_stat";
/// <summary>
- /// Log count (projection).
+ /// Log count (projection)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogCount = (uint)Property.Id.PhonelogStatLogCount;
/// <summary>
- /// Log type, see the contacts_phone_log_type_e.
+ /// Log type, see the contacts_phone_log_type_e
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogStatLogType;
/// <summary>
- /// It is related to the SIM slot number. sim_slot_no 0 means the first SIM card, sim_slot_no 1 means the second SIM. It is same with the handle index of the telephony handle list. Refer to the telephony_init().
+ /// It is related to the Sim slot number. sim_slot_no 0 means first Sim card, sim_slot_no 1 means second Sim. It is same with handle index of telephony handle list. Refer to the telephony_init()
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogStatSimSlotNo;
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when the contacts database is changed.
+ /// Event arguments passed when contacts database is changed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBChangedEventArgs : EventArgs
}
/// <summary>
- /// The contacts view URI is changed.
+ /// The contacts view URI changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ViewUri
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when the contacts database status is changed.
+ /// Event arguments passed when contacts database status is changed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBStatusChangedEventArgs : EventArgs
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when a setting value of the contacts name display order is changed.
+ /// Event arguments passed when setting value of contacts name display order is changed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class NameDisplayOrderChangedEventArgs : EventArgs
}
/// <summary>
- /// A setting value of the contacts name display order.
+ /// A setting value of contacts name display order
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ContactDisplayOrder NameDisplayOrder
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when a setting value of the contacts name sorting order is changed.
+ /// Event arguments passed when setting value of contacts name sorting order is changed
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class NameSortingOrderChangedEventArgs : EventArgs
}
/// <summary>
- /// A setting value of the contacts name sorting order.
+ /// A setting value of contacts name sorting order
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ContactSortingOrder NameSortingOrder
}
/// <summary>
- /// The Utility method to check for an error, returns false if failed and prints warning messages.
+ /// Utility method to check for error, returns false if failed and print warning messages
/// </summary>
- /// <returns>true in case of no error, false otherwise.</returns>
+ /// <returns>true in case of no error, false otherwise</returns>
internal static bool WarnIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
}
/// <summary>
- /// The Utility method checks for an error, returns false if failed and throws an exception.
+ /// Utility method to check for error, returns false if failed and throw exception
/// </summary>
- /// <returns>true in case of no error.</returns>
+ /// <returns>true in case of no error</returns>
internal static bool ThrowIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration for the transfer directions for endpoints.
+ /// Enumeration of transfer direction for Endpoints.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum EndpointDirection
{
/// <summary>
- /// In direction.
+ /// IN direction
/// </summary>
In = Interop.EndpointDirection.In,
/// <summary>
- /// Out direction.
+ /// OUT direction
/// </summary>
Out = Interop.EndpointDirection.Out,
/// <summary>
- /// Bidirectional.
+ /// Bi-directional
/// </summary>
InOut = Interop.EndpointDirection.InOut,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Event arguments for the Hot Plugged event for USB devices.
+ /// Event arguments for Hot Plugged event for USB devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class HotPluggedEventArgs : EventArgs
{
internal HotPluggedEventArgs(UsbDevice device, HotplugEventType type)
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDevice Device { get; }
/// <summary>
- /// Event type.
+ /// Event Type
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public HotplugEventType EventType { get; }
}
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration for the Hot Plugged event type for USB devices.
+ /// Enumeration of hot plugged event type for USB devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum HotplugEventType
{
/// <summary>
- /// USB device is attached.
+ /// USB device is attached
/// </summary>
Attach = Interop.HotplugEventType.Attach,
/// <summary>
- /// USB device is detached.
+ /// USB device is detached
/// </summary>
Detach = Interop.HotplugEventType.Detach,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration for the isochronous endpoints synchronization types.
+ /// Enumeration of isochronous endpoint's synchronization type.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum SynchronizationType
{
/// <summary>
- /// Asynchronous.
+ /// Asynchronous
/// </summary>
Asynchronous = Interop.SynchronizationType.Async,
/// <summary>
- /// Adaptive.
+ /// Adaptive
/// </summary>
Adaptive = Interop.SynchronizationType.Adaptive,
/// <summary>
- /// Synchronous.
+ /// Synchronous
/// </summary>
Synchronous = Interop.SynchronizationType.Sync,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration for an endpoint's usage types.
+ /// Enumeration of an endpoint's usage type.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum UsageType
{
/// <summary>
- /// Data endpoint.
+ /// Data endpoint
/// </summary>
Data = Interop.UsageType.Data,
/// <summary>
- /// Feedback endpoint.
+ /// Feedback endpoint
/// </summary>
Feedback = Interop.UsageType.Feedback,
/// <summary>
- /// Implicit feedback data endpoint.
+ /// Implicit feedback Data endpoint
/// </summary>
Implicit = Interop.UsageType.Implicit,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Bulk Endpoint class.
+ /// USB Bulk Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbBulkEndpoint : UsbEndpoint
}
/// <summary>
- /// Performs a USB transfer on a given endpoint. The direction of transfer is determined by the endpoint.
+ /// Performs a USB transfer on given endpoint. Direction of transfer is determined by the endpoint.
/// </summary>
- /// <param name="buffer">Suitably-sized data buffer for either an input or output (depending on the endpoint).</param>
+ /// <param name="buffer">Suitably-sized data buffer for either input or output (depending on endpoint).</param>
/// <param name="length">
- /// For writes, the number of bytes from the data to be sent. For reads, the maximum number of bytes to receive
+ /// For writes, the number of bytes from data to be sent, for reads the maximum number of bytes to receive
/// into the data buffer.
/// </param>
/// <param name="timeout">
- /// The time (in milliseconds) that this function should wait for, before giving up due to no response being
- /// received (for an unlimited timeout, 0 value should be used).
+ /// Time (in milliseconds) that this function should wait for before giving up due to no response being
+ /// received(for an unlimited timeout 0 value should be used).
/// </param>
- /// <returns>The number of bytes actually transferred.</returns>
+ /// <returns>Number of bytes actually transferred.</returns>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
- /// <exception cref="TimeoutException">Throws an exception if the transfer is timed out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
+ /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
return TransferImpl(buffer, length, timeout);
namespace Tizen.System.Usb
{
/// <summary>
- /// A class to manage the USB configuration.
+ /// Class to manage USB Configuration.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbConfiguration : IDisposable
{
internal readonly Interop.UsbConfigHandle _handle;
}
/// <summary>
- /// Checks if the device is self-powered in a given configuration.
+ /// Checks if device is self-powered in given configuration.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool IsSelfPowered
{
get
}
/// <summary>
- /// Checks if the device in a given configuration supports remote wakeup.
+ /// Checks if device in given configuration supports remote wakeup.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool SupportRemoteWakeup
{
get
}
/// <summary>
- /// Gets the maximum power required in a given configuration, in mA.
+ /// Gets maximum power required in given configuration, in mA.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int MaximumPowerRequired
{
get
}
/// <summary>
- /// A dictionary for mapping the interface IDs to interface instances for a given configuration.
+ /// Dictionary mapping interfaces Ids to interface instances for given configuration.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbInterface> Interfaces
{
get
}
/// <summary>
- /// The configuration string.
+ /// Configuration string.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
/// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed.
/// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string ConfigurationString
{
get
}
/// <summary>
- /// Sets this configuration as an active configuration for the device.
+ /// Set this configuration as active configuration for the device.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">
- /// Throws an exception if the device is disconnected, or not opened for an operation, or busy as its interfaces are currently claimed.
- /// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
+ /// <since_tizen> 5 </since_tizen>
public void SetAsActive()
{
ThrowIfDisposed();
private bool disposedValue = false;
/// <summary>
- /// Releases all the resources used by the ConnectionProfile.
- /// It should be called after it has finished using the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// Releases all resources used by the ConnectionProfile.
+ /// It should be called after finished using of the object.</summary>
+ /// <since_tizen> 5 </since_tizen>
internal virtual void Dispose(bool disposing)
{
if (!disposedValue)
/// <summary>
/// Finalizes an instance of the UsbConfiguration class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
~UsbConfiguration()
{
Dispose(false);
}
/// <summary>
- /// Releases all the resources used by the ConnectionProfile.
- /// It should be called after it has finished using the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// Releases all resources used by the ConnectionProfile.
+ /// It should be called after finished using of the object.</summary>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);
}
#endregion
}
-}
\ No newline at end of file
+}
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Control Endpoint class.
+ /// USB Control Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbControlEndpoint : UsbEndpoint
{
private readonly UsbDevice _device;
}
/// <summary>
- /// Gets the number of this endpoint.
+ /// Gets number of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5</since_tizen>
public new int Id
{
get
}
/// <summary>
- /// Gets the direction of this endpoint.
+ /// Gets direction of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public new EndpointDirection Direction
{
get
}
/// <summary>
- /// Gets the maximum packet size of a given endpoint.
+ /// Gets max packet size of given endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public new int MaxPacketSize
{
get
}
/// <summary>
- /// Performs a control transaction on the endpoint, zero for this device.
+ /// Performs a control transaction on endpoint zero for this device.
/// </summary>
/// <param name="requestType">bmRequestType type field for the setup packet.</param>
/// <param name="request">bRequest field for the setup packet.</param>
/// <param name="value">wValue field for the setup packet.</param>
/// <param name="index">wIndex field for the setup packet.</param>
- /// <param name="data">Suitably-sized data buffer for either an input or output (depending on the direction bits within a bmRequestType).</param>
+ /// <param name="data">Suitably-sized data buffer for either input or output, (depending on direction bits within bmRequestType).</param>
/// <param name="length">wLength field for the setup packet. The data buffer should be at least this size.</param>
/// <param name="timeout">
- /// The time (in milliseconds) that this function should wait for, before giving up due to no response being received
- /// (for an unlimited timeout, 0 value should be used).
+ /// Time (in milliseconds) that this function should wait for, before giving up due to no response being received
+ /// (for an unlimited timeout 0 value should be used).
/// </param>
- /// <returns>Transferred number of the transferred bytes.</returns>
+ /// <returns>Transferred Number of transferred bytes.</returns>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
- /// <exception cref="TimeoutException">Throws an exception if the transfer is timed out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
+ /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte requestType, byte request, ushort value, ushort index, byte[] data, ushort length, uint timeout)
{
_device.ThrowIfDisposed();
namespace Tizen.System.Usb
{
/// <summary>
- /// A class to manage the USB host devices. This class contains the operations for enumerating, opening, and closing devices.
+ /// Class to manage USB host devices. This class contains operations for enumerating, opening and closing devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDevice : IDisposable
{
internal readonly Interop.HostDeviceHandle _handle;
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int BusId {
get
{
}
/// <summary>
- /// Address of the device on the bus.
+ /// Address of device on the bus.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Address
{
get
}
/// <summary>
- /// List of the available port numbers from the device.
+ /// List of available port numbers from a device.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IEnumerable<int> Ports
{
get
}
/// <summary>
- /// Checks if the device is opened.
+ /// Checks if device is opened.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool IsOpened
{
get
}
/// <summary>
- /// Controls an endpoint (endpoint 0).
+ /// Control endpoint (endpoint 0).
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbControlEndpoint ControlEndpoint
{
get
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation. </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbConfiguration ActiveConfiguration
{
get
}
/// <summary>
- /// A dictionary for mapping the configuration IDs to configuration instances for this device.
+ /// Dictionary mapping configuration Ids to configuration instances for this device.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbConfiguration> Configurations
{
get
}
/// <summary>
- /// Device information such as version, class, subclass, etc.
+ /// Device information such as version, class, subclass etc.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDeviceInformation DeviceInformation
{
get
}
/// <summary>
- /// String associated with the device.
+ /// String associated with device.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDeviceStrings Strings
{
get
}
/// <summary>
- /// Opens the device, which allows performing operations on it.
+ /// Opens device, which allows performing operations on it.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Throws an exception in case of insufficient memory.</exception>
- /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
+ /// <exception cref="InvalidOperationException">Throws exception if device is disconnected.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <since_tizen> 5 </since_tizen>
public void Open()
{
ThrowIfDisposed();
}
/// <summary>
- /// Closes the device for operations.
+ /// Closes device for operations.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Close()
{
ThrowIfDisposed();
private bool disposedValue = false;
/// <summary>
- /// Releases all the resources used by the ConnectionProfile.
- /// It should be called after it has finished using the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// Releases all resources used by the ConnectionProfile.
+ /// It should be called after finished using of the object.</summary>
+ /// <since_tizen> 5 </since_tizen>
internal virtual void Dispose(bool disposing)
{
if (!disposedValue)
}
/// <summary>
- /// Releases all the resources used by the ConnectionProfile.
- /// It should be called after it has finished using the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// Releases all resources used by the ConnectionProfile.
+ /// It should be called after finished using of the object.</summary>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.System.Usb
{
/// <summary>
- /// Device information for the USB device.
+ /// Device information for USB device.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDeviceInformation
{
private readonly UsbDevice _device;
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int UsbVersion
{
get
}
/// <summary>
- /// Gets the device class.
+ /// Gets device class.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Class
{
get
}
/// <summary>
- /// Gets the device subclass.
+ /// Gets device sub class.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Subclass
{
get
}
/// <summary>
- /// Gets the device protocol.
+ /// Gets device protocol.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Protocol
{
get
}
/// <summary>
- /// Gets the vendor ID.
+ /// Gets vendor id.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int VendorId
{
get
}
/// <summary>
- /// Gets the product ID.
+ /// Gets product id.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int ProductId
{
get
}
/// <summary>
- /// Gets the device release number in binary-coded decimal.
+ /// Gets device release number in binary-coded decimal.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int DeviceVersion
{
get
namespace Tizen.System.Usb
{
/// <summary>
- /// String information for the USB device.
+ /// String information for USB device.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDeviceStrings
{
private readonly UsbDevice _device;
}
/// <summary>
- /// Gets the string describing the device manufacturer.
+ /// Gets string describing device manufacturer.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Manufacturer
{
get
}
/// <summary>
- /// Gets the product string of a device.
+ /// Gets product string of device
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Product
{
get
}
/// <summary>
- /// Gets the serial number of a device.
+ /// Gets serial number of a device.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Serial
{
get
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Endpoint class.
+ /// USB Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbEndpoint
{
internal readonly Interop.UsbEndpointHandle _handle;
}
/// <summary>
- /// Gets the number of this endpoint.
+ /// Gets number of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Id
{
get
}
/// <summary>
- /// Gets the direction of this endpoint.
+ /// Gets direction of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public EndpointDirection Direction
{
get
}
/// <summary>
- /// Gets the maximum packet size of a given endpoint.
+ /// Gets max packet size of given endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int MaxPacketSize
{
get
namespace Tizen.System.Usb
{
/// <summary>
- /// A class to manage the USB interfaces.
+ /// Class to manage USB Interfaces.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbInterface
{
internal readonly Interop.UsbInterfaceHandle _handle;
}
/// <summary>
- /// Gets the number of a given interface.
+ /// Gets number of given interface.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Id
{
get
}
/// <summary>
- /// Sets an alternative setting. Use the index of a new alternative setting for a given interface.
+ /// Sets alternative setting. Use index of new alternative setting for given interface.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int AlternateSetting
{
set
}
/// <summary>
- /// A dictionary for mapping the endpoint IDs to endpoint instances for a given interface.
+ /// Dictionary mapping endpoint Ids to endpoint instances for given interface.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbEndpoint> Endpoints
{
get
/// <summary>
- /// Gets the string describing an interface.
+ /// Gets string describing an interface.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
}
/// <summary>
- /// Claims the interface on a device. The interface must be claimed first to perform I/O operations.
+ /// Claims interface on a device. Interface must be claimed first to perform I/O operations.
/// </summary>
- /// <param name="force">Set to true to auto detach the kernel driver, false otherwise.</param>
+ /// <param name="force">Set to true to auto detach kernel driver, false otherwise.</param>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
- /// Throws an exception if device is disconnected or not opened for operation or another program or driver has claimed the interface.
+ /// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface.
/// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Claim(bool force)
{
ThrowIfDisposed();
/// <summary>
- /// Releases the previously claimed interface.
+ /// Releases previously claimed interface.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Release()
{
ThrowIfDisposed();
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Interrupt Endpoint class.
+ /// USB Interrupt Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbInterruptEndpoint : UsbEndpoint
{
internal UsbInterruptEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle)
}
/// <summary>
- /// Gets an interval for polling the endpoint for data transfers, in frame counts (refer to the USB protocol specification).
+ /// Gets interval for polling endpoint for data transfers, in frame counts (refer to USB protocol specification).
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int PollingInterval
{
get
}
/// <summary>
- /// Performs a USB transfer on a given endpoint. The direction of transfer is determined by the endpoint.
+ /// Performs a USB transfer on given endpoint. Direction of transfer is determined by the endpoint.
/// </summary>
- /// <param name="buffer">Suitably-sized data buffer for either an input or output (depending on the endpoint).</param>
+ /// <param name="buffer">Suitably-sized data buffer for either input or output (depending on endpoint).</param>
/// <param name="length">
- /// For writes, the number of bytes from the data to be sent. For reads, the maximum number of bytes to receive
+ /// For writes, the number of bytes from data to be sent, for reads the maximum number of bytes to receive
/// into the data buffer.
/// </param>
/// <param name="timeout">
- /// The time (in milliseconds) that this function should wait for, before giving up due to no response being
- /// received (for an unlimited timeout, 0 value should be used).
+ /// Time (in milliseconds) that this function should wait for before giving up due to no response being
+ /// received(for an unlimited timeout 0 value should be used).
/// </param>
/// <returns>Number of bytes actually transferred.</returns>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
return TransferImpl(buffer, length, timeout);
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Isochronous Endpoint class.
+ /// USB Isochronous Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbIsochronousEndpoint : UsbEndpoint
{
internal UsbIsochronousEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle)
}
/// <summary>
- /// Gets the synchronization type of this endpoint.
+ /// Gets synchronization type of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public SynchronizationType SynchronizationType
{
get
}
/// <summary>
- /// Gets the usage type of this endpoint.
+ /// Gets usage type of this endpoint.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsageType UsageType
{
get
namespace Tizen.System.Usb
{
/// <summary>
- /// The USB Manager class.
+ /// USB Manager class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbManager : IDisposable
{
// It needs to be static as its destroy function must be called after closing all devices and before application close.
}
/// <summary>
- /// The USB Manager constructor.
+ /// USB Manager Constructor.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbManager()
{
if (_context == null) throw new NotSupportedException("USB host operations are not supported in this device");
}
/// <summary>
- /// This function returns a list of USB devices attached to the system.
+ /// This function returns list of USB devices attached to system.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IEnumerable<UsbDevice> AvailableDevices
{
get
}
/// <summary>
- /// An event handler for events when the USB device is attached or detached.
+ /// Event handler for events when a USB device is attached or detached.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<HotPluggedEventArgs> DeviceHotPlugged;
internal void HostHotplugAttachCallback(IntPtr devHandle, IntPtr userData)
/// <summary>
/// Finalizes an instance of the USB Manager Class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
~UsbManager()
{
Dispose(false);
}
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);
using Tizen.Uix.InputMethod;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The EinaList Interop class.
+ /// EinaList Interop Class
/// </summary>
internal static class EinaList
{
using Tizen.Uix.InputMethod;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The InputMethod Interop class.
+ /// InputMethod Interop Class
/// </summary>
internal static class InputMethod
{
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Partial Libraries class.
+ /// Partial Libraries Class
/// </summary>
internal static partial class Libraries
{
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the AccessibilityStateChanged event.
+ /// This Class contains data related to AccessibilityStateChanged Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class AccessibilityStateChangedEventArgs
}
/// <summary>
- /// Accessibility option state.
+ /// Accessibility option state
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool State
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the CursorPositionUpdated event.
+ /// This Class contains data related to CursorPositionUpdated Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CursorPositionUpdatedEventArgs
}
/// <summary>
- /// The cursor position.
+ /// The cursor position
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int CursorPosition
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the DataSet event.
+ /// This Class contains data related to DataSet Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SetDataEventArgs
}
/// <summary>
- /// The specific data to be set to the input panel.
+ /// The specific data to be set to the input panel
/// </summary>
/// <since_tizen> 4 </since_tizen>
public byte[] Data
}
/// <summary>
- /// The length of data, in bytes, to be sent to the input panel.
+ /// The length of data, in bytes, to send to the input panel
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint DataLength
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the DisplayLanguageChanged event.
+ /// This Class contains data related to DisplayLanguageChanged Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DisplayLanguageChangedEventArgs
}
/// <summary>
- /// The language code.
+ /// The language code
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Language
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// The editor window class.
+ /// The Editor window class
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class EditorWindow : Window
}
/// <summary>
- /// This API creates a handle for the editor window.
+ /// This API creates handle for editor window.
/// </summary>
/// <since_tizen> 4 </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
}
/// <summary>
- /// This API gets a handle for the editor window.
+ /// This API gets handle for editor window.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IntPtr GetHandle()
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="portraitWidth">The width in the portrait mode.</param>
- /// <param name="portraitHeight">The height in the portrait mode.</param>
- /// <param name="landscapeWidth">The width in the landscape mode.</param>
- /// <param name="landscapeHeight">The height in the landscape mode.</param>
+ /// <param name="portraitWidth">The width in portrait mode</param>
+ /// <param name="portraitHeight">The height in portrait mode</param>
+ /// <param name="landscapeWidth">The width in landscape mode</param>
+ /// <param name="landscapeHeight">The height in landscape mode</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight)
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the FocusedIn event.
+ /// This Class contains data related to FocusedIn Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class FocusedInEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control.
+ /// The input context identification value of an associated text input UI control
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the FocusedOut event.
+ /// This Class contains data related to FocusedOut Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class FocusedOutEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control.
+ /// The input context identification value of an associated text input UI control
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for the input panel layout.
+ /// Enumeration for Input Panel Layout
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelLayout
{
/// <summary>
- /// Normal.
+ /// Normal
/// </summary>
LayoutNormal,
/// <summary>
- /// Number.
+ /// Number
/// </summary>
LayoutNumber,
/// <summary>
- /// Email.
+ /// Email
/// </summary>
LayoutEMail,
/// <summary>
- /// URL.
+ /// URL
/// </summary>
LayoutURL,
/// <summary>
- /// Phone Number.
+ /// Phone Number
/// </summary>
LayoutPhoneNumber,
/// <summary>
- /// IP.
+ /// IP
/// </summary>
LayoutIP,
/// <summary>
- /// Month.
+ /// Month
/// </summary>
LayoutMonth,
/// <summary>
- /// Number Only.
+ /// Number Only
/// </summary>
LayoutNumberOnly,
/// <summary>
- /// Invalid.
+ /// Invalid
/// </summary>
LayoutInvalid,
/// <summary>
- /// HEX.
+ /// HEX
/// </summary>
LayoutHEX,
/// <summary>
- /// Terminal.
+ /// Terminal
/// </summary>
LayoutTerminal,
/// <summary>
- /// Password.
+ /// Password
/// </summary>
LayoutPassword,
/// <summary>
- /// Date and time.
+ /// Date Time
/// </summary>
LayoutDateTime,
/// <summary>
- /// Emoticon.
+ /// Emoticon
/// </summary>
LayoutEmoticon,
/// <summary>
- /// Voice.
+ /// Voice
/// </summary>
LayoutVoice,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the layout variation.
+ /// Enumeration for Layout Variation
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LayoutVariation
{
/// <summary>
- /// The plain normal layout.
+ /// The plain normal layout
/// </summary>
NormalNormal = 0,
/// <summary>
- /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"', and ':' should be disabled.
+ /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"' and ':' should be disabled
/// </summary>
NormalFileName,
/// <summary>
- /// The name of a person.
+ /// The name of a person
/// </summary>
NormalPersonName,
/// <summary>
- /// The plain normal number layout.
+ /// The plain normal number layout
/// </summary>
NumberOnlyNormal = 0,
/// <summary>
- /// The number layout to allow a negative sign.
+ /// The number layout to allow a negative sign
/// </summary>
NumberOnlySigned,
/// <summary>
- /// The number layout to allow a decimal point to provide fractional value.
+ /// The number layout to allow decimal point to provide fractional value
/// </summary>
NumberOnlyDecimal,
/// <summary>
- /// The number layout to allow a decimal point and negative sign.
+ /// The number layout to allow decimal point and negative sign
/// </summary>
NumberOnlySignedAndDecimal,
/// <summary>
- /// The normal password layout.
+ /// The normal password layout
/// </summary>
PasswordNormal = 0,
/// <summary>
- /// The password layout to allow only a number.
+ /// The password layout to allow only number
/// </summary>
PasswordNumberOnly,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the AutoCapital types.
+ /// Enumeration for AutoCapital Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AutoCapitalization
{
/// <summary>
- /// None.
+ /// None
/// </summary>
None,
/// <summary>
- /// Word.
+ /// Word
/// </summary>
Word,
/// <summary>
- /// Sentence.
+ /// Sentence
/// </summary>
Sentence,
/// <summary>
- /// All characters.
+ /// All Character
/// </summary>
AllCharacter,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the InputPanel ReturnKey types.
+ /// Enumeration for InputPanel ReturnKey Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelReturnKey
{
/// <summary>
- /// Default.
+ /// Default
/// </summary>
Default,
/// <summary>
- /// Done.
+ /// Done
/// </summary>
Done,
/// <summary>
- /// Go.
+ /// Go
/// </summary>
Go,
/// <summary>
- /// Join.
+ /// Join
/// </summary>
Join,
/// <summary>
- /// Login.
+ /// Login
/// </summary>
Login,
/// <summary>
- /// Next.
+ /// Next
/// </summary>
Next,
/// <summary>
- /// Search.
+ /// Search
/// </summary>
Search,
/// <summary>
- /// Send.
+ /// Send
/// </summary>
Send,
/// <summary>
- /// SignIn.
+ /// SignIn
/// </summary>
SignIn,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the InputHints.
+ /// Enumeration for InputHints
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputHints
{
/// <summary>
- /// None.
+ /// None
/// </summary>
None,
/// <summary>
- /// AutoComplete.
+ /// AutoComplete
/// </summary>
AutoComplete,
/// <summary>
- /// SensitiveData.
+ /// SensitiveData
/// </summary>
SensitiveData,
/// <summary>
- /// Multiline.
+ /// Multiline
/// </summary>
Multiline,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the BiDirection.
+ /// Enumeration for BiDi Direction
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum BiDirection
{
/// <summary>
- /// Neutral.
+ /// Neutral
/// </summary>
Neutral,
/// <summary>
- /// LTR.
+ /// LTR
/// </summary>
LTR,
/// <summary>
- /// RTL.
+ /// RTL
/// </summary>
RTL,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the InputPanel language.
+ /// Enumeration for InputPanel Language
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelLanguage
{
/// <summary>
- /// Automatic.
+ /// Automatic
/// </summary>
Automatic,
/// <summary>
- /// Alphabet.
+ /// Alphabet
/// </summary>
Alphabet,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// This class represents the context of the InputMethodEditor.
+ /// This class represents the context of InputMethodEditor
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class InputMethodContext
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for the device class.
+ /// Enumeration for Device Class
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DeviceClass
{
/// <summary>
- /// None.
+ /// None
/// </summary>
None,
/// <summary>
- /// Seat.
+ /// Seat
/// </summary>
Seat,
/// <summary>
- /// Keyboard.
+ /// Keyboard
/// </summary>
Keyboard,
/// <summary>
- /// Mouse.
+ /// Mouse
/// </summary>
Mouse,
/// <summary>
- /// Touch.
+ /// Touch
/// </summary>
Touch,
/// <summary>
- /// Pen.
+ /// Pen
/// </summary>
Pen,
/// <summary>
- /// Pointer.
+ /// Pointer
/// </summary>
Pointer,
/// <summary>
- /// Gamepad.
+ /// Gamepad
/// </summary>
Gamepad,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for the device subclass.
+ /// Enumeration for Device SubClass
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DeviceSubclass
{
/// <summary>
- /// None.
+ /// None
/// </summary>
None,
/// <summary>
- /// Finger.
+ /// Finger
/// </summary>
Finger,
/// <summary>
- /// FingerNail.
+ /// FingerNail
/// </summary>
FingerNail,
/// <summary>
- /// Knuckle.
+ /// Knuckle
/// </summary>
Knuckle,
/// <summary>
- /// Palm.
+ /// Palm
/// </summary>
Palm,
/// <summary>
- /// HandSize.
+ /// HandSize
/// </summary>
HandSize,
/// <summary>
- /// HandFlat.
+ /// HandFlat
/// </summary>
HandFlat,
/// <summary>
- /// PenTip.
+ /// PenTip
/// </summary>
PenTip,
/// <summary>
- /// Trackpad.
+ /// Trackpad
/// </summary>
Trackpad,
/// <summary>
- /// Trackpoint.
+ /// Trackpoint
/// </summary>
Trackpoint,
/// <summary>
- /// Trackball.
+ /// Trackball
/// </summary>
Trackball,
/// <summary>
- /// Undefined.
+ /// Undefined
/// </summary>
Undefined
};
/// <summary>
- /// This class gives the device information, like the name, class, and subclass.
+ /// this class gives the device information, like the name, class and subclass
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class InputMethodDeviceInformation
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for the key codes.
- /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded to 24-bit UCS character. The UCS value is keycode & 0x00ffffff.
- /// Defines the list of keys supported by the system. Note that certain keys may not be available on all the devices.
+ /// Enumeration of the key codes.
+ /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.The UCS value is keycode & 0x00ffffff.
+ /// Defines the list of keys supported by the system.Note that certain keys may not be available on all devices.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum KeyCode
{
/// <summary>
- /// The Backspace key.
+ /// The backspace key
/// </summary>
BackSpace = 0xFF08,
/// <summary>
- /// The Tab key.
+ /// The tab key
/// </summary>
Tab = 0xFF09,
/// <summary>
- /// The Linefeed key.
+ /// The linefeed key
/// </summary>
Linefeed = 0xFF0A,
/// <summary>
- /// The Clear key.
+ /// The clear key
/// </summary>
Clear = 0xFF0B,
/// <summary>
- /// The Return key.
+ /// The return key
/// </summary>
Return = 0xFF0D,
/// <summary>
- /// The Pause key.
+ /// The pause key
/// </summary>
Pause = 0xFF13,
/// <summary>
- /// The Scroll lock key.
+ /// The scroll lock key
/// </summary>
ScrollLock = 0xFF14,
/// <summary>
- /// The System Request key.
+ /// The sys req key
/// </summary>
SysReq = 0xFF15,
/// <summary>
- /// The Escape key.
+ /// The escape key
/// </summary>
Escape = 0xFF1B,
/// <summary>
- /// The Delete key.
+ /// The delete key
/// </summary>
Delete = 0xFFFF,
/* Cursor control & motion */
/// <summary>
- /// The Home key.
+ /// The home key
/// </summary>
Home = 0xFF50,
/// <summary>
- /// The Left directional key.
+ /// The left directional key
/// </summary>
Left = 0xFF51,
/// <summary>
- /// The Up directional key.
+ /// The up directional key
/// </summary>
Up = 0xFF52,
/// <summary>
- /// The Right directional key.
+ /// The right directional key
/// </summary>
Right = 0xFF53,
/// <summary>
- /// The Down directional key.
+ /// The down directional key
/// </summary>
Down = 0xFF54,
/// <summary>
- /// The Prior, Previous key.
+ /// The prior, previous key
/// </summary>
Prior = 0xFF55,
/// <summary>
- /// The Page Up key.
+ /// The page up key
/// </summary>
Page_Up = 0xFF55,
/// <summary>
- /// The Next key.
+ /// The next key
/// </summary>
Next = 0xFF56,
/// <summary>
- /// The Page Down key.
+ /// The page down key
/// </summary>
Page_Down = 0xFF56,
/// <summary>
- /// The End key.
+ /// The end key
/// </summary>
End = 0xFF57,
/// <summary>
- /// The Begin key.
+ /// The begin key
/// </summary>
Begin = 0xFF58,
/* Misc Functions */
/// <summary>
- /// The Select key.
+ /// The select key
/// </summary>
Select = 0xFF60,
/// <summary>
- /// The Print key.
+ /// The print key
/// </summary>
Print = 0xFF61,
/// <summary>
- /// The Execute, Run, Do key.
+ /// The execute, run, do key
/// </summary>
Execute = 0xFF62,
/// <summary>
- /// The Insert key.
+ /// The insert key
/// </summary>
Insert = 0xFF63,
/// <summary>
- /// The Undo key.
+ /// The undo key
/// </summary>
Undo = 0xFF65,
/// <summary>
- /// The Redo key.
+ /// The redo key
/// </summary>
Redo = 0xFF66,
/// <summary>
- /// The Menu key.
+ /// The menu key
/// </summary>
Menu = 0xFF67,
/// <summary>
- /// The Find key.
+ /// The find key
/// </summary>
Find = 0xFF68,
/// <summary>
- /// The Cancel, Stop, Abort, Exit key.
+ /// The cancel, stop, abort, exit key
/// </summary>
Cancel = 0xFF69,
/// <summary>
- /// The Help key.
+ /// The help key
/// </summary>
Help = 0xFF6A,
/// <summary>
- /// The Break key.
+ /// The break key
/// </summary>
Break = 0xFF6B,
/// <summary>
- /// The character set switch key.
+ /// The character set switch key
/// </summary>
Mode_switch = 0xFF7E,
/// <summary>
- /// The Number Lock key.
+ /// The num lock key
/// </summary>
Num_Lock = 0xFF7F,
/* Keypad */
/// <summary>
- /// The Numpad Space key.
+ /// The Numpad space key
/// </summary>
KPSpace = 0xFF80,
/// <summary>
- /// The Numpad Tab key.
+ /// The Numpad tab key
/// </summary>
KPTab = 0xFF89,
/// <summary>
- /// The Numpad Enter key.
+ /// The Numpad enter key
/// </summary>
KPEnter = 0xFF8D,
/// <summary>
- /// The Numpad Function 1 key.
+ /// The Numpad function 1 key
/// </summary>
KPF1 = 0xFF91,
/// <summary>
- /// The Numpad Function 2 key.
+ /// The Numpad function 2 key
/// </summary>
KPF2 = 0xFF92,
/// <summary>
- /// The Numpad Function 3 key.
+ /// The Numpad function 3 key
/// </summary>
KPF3 = 0xFF93,
/// <summary>
- /// The Numpad Function 4 key.
+ /// The Numpad function 4 key
/// </summary>
KPF4 = 0xFF94,
/// <summary>
- /// The Numpad Home key.
+ /// The Numpad home key
/// </summary>
KPHome = 0xFF95,
/// <summary>
- /// The Numpad Left key.
+ /// The Numpad left key
/// </summary>
KPLeft = 0xFF96,
/// <summary>
- /// The Numpad Up key.
+ /// The Numpad up key
/// </summary>
KPUp = 0xFF97,
/// <summary>
- /// The Numpad Right key.
+ /// The Numpad right key
/// </summary>
KPRight = 0xFF98,
/// <summary>
- /// The Numpad Down key.
+ /// The Numpad down key
/// </summary>
KPDown = 0xFF99,
/// <summary>
- /// The Numpad Prior, Previous key.
+ /// The Numpad prior, previous key
/// </summary>
KPPrior = 0xFF9A,
/// <summary>
- /// The Numpad Page Up key.
+ /// The Numpad page up key
/// </summary>
KPPage_Up = 0xFF9A,
/// <summary>
- /// The Numpad Next key.
+ /// The Numpad next key
/// </summary>
KPNext = 0xFF9B,
/// <summary>
- /// The Numpad Page Down key.
+ /// The Numpad page down key
/// </summary>
KPPage_Down = 0xFF9B,
/// <summary>
- /// The Numpad End key.
+ /// The Numpad end key
/// </summary>
KPEnd = 0xFF9C,
/// <summary>
- /// The Numpad Begin key.
+ /// The Numpad begin key
/// </summary>
KPBegin = 0xFF9D,
/// <summary>
- /// The Numpad Insert key.
+ /// The Numpad insert key
/// </summary>
KPInsert = 0xFF9E,
/// <summary>
- /// The Numpad Delete key.
+ /// The Numpad delete key
/// </summary>
KPDelete = 0xFF9F,
/// <summary>
- /// The Numpad Equal key.
+ /// The Numpad equal key
/// </summary>
KPEqual = 0xFFBD,
/// <summary>
- /// The Numpad Multiply key.
+ /// The Numpad multiply key
/// </summary>
KPMultiply = 0xFFAA,
/// <summary>
- /// The Numpad Add key.
+ /// The Numpad add key
/// </summary>
KPAdd = 0xFFAB,
/// <summary>
- /// The Numpad Separator key.
+ /// The Numpad separator key
/// </summary>
KPSeparator = 0xFFAC,
/// <summary>
- /// The Numpad Subtract key.
+ /// The Numpad subtract key
/// </summary>
KPSubtract = 0xFFAD,
/// <summary>
- /// The Numpad Decimal key.
+ /// The Numpad decimal key
/// </summary>
KPDecimal = 0xFFAE,
/// <summary>
- /// The Numpad Divide key.
+ /// The Numpad divide key
/// </summary>
KPDivide = 0xFFAF,
/// <summary>
- /// The Numpad 0 key.
+ /// The Numpad 0 key
/// </summary>
KP0 = 0xFFB0,
/// <summary>
- /// The Numpad 1 key.
+ /// The Numpad 1 key
/// </summary>
KP1 = 0xFFB1,
/// <summary>
- /// The Numpad 2 key.
+ /// The Numpad 2 key
/// </summary>
KP2 = 0xFFB2,
/// <summary>
- /// The Numpad 3 key.
+ /// The Numpad 3 key
/// </summary>
KP3 = 0xFFB3,
/// <summary>
- /// The Numpad 4 key.
+ /// The Numpad 4 key
/// </summary>
KP4 = 0xFFB4,
/// <summary>
- /// The Numpad 5 key.
+ /// The Numpad 5 key
/// </summary>
KP5 = 0xFFB5,
/// <summary>
- /// The Numpad 6 key.
+ /// The Numpad 6 key
/// </summary>
KP6 = 0xFFB6,
/// <summary>
- /// The Numpad 7 key.
+ /// The Numpad 7 key
/// </summary>
KP7 = 0xFFB7,
/// <summary>
- /// The Numpad 8 key.
+ /// The Numpad 8 key
/// </summary>
KP8 = 0xFFB8,
/// <summary>
- /// The Numpad 9 key.
+ /// The Numpad 9 key
/// </summary>
KP9 = 0xFFB9,
/* Auxiliary Functions */
/// <summary>
- /// The Function 1 key.
+ /// The function 1 key
/// </summary>
F1 = 0xFFBE,
/// <summary>
- /// The Function 2 key.
+ /// The function 2 key
/// </summary>
F2 = 0xFFBF,
/// <summary>
- /// The Function 3 key.
+ /// The function 3 key
/// </summary>
F3 = 0xFFC0,
/// <summary>
- /// The Function 4 key.
+ /// The function 4 key
/// </summary>
F4 = 0xFFC1,
/// <summary>
- /// The Function 5 key.
+ /// The function 5 key
/// </summary>
F5 = 0xFFC2,
/// <summary>
- /// The Function 6 key.
+ /// The function 6 key
/// </summary>
F6 = 0xFFC3,
/// <summary>
- /// The Function 7 key.
+ /// The function 7 key
/// </summary>
F7 = 0xFFC4,
/// <summary>
- /// The Function 8 key.
+ /// The function 8 key
/// </summary>
F8 = 0xFFC5,
/// <summary>
- /// The Function 9 key.
+ /// The function 9 key
/// </summary>
F9 = 0xFFC6,
/// <summary>
- /// The Function 10 key.
+ /// The function 10 key
/// </summary>
F10 = 0xFFC7,
/// <summary>
- /// The Function 11 key.
+ /// The function 11 key
/// </summary>
F11 = 0xFFC8,
/// <summary>
- /// The Function 12 key.
+ /// The function 12 key
/// </summary>
F12 = 0xFFC9,
/// <summary>
- /// The Function 13 key.
+ /// The function 13 key
/// </summary>
F13 = 0xFFCA,
/// <summary>
- /// The Function 14 key.
+ /// The function 14 key
/// </summary>
F14 = 0xFFCB,
/// <summary>
- /// The Function 15 key.
+ /// The function 15 key
/// </summary>
F15 = 0xFFCC,
/// <summary>
- /// The Function 16 key.
+ /// The function 16 key
/// </summary>
F16 = 0xFFCD,
/// <summary>
- /// The Function 17 key.
+ /// The function 17 key
/// </summary>
F17 = 0xFFCE,
/// <summary>
- /// The Function 18 key.
+ /// The function 18 key
/// </summary>
F18 = 0xFFCF,
/// <summary>
- /// The Function 19 key.
+ /// The function 19 key
/// </summary>
F19 = 0xFFD0,
/// <summary>
- /// The Function 20 key.
+ /// The function 20 key
/// </summary>
F20 = 0xFFD1,
/// <summary>
- /// The Function 21 key.
+ /// The function 21 key
/// </summary>
F21 = 0xFFD2,
/// <summary>
- /// The Function 22 key.
+ /// The function 22 key
/// </summary>
F22 = 0xFFD3,
/// <summary>
- /// The Function 23 key.
+ /// The function 23 key
/// </summary>
F23 = 0xFFD4,
/// <summary>
- /// The Function 24 key.
+ /// The function 24 key
/// </summary>
F24 = 0xFFD5,
/// <summary>
- /// The Function 25 key.
+ /// The function 25 key
/// </summary>
F25 = 0xFFD6,
/// <summary>
- /// The Function 26 key.
+ /// The function 26 key
/// </summary>
F26 = 0xFFD7,
/// <summary>
- /// The Function 27 key.
+ /// The function 27 key
/// </summary>
F27 = 0xFFD8,
/// <summary>
- /// The Function 28 key.
+ /// The function 28 key
/// </summary>
F28 = 0xFFD9,
/// <summary>
- /// The Function 29 key.
+ /// The function 29 key
/// </summary>
F29 = 0xFFDA,
/// <summary>
- /// The Function 30 key.
+ /// The function 30 key
/// </summary>
F30 = 0xFFDB,
/// <summary>
- /// The Function 31 key.
+ /// The function 31 key
/// </summary>
F31 = 0xFFDC,
/// <summary>
- /// The Function 32 key.
+ /// The function 32 key
/// </summary>
F32 = 0xFFDD,
/// <summary>
- /// The Function 33 key.
+ /// The function 33 key
/// </summary>
F33 = 0xFFDE,
/// <summary>
- /// The Function 34 key.
+ /// The function 34 key
/// </summary>
F34 = 0xFFDF,
/// <summary>
- /// The Function 35 key.
+ /// The function 35 key
/// </summary>
F35 = 0xFFE0,
/* Modifier keys */
/// <summary>
- /// The Left Shift key.
+ /// The left shift key
/// </summary>
ShiftL = 0xFFE1,
/// <summary>
- /// The Right Shift key.
+ /// The right shift key
/// </summary>
ShiftR = 0xFFE2,
/// <summary>
- /// The Left Control key.
+ /// The left control key
/// </summary>
ControlL = 0xFFE3,
/// <summary>
- /// The Right Control key.
+ /// The right control key
/// </summary>
ControlR = 0xFFE4,
/// <summary>
- /// The Caps Lock key.
+ /// The caps lock key
/// </summary>
CapsLock = 0xFFE5,
/// <summary>
- /// The Shift Lock key.
+ /// The shift lock key
/// </summary>
ShiftLock = 0xFFE6,
/// <summary>
- /// The Left Meta key.
+ /// The left meta key
/// </summary>
MetaL = 0xFFE7,
/// <summary>
- /// The Right Meta key.
+ /// The right meta key
/// </summary>
MetaR = 0xFFE8,
/// <summary>
- /// The Left Alt key.
+ /// The left alt key
/// </summary>
AltL = 0xFFE9,
/// <summary>
- /// The Right Alt key.
+ /// The right alt key
/// </summary>
AltR = 0xFFEA,
/// <summary>
- /// The Left Super key.
+ /// The left super key
/// </summary>
SuperL = 0xFFEB,
/// <summary>
- /// The Right Super key.
+ /// The right super key
/// </summary>
SuperR = 0xFFEC,
/// <summary>
- /// The Left Hyper key.
+ /// The left hyper key
/// </summary>
HyperL = 0xFFED,
/// <summary>
- /// The Right Hyper key.
+ /// The right hyper key
/// </summary>
HyperR = 0xFFEE,
/* Latin 1 */
/// <summary>
- /// The Space key.
+ /// The space key
/// </summary>
Space = 0x020,
/// <summary>
- /// The Exclamation key.
+ /// The exclamation key
/// </summary>
Exclam = 0x021,
/// <summary>
- /// The Quotedbl key.
+ /// The quotedbl key
/// </summary>
Quotedbl = 0x022,
/// <summary>
- /// The Number Sign key.
+ /// The number sign key
/// </summary>
NumberSign = 0x023,
/// <summary>
- /// The Dollar key.
+ /// The dollar key
/// </summary>
Dollar = 0x024,
/// <summary>
- /// The Percent key.
+ /// The percent key
/// </summary>
Percent = 0x025,
/// <summary>
- /// The Ampersand key.
+ /// The ampersand key
/// </summary>
Ampersand = 0x026,
/// <summary>
- /// The Apostrophe key.
+ /// The apostrophe key
/// </summary>
Apostrophe = 0x027,
/// <summary>
- /// The Parenleft key.
+ /// The parenleft key
/// </summary>
Parenleft = 0x028,
/// <summary>
- /// The Parenright key.
+ /// The parenright key
/// </summary>
Parenright = 0x029,
/// <summary>
- /// The Asterisk key.
+ /// The asterisk key
/// </summary>
Asterisk = 0x02a,
/// <summary>
- /// The Plus key.
+ /// The plus key
/// </summary>
Plus = 0x02b,
/// <summary>
- /// The Comma key.
+ /// The comma key
/// </summary>
Comma = 0x02c,
/// <summary>
- /// The Minus key.
+ /// The minus key
/// </summary>
Minus = 0x02d,
/// <summary>
- /// The Period key.
+ /// The period key
/// </summary>
Period = 0x02e,
/// <summary>
- /// The Slash key.
+ /// The slash key
/// </summary>
Slash = 0x02f,
/// <summary>
- /// The 0 key.
+ /// The 0 key
/// </summary>
Keypad0 = 0x030,
/// <summary>
- /// The 1 key.
+ /// The 1 key
/// </summary>
Keypad1 = 0x031,
/// <summary>
- /// The 2 key.
+ /// The 2 key
/// </summary>
Keypad2 = 0x032,
/// <summary>
- /// The 3 key.
+ /// The 3 key
/// </summary>
Keypad3 = 0x033,
/// <summary>
- /// The 4 key.
+ /// The 4 key
/// </summary>
Keypad4 = 0x034,
/// <summary>
- /// The 5 key.
+ /// The 5 key
/// </summary>
Keypad5 = 0x035,
/// <summary>
- /// The 6 key.
+ /// The 6 key
/// </summary>
Keypad6 = 0x036,
/// <summary>
- /// The 7 key.
+ /// The 7 key
/// </summary>
Keypad7 = 0x037,
/// <summary>
- /// The 8 key.
+ /// The 8 key
/// </summary>
Keypad8 = 0x038,
/// <summary>
- /// The 9 key.
+ /// The 9 key
/// </summary>
Keypad9 = 0x039,
/// <summary>
- /// The Colon key.
+ /// The colon key
/// </summary>
Colon = 0x03a,
/// <summary>
- /// The Semicolon key.
+ /// The semicolon key
/// </summary>
Semicolon = 0x03b,
/// <summary>
- /// The Less key.
+ /// The less key
/// </summary>
Less = 0x03c,
/// <summary>
- /// The Equal key.
+ /// The equal key
/// </summary>
Equal = 0x03d,
/// <summary>
- /// The Greater key.
+ /// The greater key
/// </summary>
Greater = 0x03e,
/// <summary>
- /// The Question key.
+ /// The question key
/// </summary>
Question = 0x03f,
/// <summary>
- /// The At key.
+ /// The at key
/// </summary>
At = 0x040,
/// <summary>
- /// The A key.
+ /// The A key
/// </summary>
KeypadA = 0x041,
/// <summary>
- /// The B key.
+ /// The B key
/// </summary>
KeypadB = 0x042,
/// <summary>
- /// The C key.
+ /// The C key
/// </summary>
KeypadC = 0x043,
/// <summary>
- /// The D key.
+ /// The D key
/// </summary>
KeypadD = 0x044,
/// <summary>
- /// The E key.
+ /// The E key
/// </summary>
KeypadE = 0x045,
/// <summary>
- /// The F key.
+ /// The F key
/// </summary>
KeypadF = 0x046,
/// <summary>
- /// The G key.
+ /// The G key
/// </summary>
KeypadG = 0x047,
/// <summary>
- /// The H key.
+ /// The H key
/// </summary>
KeypadH = 0x048,
/// <summary>
- /// The I key.
+ /// The I key
/// </summary>
KeypadI = 0x049,
/// <summary>
- /// The J key.
+ /// The J key
/// </summary>
KeypadJ = 0x04a,
/// <summary>
- /// The K key.
+ /// The K key
/// </summary>
KeypadK = 0x04b,
/// <summary>
- /// The L key.
+ /// The L key
/// </summary>
KeypadL = 0x04c,
/// <summary>
- /// The M key.
+ /// The M key
/// </summary>
KeypadM = 0x04d,
/// <summary>
- /// The N key.
+ /// The N key
/// </summary>
KeypadN = 0x04e,
/// <summary>
- /// The O key.
+ /// The O key
/// </summary>
KeypadO = 0x04f,
/// <summary>
- /// The P key.
+ /// The P key
/// </summary>
KeypadP = 0x050,
/// <summary>
- /// The Q key.
+ /// The Q key
/// </summary>
KeypadQ = 0x051,
/// <summary>
- /// The R key.
+ /// The R key
/// </summary>
KeypadR = 0x052,
/// <summary>
- /// The S key.
+ /// The S key
/// </summary>
KeypadS = 0x053,
/// <summary>
- /// The T key.
+ /// The T key
/// </summary>
KeypadT = 0x054,
/// <summary>
- /// The U key.
+ /// The U key
/// </summary>
KeypadU = 0x055,
/// <summary>
- /// The V key.
+ /// The V key
/// </summary>
KeypadV = 0x056,
/// <summary>
- /// The W key.
+ /// The W key
/// </summary>
KeypadW = 0x057,
/// <summary>
- /// The X key.
+ /// The X key
/// </summary>
KeypadX = 0x058,
/// <summary>
- /// The Y key.
+ /// The Y key
/// </summary>
KeypadY = 0x059,
/// <summary>
- /// The Z key.
+ /// The Z key
/// </summary>
KeypadZ = 0x05a,
/// <summary>
- /// The Left Bracket key.
+ /// The left bracket key
/// </summary>
BracketLeft = 0x05b,
/// <summary>
- /// The Backslash key.
+ /// The backslash key
/// </summary>
Backslash = 0x05c,
/// <summary>
- /// The Right Bracket key.
+ /// The right bracket key
/// </summary>
BracketRight = 0x05d,
/// <summary>
- /// The Circumflex key.
+ /// The circumflex key
/// </summary>
AsciiCircum = 0x05e,
/// <summary>
- /// The Underscore key.
+ /// The underscore key
/// </summary>
Underscore = 0x05f,
/// <summary>
- /// The Grave key.
+ /// The grave key
/// </summary>
Grave = 0x060,
/// <summary>
- /// The a key.
+ /// The a key
/// </summary>
Keypada = 0x061,
/// <summary>
- /// The b key.
+ /// The b key
/// </summary>
Keypadb = 0x062,
/// <summary>
- /// The c key.
+ /// The c key
/// </summary>
Keypadc = 0x063,
/// <summary>
- /// The d key.
+ /// The d key
/// </summary>
Keypadd = 0x064,
/// <summary>
- /// The e key.
+ /// The e key
/// </summary>
Keypade = 0x065,
/// <summary>
- /// The f key.
+ /// The f key
/// </summary>
Keypadf = 0x066,
/// <summary>
- /// The g key.
+ /// The g key
/// </summary>
Keypadg = 0x067,
/// <summary>
- /// The h key.
+ /// The h key
/// </summary>
Keypadh = 0x068,
/// <summary>
- /// The i key.
+ /// The i key
/// </summary>
Keypadi = 0x069,
/// <summary>
- /// The j key.
+ /// The j key
/// </summary>
Keypadj = 0x06a,
/// <summary>
- /// The k key.
+ /// The k key
/// </summary>
Keypadk = 0x06b,
/// <summary>
- /// The l key.
+ /// The l key
/// </summary>
Keypadl = 0x06c,
/// <summary>
- /// The m key.
+ /// The m key
/// </summary>
Keypadm = 0x06d,
/// <summary>
- /// The n key.
+ /// The n key
/// </summary>
Keypadn = 0x06e,
/// <summary>
- /// The o key.
+ /// The o key
/// </summary>
Keypado = 0x06f,
/// <summary>
- /// The p key.
+ /// The p key
/// </summary>
Keypadp = 0x070,
/// <summary>
- /// The q key.
+ /// The q key
/// </summary>
Keypadq = 0x071,
/// <summary>
- /// The r key.
+ /// The r key
/// </summary>
Keypadr = 0x072,
/// <summary>
- /// The s key.
+ /// The s key
/// </summary>
Keypads = 0x073,
/// <summary>
- /// The t key.
+ /// The t key
/// </summary>
Keypadt = 0x074,
/// <summary>
- /// The u key.
+ /// The u key
/// </summary>
Keypadu = 0x075,
/// <summary>
- /// The v key.
+ /// The v key
/// </summary>
Keypadv = 0x076,
/// <summary>
- /// The w key.
+ /// The w key
/// </summary>
Keypadw = 0x077,
/// <summary>
- /// The x key.
+ /// The x key
/// </summary>
Keypadx = 0x078,
/// <summary>
- /// The y key.
+ /// The y key
/// </summary>
Keypady = 0x079,
/// <summary>
- /// The z key.
+ /// The z key
/// </summary>
Keypadz = 0x07a,
/// <summary>
- /// The Left Brace key.
+ /// The left brace key
/// </summary>
BraceLeft = 0x07b,
/// <summary>
- /// The Bar key.
+ /// The bar key
/// </summary>
Bar = 0x07c,
/// <summary>
- /// The Right Brace key.
+ /// The right brace key
/// </summary>
BraceRight = 0x07d,
/// <summary>
- /// The Tilde key.
+ /// The tilde key
/// </summary>
AsciiTilde = 0x07e,
};
/// <summary>
- /// Enumeration for the key masks.
- /// The key masks indicate which modifier keys are pressed down during the keyboard hit. The special MASK_RELEASED indicates the key release event.
+ /// Enumeration of the key masks.
+ /// The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum KeyMask
{
/// <summary>
- /// Key press event without the modifier key.
+ /// Key press event without modifier key
/// </summary>
Pressed = 0,
/// <summary>
- /// The Shift key is pressed down.
+ /// The Shift key is pressed down
/// </summary>
Shift = (1 << 0),
/// <summary>
- /// The CapsLock key is pressed down.
+ /// The CapsLock key is pressed down
/// </summary>
CapsLock = (1 << 1),
/// <summary>
- /// The Control key is pressed down.
+ /// The Control key is pressed down
/// </summary>
Control = (1 << 2),
/// <summary>
- /// The Alt key is pressed down.
+ /// The Alt key is pressed down
/// </summary>
Alt = (1 << 3),
/// <summary>
- /// The Meta key is pressed down.
+ /// The Meta key is pressed down
/// </summary>
Meta = (1 << 4),
/// <summary>
- /// The Win key (between Control and Alt) is pressed down.
+ /// The Win (between Control and Alt) is pressed down
/// </summary>
Win = (1 << 5),
/// <summary>
- /// The Hyper key is pressed down.
+ /// The Hyper key is pressed down
/// </summary>
Hyper = (1 << 6),
/// <summary>
- /// The NumLock key is pressed down.
+ /// The NumLock key is pressed down
/// </summary>
NumLock = (1 << 7),
/// <summary>
- /// Key release event.
+ /// Key release event
/// </summary>
Released = (1 << 15),
}
/// <summary>
- /// This class contains the API's related to the IME (Input method editor).
+ /// This class contains api's related to IME(Input method editor)
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class InputMethodEditor
};
/// <summary>
- /// Structure representing the ContextId.
+ /// Structure representing ContextId
/// </summary>
/// <since_tizen> 4 </since_tizen>
public struct ContextId : IEquatable<ContextId>
}
/// <summary>
- /// Compares whether the ContextIds are equal.
+ /// compare whether ContextId are equal
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool Equals(ContextId other)
}
/// <summary>
- /// Rectangle representing the position and size of the UI control.
+ /// rectangle representing the position and size of UI Control
/// </summary>
/// <since_tizen> 4 </since_tizen>
public struct Rect
{
/// <summary>
- /// The X position in the screen.
+ /// The x position in screen
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int x;
/// <summary>
- /// The Y position in the screen.
+ /// The y position in screen
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int y;
/// <summary>
- /// The window width.
+ /// The window width
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int w;
/// <summary>
- /// The window height.
+ /// The window height
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int h;
}
/// <summary>
- /// An action with 1 out parameter.
+ /// An Action with 1 out parameter
/// </summary>
- /// <typeparam name="T">Generic Type.</typeparam>
- /// <param name="a">The out parameter.</param>
+ /// <typeparam name="T">Generic Type</typeparam>
+ /// <param name="a">The out parameter</param>
/// <since_tizen> 4 </since_tizen>
public delegate void OutAction<T>(out T a);
/// <summary>
- /// An action with an array out parameter.
+ /// An Action with an array out parameter
/// </summary>
- /// <typeparam name="T">Generic Type.</typeparam>
- /// <param name="a">The out parameter 1.</param>
+ /// <typeparam name="T">Generic Type</typeparam>
+ /// <param name="a">The out parameter 1</param>
/// <since_tizen> 4 </since_tizen>
public delegate void OutArrayAction<T>(out T[] a);
/// <summary>
- /// An action with 3 input parameters returning a bool.
+ /// An Action with 3 Input Parameter returning a bool
/// </summary>
- /// <typeparam name="T">Generic type for parameter 1.</typeparam>
- /// <typeparam name="T1">Generic type for parameter 2.</typeparam>
- /// <typeparam name="T2">Generic type for parameter 3.</typeparam>
- /// <param name="a">The input parameter 1.</param>
- /// <param name="b">The input parameter 2.</param>
- /// <param name="c">The input parameter 3.</param>
+ /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
+ /// <typeparam name="T1">Generic Type for Parameter 2</typeparam>
+ /// <typeparam name="T2">Generic Type for Parameter 3</typeparam>
+ /// <param name="a">The Input Parameter 1</param>
+ /// <param name="b">The Input Parameter 2</param>
+ /// <param name="c">The Input Parameter 3</param>
/// <returns></returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool BoolAction<T, T1, T2>(T a, T1 b, T2 c);
/// <summary>
/// Called to set the preferred language to the input panel.
- /// It will only be called when the client application changes the edit field's language attribute after the input panel is shown.
+ /// It will be only called when the client application changes the edit field's language attribute after the input panel is shown.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<LanguageSetEventArgs> LanguageSet
/// <summary>
/// Called when an associated text input UI control requests the input panel to set its layout.
- /// It will only be called when the client application changes the edit field's layout attribute after the input panel is shown.
+ /// It will be only called when the client application changes the edit field's layout attribute after the input panel is shown.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<LayoutSetEventArgs> LayoutSet
/// <summary>
/// Called when an associated text input UI control requests the input panel to set the Return key label.
- /// The input panel can show the text or an image on the Return button, according to the Return key action.
+ /// The input panel can show text or image on the Return button according to the Return key action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<ReturnKeySetEventArgs> ReturnKeySet
}
/// <summary>
- /// Called when the system display language is changed.
+ /// Called when the system display Language is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<DisplayLanguageChangedEventArgs> DisplayLanguageChanged
}
/// <summary>
- /// Called when Accessibility in settings application is on or off.
+ /// Called when Accessibility in Settings application is on or off.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<AccessibilityStateChangedEventArgs> AccessibilityStateChanged
}
/// <summary>
- /// Sets the languageRequested action.
+ /// Sets the languageRequested Action
/// </summary>
/// <param name="languageRequested">
/// Called when an associated text input UI control requests the language from the input panel, requesting for language code.
}
/// <summary>
- /// Sets the processKey action.
- /// If the key event is from the external device, DeviceInfo will have its name, class, and subclass information.
+ /// Sets the processKey Action
+ /// If the key event is from the external device, DeviceInfo will have its name, class and subclass information.
/// </summary>
/// <param name="processKey">
- /// The action is called when the key event is received from the external devices or the SendKey function.
+ /// The Action is alled when the key event is received from the external devices or SendKey function.
/// This Event processes the key event before an associated text input UI control does.
/// </param>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Sets the imDataRequested action.
+ /// Sets the imDataRequested Action
/// </summary>
/// <param name="imDataRequested">
/// Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length.
}
/// <summary>
- /// Sets the GeometryRequested action.
+ /// Sets the GeometryRequested Action
/// </summary>
/// <param name="geometryRequested">
- /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x, y, w, h values.
+ /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values.
/// </param>
/// <since_tizen> 4 </since_tizen>
public static void SetGeometryRequestedCallback(OutAction<Rect> geometryRequested)
}
/// <summary>
- /// Runs the main loop of the IME application.
- /// This function starts to run the IME application's main loop.
+ /// Runs the main loop of IME application.
+ /// This function starts to run IME application's main loop.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// <remarks>
/// This API is a blocking call, as it starts the main loop of the application.
/// </remarks>
- /// <param name="create">This is called to initialize the IME application before the main loop starts up.</param>
- /// <param name="terminate">This is called when the IME application is terminated.</param>
+ /// <param name="create">This is called to initialize IME application before the main loop starts up</param>
+ /// <param name="terminate">This is called when IME application is terminated</param>
/// <param name="show">
- /// This is called when the IME application is shown.
- /// It provides the context information and the context ID.
+ /// This is called when IME application is shown
+ /// It provides the Context Information and the Context Id
/// </param>
/// <param name="hide">
- /// This is called when the IME application is hidden.
- /// It provides the context ID.
+ /// This is called when IME application is hidden
+ /// It provides the Context Id
/// </param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) Operation failed.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) Operation failed
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void Run(Action create, Action terminate, Action<ContextId, InputMethodContext> show, Action<ContextId> hide)
/// Sends a key event to the associated text input UI control.
/// </summary>
/// <remarks>
- /// This function sends a key down or up event with the key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly.
+ /// This function sends key down or up event with key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly.
/// And if forwardKey is false, the ProcessKey event receives the key event before the edit field.
/// </remarks>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="keyCode">The key code to be sent.</param>
- /// <param name="keyMask">The modifier key mask.</param>
- /// <param name="forwardKey">The flag to send the key event directly to the edit field.</param>
+ /// <param name="keyCode">The key code to be sent</param>
+ /// <param name="keyMask">The modifier key mask</param>
+ /// <param name="forwardKey">The flag to send the key event directly to the edit field</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="str">The string to be committed.</param>
+ /// <param name="str">The string to be committed</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void CommitString(string str)
}
/// <summary>
- /// Requests to show the pre-edit string.
+ /// Requests to show preedit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void ShowPreEditString()
}
/// <summary>
- /// Requests to hide the pre-edit string.
+ /// Requests to hide preedit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void HidePreEditString()
}
/// <summary>
- /// Updates a new pre-edit string.
+ /// Updates a new preedit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="str">The string to be updated in pre-edit.</param>
+ /// <param name="str">The string to be updated in preedit</param>
/// <param name="attrs">
- /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color, and reversal color.
- /// The attrs list can be empty if no attributes to set.
+ /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color and reversal color.
+ /// The attrs list can be empty if no attributes to set
/// </param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
- /// 3) Invalid parameter.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
+ /// 3) Invalid Parameter
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void UpdatePreEditString(string str, IEnumerable<PreEditAttribute> attrs)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
- /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
+ /// <param name="maxLenBefore">The maximum length of string to be retrieved before the cursor, -1 means unlimited</param>
+ /// <param name="maxLenAfter">The maximum length of string to be retrieved after the cursor, -1 means unlimited</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
/// </exception>
/// <postcondition>
- /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set.
+ /// The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter)
}
/// <summary>
- /// Requests to delete the surrounding text.
+ /// Requests to delete surrounding text.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="offset">The offset value from the cursor position.</param>
- /// <param name="len">The length of the text to delete.</param>
+ /// <param name="offset">The offset value from the cursor position</param>
+ /// <param name="len">The length of the text to delete</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
- /// 3) Invalid parameter.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
+ /// 3) Invalid Parameter
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void DeleteSurroundingText(int offset, int len)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
- /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
- /// <param name="text">The surrounding text.</param>
- /// <param name="cursorPosition">The cursor position.</param>
+ /// <param name="maxLenBefore">The maximum length of string to be retrieved before the cursor, -1 means unlimited</param>
+ /// <param name="maxLenAfter">The maximum length of string to be retrieved after the cursor, -1 means unlimited</param>
+ /// <param name="text">The surrounding text</param>
+ /// <param name="cursorPosition">The cursor position</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
- /// 3) Invalid parameter.
- /// 4) Failed to obtain text due to out of memory.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
+ /// 3) Invalid Parameter
+ /// 4) Failed to obtain text due to out of memory
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition)
}
/// <summary>
- /// Requests to set the selection.
+ /// Requests to set selection.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="start">The start cursor position in text (in characters not bytes).</param>
- /// <param name="end">The end cursor position in text (in characters not bytes).</param>
+ /// <param name="start">The start cursor position in text (in characters not bytes)</param>
+ /// <param name="end">The end cursor position in text (in characters not bytes)</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
- /// 3) Invalid parameter.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
+ /// 3) Invalid Parameter
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SetSelection(int start, int end)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <returns>The input panel main window object on success, otherwise null.</returns>
+ /// <returns>The input panel main window object on success, otherwise null</returns>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) The IME main loop isn't started yet.
- /// 3) Operation failed.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) IME main loop isn't started yet
+ /// 3) Operation Failed
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static EditorWindow GetMainWindow()
}
/// <summary>
- /// This API requests the InputMethodEditor to initialize.
+ /// This API requests the InputMethodEditor to initialize
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) Operation failed.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) Operation Failed
/// </exception>
/// <since_tizen> 4 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// This API requests the InputMethodEditor to finalize.
+ /// This API requests the InputMethodEditor to finalize
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function.
- /// 2) Operation failed.
+ /// 1) The application does not have the privilege to call this function
+ /// 2) Operation Failed
/// </exception>
/// <since_tizen> 4 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the LanguageSet event.
+ /// This Class contains data related to LanguageSet Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class LanguageSetEventArgs
}
/// <summary>
- /// The preferred language that the client application wants.
+ /// The preferred language that the client application wants
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelLanguage Language
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the LayoutSet event.
+ /// This Class contains data related to LayoutSet Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class LayoutSetEventArgs
}
/// <summary>
- /// The input panel layout.
+ /// The input panel layout
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelLayout Layout
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for the attribute types.
+ /// Enumeration for Attribute Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AttributeType
{
/// <summary>
- /// No attribute.
+ /// No attribute
/// </summary>
None,
/// <summary>
- /// A font style attribute, for example, underline, etc.
+ /// A font style attribute, e.g., underline, etc.
/// </summary>
FontStyle
};
/// <summary>
- /// This class represents the attributes for the pre-edit string.
+ /// This class represents the attributes for preedit string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class PreEditAttribute
{
/// <summary>
- /// The start position in the string of this attribute.
+ /// The start position in the string of this attribute
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Start
}
/// <summary>
- /// The character length of this attribute, the range is [Start, Start+Length].
+ /// The character length of this attribute, the range is [Start, Start+Length]
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Length
}
/// <summary>
- /// The type of this attribute.
+ /// The type of this attribute
/// </summary>
/// <since_tizen> 4 </since_tizen>
public AttributeType Type
}
/// <summary>
- /// The value of this attribute.
+ /// The value of this attribute
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Value
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the ReturnKeyStateSet event.
+ /// This Class contains data related to ReturnKeyStateSet Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReturnKeyStateSetEventArgs
}
/// <summary>
- /// The bool state to disable the Return key. The Return key is enabled by default.
+ /// The bool state to disable Return key. The Return key is enabled by default
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool State
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the ReturnKeySet event.
+ /// This Class contains data related to ReturnKeySet Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReturnKeySetEventArgs
}
/// <summary>
- /// The type of the Return key on the input panel.
+ /// The type of Return key on the input panel
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelReturnKey Type
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the RotationChanged event.
+ /// This Class contains data related to RotationChanged Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class RotationChangedEventArgs
}
/// <summary>
- /// The rotation degree.
+ /// The rotation degree
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Degree
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This class contains the data related to the SurroundingTextUpdated event.
+ /// This Class contains data related to SurroundingTextUpdated Event
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SurroundingTextUpdatedEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control.
+ /// The input context identification value of an associated text input UI control
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
}
/// <summary>
- /// The cursor position.
+ /// The cursor position
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int CursorPosition
}
/// <summary>
- /// The string requested.
+ /// The string requested
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Text
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Partial Libraries class.
+ /// Partial Libraries Class
/// </summary>
internal static partial class Libraries
{
using static Tizen.Uix.SttEngine.Engine;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The SttEngine Interop class.
+ /// SttEngine Interop Class
/// </summary>
internal static class SttEngine
{
namespace Tizen.Uix.SttEngine
{
/// <summary>
- /// Enumeration for the audio types.
+ /// Enumeration for audio type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AudioType
{
/// <summary>
- /// Signed 16-bit audio type, little endian.
+ /// Signed 16bit audio type, Little endian
/// </summary>
PcmS16Le = 0,
/// <summary>
- /// Unsigned 8-bit audio type.
+ /// Unsigned 8bit audio type
/// </summary>
PcmU8
};
/// <summary>
- /// Enumeration for the results.
+ /// Enumeration for result.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Event when either the full matched or the final result is delivered.
+ /// Event when either the full matched or the final result is delivered
/// </summary>
FinalResult = 0,
/// <summary>
- /// Event when the partial matched result is delivered.
+ /// Event when the partial matched result is delivered
/// </summary>
PartialResult,
/// <summary>
- /// Event when the recognition has failed.
+ /// Event when the recognition has failed
/// </summary>
Error
};
/// <summary>
- /// Enumeration for the result time.
+ /// Enumeration for result time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TimeEvent
{
/// <summary>
- /// Event when the token is beginning type.
+ /// Event when the token is beginning type
/// </summary>
Beginning = 0,
/// <summary>
- /// Event when the token is middle type.
+ /// Event when the token is middle type
/// </summary>
Middle = 1,
/// <summary>
- /// Event when the token is end type.
+ /// Event when the token is end type
/// </summary>
End = 2
};
/// <summary>
- /// Enumeration for the speech status.
+ /// Enumeration for speech status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SpeechStatus
{
/// <summary>
- /// Beginning point of the speech is detected.
+ /// Beginning point of speech is detected
/// </summary>
BeginningPointDetected = 0,
/// <summary>
- /// End point of the speech is detected.
+ /// End point of speech is detected
/// </summary>
EndPointDetected
};
/// <summary>
- /// Enumeration for representing the result message.
+ /// Enumeration representing the result message
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultMessage
{
/// <summary>
- /// No error.
+ /// No Error
/// </summary>
None,
/// <summary>
- /// Recognition failed because the speech started too soon.
+ /// Recognition failed because the speech started too soon.
/// </summary>
TooSoon,
/// <summary>
- /// Recognition failed because the speech is too short.
+ /// Recognition failed because the speech is too short.
/// </summary>
TooShort,
/// <summary>
- /// Recognition failed because the speech is too long.
+ /// Recognition failed because the speech is too long.
/// </summary>
TooLong,
/// <summary>
- /// Recognition failed because the speech is too quiet to listen.
+ /// Recognition failed because the speech is too quiet to listen.
/// </summary>
TooQuiet,
/// <summary>
- /// Recognition failed because the speech is too loud to listen.
+ /// Recognition failed because the speech is too loud to listen.
/// </summary>
TooLoud,
/// <summary>
- /// Recognition failed because the speech is too fast to listen.
+ /// Recognition failed because the speech is too fast to listen.
/// </summary>
TooFast
};
/// <summary>
- /// Enumeration for the error values that can occur.
+ /// Enum for Error values that can occur
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, no error.
+ /// Successful, No error
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Out of memory.
+ /// Out of Memory
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// I/O error.
+ /// I/O error
/// </summary>
IoError = ErrorCode.IoError,
/// <summary>
- /// Invalid parameter.
+ /// Invalid parameter
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Network down (Out of network).
+ /// Network down(Out of network)
/// </summary>
NetworkDown = ErrorCode.NetworkDown,
/// <summary>
- /// Invalid state.
+ /// Invalid state
/// </summary>
InvalidState = ErrorCode.InvalidState,
/// <summary>
- /// Invalid language.
+ /// Invalid language
/// </summary>
InvalidLanguage = ErrorCode.InvalidLanguage,
/// <summary>
- /// Operation failed.
+ /// Operation failed
/// </summary>
OperationFailed = ErrorCode.OperationFailed,
/// <summary>
- /// Not supported feature of the current engine.
+ /// Not supported feature of current engine
/// </summary>
NotSupportedFeature = ErrorCode.NotSupportedFeature,
/// <summary>
- /// Not supported.
+ /// NOT supported
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Permission denied.
+ /// Permission denied
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied,
/// <summary>
- /// Recording timed out.
+ /// Recording timed out
/// </summary>
RecordingTimedOut = ErrorCode.RecordingTimedOut
};
/// <summary>
- /// This class represents the STT Engine, which has to be inherited to make the engine.
+ /// This Class represents the Stt Engine which has to be inherited to make the engine.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public abstract class Engine
private IntPtr _structIntPtrHandle;
/// <summary>
- /// An action with 2 input parameters returning an error.
+ /// An Action with 2 Input Parameter returning a Error
/// </summary>
- /// <typeparam name="T">Generic type for parameter 1.</typeparam>
- /// <param name="a">The input parameter 1.</param>
- /// <param name="b">The input parameter 2.</param>
- /// <returns>Error value.</returns>
+ /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
+ /// <param name="a">The Input Parameter 1</param>
+ /// <param name="b">The Input Parameter 2</param>
+ /// <returns>Error Value</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error Action<T>(T a, T b);
/// <summary>
- /// An action with 2 out parameters returning an error.
+ /// An Action with 2 Out Parameter returning a Error
/// </summary>
- /// <typeparam name="T">Generic type for parameter 1.</typeparam>
- /// <param name="a">The input parameter 1.</param>
- /// <param name="b">The input parameter 2.</param>
- /// <returns>Error value.</returns>
+ /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
+ /// <param name="a">The Input Parameter 1</param>
+ /// <param name="b">The Input Parameter 2</param>
+ /// <returns>Error Value</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error OutAction<T>(T a, out T b);
/// <summary>
- /// Called when the STT engine provides the time stamp of result to the engine service user.
+ /// Called when Stt engine provides the time stamp of result to the engine service user.
/// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
- /// <param name="index">The result index.</param>
- /// <param name="resultEvent">The token event.</param>
- /// <param name="text">The result text.</param>
- /// <param name="startTime">The time started speaking the result text.</param>
- /// <param name="endTime">The time finished speaking the result text.</param>
- /// <param name="userData">The user data.</param>
- /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
+ /// <param name="index">The result index</param>
+ /// <param name="resultEvent">The token event</param>
+ /// <param name="text">The result text</param>
+ /// <param name="startTime">The time started speaking the result text</param>
+ /// <param name="endTime">The time finished speaking the result text</param>
+ /// <param name="userData">The User data</param>
+ /// <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
/// <precondition>SendResult() should be called.</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData);
/// <summary>
- /// Called when the STT engine informs the engine service user about the whole supported language list.
+ /// Called when Stt engine informs the engine service user about whole supported language list.
/// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
/// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code
- /// followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="userData">The user data.</param>
- /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
- /// <precondition>ForEachSupportedLanguages() should be called.</precondition>
+ /// followed by ISO 639-1 for the two-letter language code
+ /// for example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="userData">The User data</param>
+ /// <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
+ /// <precondition>ForEachSupportedLanguages() should be called</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool SupportedLanguages(string language, IntPtr userData);
/// <summary>
- /// Called when the engine service user requests the basic information of the STT engine.
+ /// Called when the engine service user requests the basic information of Stt engine.
/// </summary>
/// <remarks>
- /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary. Therefore, engineSetting must be transferred to the engine service user.
+ /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user.
/// </remarks>
- /// <param name="engineUuid">UUID of the engine.</param>
- /// <param name="engineName">Name of the engine.</param>
- /// <param name="engineSetting">The engine setting application (UI app)'s ID.</param>
- /// <param name="useNetwork">A variable for checking whether the network is used or not.</param>
+ /// <param name="engineUuid">UUID of engine</param>
+ /// <param name="engineName">Name of engine</param>
+ /// <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
+ /// <param name="useNetwork">A variable for checking whether the network is used or not</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. OperationFailed
/// 3. InvalidParameter
public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork);
/// <summary>
- /// Called when the engine service user initializes the STT engine.
- /// This callback function is called by the engine service user to request for the STT engine to be started.
+ /// Called when the engine service user initializes Stt engine.
+ /// This callback function is called by the engine service user to request for Stt engine to be started.
/// </summary>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// 3. InvalidState
public abstract Error Initialize();
/// <summary>
- /// Called when the engine service user deinitializes the STT engine.
- /// This callback function is called by the engine service user to request for the STT engine to be deinitialized.
+ /// Called when the engine service user deinitializes Stt engine.
+ /// This callback function is called by the engine service user to request for Stt engine to be deinitialized.
/// </summary>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
/// Called when the engine service user gets the whole supported language list.
/// </summary>
/// <remarks>
- /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all the supported languages
+ /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages
/// and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.
/// </remarks>
- /// <param name="callback">The callback function,</param>
- /// <param name="userData">The user data, which must be passed to the callback delegate 'SupportedLanguages'.</param>
+ /// <param name="callback">The callback function</param>
+ /// <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// </returns>
/// <postcondition>
- /// This callback function invokes SupportedLanguages repeatedly for getting the supported languages.
+ /// This callback function invokes SupportedLanguages repeatedly for getting supported languages.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachSupportedLanguages(SupportedLanguages callback, IntPtr userData);
/// <summary>
- /// Called when the engine service user checks whether the corresponding language is valid or not in the STT engine.
+ /// Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid.</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error IsValidLanguage(string language, out bool isValid);
/// <summary>
- /// Called when the engine service user checks whether the STT engine supports silence detection.
+ /// Called when the engine service user checks whether Stt engine supports silence detection.
/// </summary>
- /// <returns>true to support silence detection, false not to support silence detection.</returns>
+ /// <returns>true to support silence detection, false not to support silence detection</returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool SupportSilenceDetection();
/// <summary>
- /// Called when the engine service user checks whether the STT engine supports the corresponding recognition type.
+ /// Called when the engine service user checks whether Stt engine supports the corresponding recognition type.
/// </summary>
- /// <param name="type">The type for recognition, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
- /// <param name="isSupported">A variable for checking whether the STT engine supports the corresponding recognition type.
- /// true to support the recognition type, false not to support the recognition type.</param>
+ /// <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
+ /// <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.
+ /// true to support recognition type, false not to support recognition type</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error SupportRecognitionType(string type, out bool isSupported);
/// <summary>
- /// Called when the engine service user gets the proper recording format of the STT engine.
+ /// Called when the engine service user gets the proper recording format of Stt engine.
/// The recording format is used for creating the recorder.
/// </summary>
- /// <param name="types">The format used by the recorder.</param>
- /// <param name="rate">The sample rate used by the recorder.</param>
- /// <param name="channels">The number of channels used by the recorder.</param>
+ /// <param name="types">The format used by the recorder</param>
+ /// <param name="rate">The sample rate used by the recorder</param>
+ /// <param name="channels">The number of channels used by the recorder</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
/// <summary>
/// Called when the engine service user sets the silence detection.
- /// If the engine service user sets this option as 'TRUE', the STT engine will detect the silence (EPD) and send the callback event about it.
+ /// If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it.
/// </summary>
- /// <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence.</param>
+ /// <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error SetSilenceDetection(bool isSet);
/// <summary>
- /// Called when the engine service user requests for the STT engine to check whether the application agreed the usage of the STT engine.
- /// This callback function is called when the engine service user requests for the STT engine to check the application's agreement about using the engine.
+ /// Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.
+ /// This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine.
/// According to the need, the engine developer can provide some user interfaces to check the agreement.
/// </summary>
/// <param name="appid">The Application ID</param>
- /// <param name="isAgreed">A variable for checking whether the application agreed to use the STT engine or not. true to agree, false to disagree.</param>
+ /// <param name="isAgreed">A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error CheckAppAgreed(string appid, out bool isAgreed);
/// <summary>
- /// Called when the engine service user checks whether STT engine needs the application's credential.
+ /// Called when the engine service user checks whether Stt engine needs the application's credential.
/// </summary>
- /// <returns>true if the STT engine needs the application's credential, otherwise false.</returns>
+ /// <returns>true if Stt engine needs the application's credential, otherwise false </returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool NeedAppCredential();
/// <remarks>
/// In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user
/// and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.
- /// timeInfo is transferred from SendResult. The type of timeInfo is up to the STT engine developer.
+ /// timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.
/// </remarks>
- /// <param name="timeInfo">The time information.</param>
- /// <param name="callback">The callback function.</param>
- /// <param name="userData">The user data, which must be passed to the callback function ResultTime.</param>
+ /// <param name="timeInfo">The time information</param>
+ /// <param name="callback">The callback function</param>
+ /// <param name="userData">The user data which must be passed to the callback function ResultTime</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// </returns>
/// <precondition>
- /// SendResult will invoke this function.
+ /// SendResult will invoke this function
/// </precondition>
/// <postcondition>
- /// This function invokes the ResultTime repeatedly for getting the result time information.
+ /// This function invokes ResultTime repeatedly for getting result time information.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachResultTime(IntPtr timeInfo, ResultTime callback, IntPtr userData);
/// <summary>
/// Called when the engine service user starts to recognize the recording data.
- /// In this callback function, the STT engine must transfer the recognition result and userData to the engine service user using SendResult().
- /// Also, if the STT engine needs the application's credential, it sets the credential granted to the application.
- /// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
- /// <param name="appid">The application ID.</param>
- /// <param name="credential">The credential granted to the application.</param>
- /// <param name="userData">The user data to be passed to the callback function.</param>
+ /// In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().
+ /// Also, if Stt engine needs the application's credential, it sets the credential granted to the application.
+ /// </summary>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
+ /// <param name="appid">The Application ID</param>
+ /// <param name="credential">The credential granted to the application</param>
+ /// <param name="userData">The user data to be passed to the callback function</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// <summary>
/// Called when the engine service user sets and sends the recording data for speech recognition.
- /// This callback function is called by the engine service user to send the recording data to the STT engine. The engine receives the recording data and uses for speech recognition.
- /// This function should be returned immediately after recording data copy.
+ /// This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition.
+ /// this function should be returned immediately after recording data copy.
/// </summary>
- /// <param name="data">The recording data.</param>
- /// <param name="length">The length of the recording data.</param>
+ /// <param name="data">The recording data</param>
+ /// <param name="length">The length of recording data</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// 4. OperationFailed
/// </returns>
/// <precondition>
- /// Start should succeed.</precondition>
+ /// Start should succeed</precondition>
/// <postcondition>
/// If the engine supports partial result, SendResult() should be invoked.</postcondition>
/// <since_tizen> 4 </since_tizen>
/// Called when the engine service user stops to recognize the recording data.
/// This callback function is called by the engine service user to stop recording and to get the recognition result.
/// </summary>
- /// <returns>The following error codes can be returned:
+ /// <returns>Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// 4. NetworkDown
/// </returns>
/// <precondition>
- /// Start should succeed.</precondition>
+ /// Start should succeed</precondition>
/// <postcondition>
- /// After processing of the engine, SendResult() should be invoked.</postcondition>
+ /// After processing of the engine, , SendResult() should be invoked.</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error Stop();
/// <summary>
/// Called when the engine service user cancels to recognize the recording data.
- /// This callback function is called by the engine service user to cancel to recognize the recording data. Also, when starting the recorder is failed, this function is called.
+ /// This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called.
/// </summary>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
- /// <precondition>The STT engine is in recognition processing or recording.</precondition>
+ /// <precondition>Stt engine is in recognition processing or recording.</precondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error Cancel();
/// <summary>
- /// Public constructor.
+ /// Public Constructor
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.recognition
}
/// <summary>
- /// Main function for the Speech-To-Text (STT) engine.
- /// This function is the main function for operating the STT engine.
+ /// Main function for Speech-To-Text (STT) engine.
+ /// This function is the main function for operating Stt engine.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// <remarks>
/// ServiceAppMain should be used for working the engine after this function.
/// </remarks>
- /// <param name="argc">The number of arguments.</param>
- /// <param name="argv">The arguments array.</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <param name="argc">The Number of Arguments</param>
+ /// <param name="argv">The Arguments Array</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <since_tizen> 4 </since_tizen>
public void EngineMain(int argc, string[] argv)
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// This API is used in SetRecordingData() and Stop(), when the STT engine sends the recognition result to the engine service user.
- /// This function is called in the following situations: 1) After Stop() is called, 2) The end point of speech is detected from recording, or 3) Partial result is occurred.
- /// The recognition result must be transferred to the engine service user through this function. Also, the timeInfo must be transferred to ForEachResultTime().
- /// The type of timeInfo is up to the STT engine developer.
+ /// This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.
+ /// This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred.
+ /// The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().
+ /// The type of timeInfo is up to the Stt engine developer.
/// </remarks>
- /// <param name="resultEvent">The result event.</param>
- /// <param name="type">The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
- /// <param name="result">Result texts.</param>
- /// <param name="resultCount">Result text count.</param>
- /// <param name="msg">Engine message.</param>
- /// <param name="timeInfo">The time information.</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <param name="resultEvent">The result event</param>
+ /// <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
+ /// <param name="result">Result texts</param>
+ /// <param name="resultCount">Result text count</param>
+ /// <param name="msg">Engine message</param>
+ /// <param name="timeInfo">The time information</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
- /// The EngineMain function should be invoked before this function is called. Stop will invoke this function.
+ /// EngineMain function should be invoked before this function is called. Stop will invoke this function.
/// </precondition>
/// <postcondition>
/// This function invokes ForEachResultTime
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
- /// <param name="error">The error reason.</param>
- /// <param name="msg">The error message.</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <param name="error">The Error Reason</param>
+ /// <param name="msg">The error message</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of Operation failure</exception>
/// <precondition>
- /// The main function should be invoked before this function is called.
+ /// Main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SendError(Error error, string msg)
}
/// <summary>
- /// Sends the speech status to the engine service user when the STT engine notifies the change of the speech status.
+ /// Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// This API is invoked when the STT engine wants to notify the change of the speech status anytime. Note that this API can be invoked for recognizing the speech.
+ /// This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech.
/// </remarks>
/// <param name="status">SpeechStatus</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
- /// The main function should be invoked before this function is called. The Start() and SetRecordingData() will invoke this function.
+ /// Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SendSpeechStatus(SpeechStatus status)
/// http://tizen.org/feature/microphone
/// </feature>
/// <param name="callback">
- /// Called when the STT engine receives the private data from the engine service user.
- /// This callback function is called when the engine service user sends the private data to the STT engine.
+ /// Called when Stt engine receives the private data from the engine service user.
+ /// This callback function is called when the engine service user sends the private data to Stt engine.
/// In Parameters:
/// a = Key -- The key field of private data
/// b = data -- The data field of private data
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
- /// The main function should be invoked before this function is called.
+ /// Main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SetPrivateDataSetDelegate(Action<string> callback)
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
- /// <param name="callback">The callback function.
- /// Called when the STT engine provides the engine service user with the private data.
- /// This callback function is called when the engine service user gets the private data from the STT engine.
- /// Out parameters:
+ /// <param name="callback">callback function
+ /// Called when Stt engine provides the engine service user with the private data.
+ /// This callback function is called when the engine service user gets the private data from Stt engine.
+ /// Out Parameters:
/// a = Key -- The key field of private data
/// b = data -- The data field of private data
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
- /// The main function should be invoked before this function is called.
+ /// Main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SetPrivateDataRequestedDelegate(OutAction<string> callback)
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The Partial Libraries class.
+ /// Partial Libraries Class
/// </summary>
internal static partial class Libraries
{
using static Tizen.Uix.TtsEngine.Engine;
/// <summary>
-/// The Partial Interop class.
+/// Partial Interop Class
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// The TtsEngine Interop class.
+ /// TtsEngine Interop Class
/// </summary>
internal static class TtsEngine
{
namespace Tizen.Uix.TtsEngine
{
/// <summary>
- /// Enumeration for the audio types.
+ /// Enumeration for audio type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AudioType
{
/// <summary>
- /// Signed 16-bit audio type.
+ /// Signed 16-bit audio type
/// </summary>
RawS16 = 0,
/// <summary>
- /// Unsigned 8-bit audio type.
+ /// Unsigned 8-bit audio type
/// </summary>
RawU8,
/// <summary>
- /// Maximum value.
+ /// Maximum Value
/// </summary>
Max
};
/// <summary>
- /// Enumeration for the results.
+ /// Enumeration for result.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Event when the voice synthesis fails.
+ /// Event when the voice synthesis is failed
/// </summary>
Fail = -1,
/// <summary>
- /// Event when the sound data is the first data by the callback function.
+ /// Event when the sound data is first data by callback function
/// </summary>
Start = 1,
/// <summary>
- /// Event when the next sound data exists, not the first and the last.
+ /// Event when the next sound data exist, not first and not last
/// </summary>
Continue = 2,
/// <summary>
- /// Event when the sound data is the last data or the sound data is the only result.
+ /// Event when the sound data is last data or sound data is only one result
/// </summary>
Finish = 3
};
/// <summary>
- /// Enumeration for the voice types.
+ /// Enumeration for Voice Type
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum VoiceType
{
/// <summary>
- /// Male voice type.
+ /// male voice type.
/// </summary>
Male = 1,
/// <summary>
- /// Female voice type.
+ /// female voice type.
/// </summary>
Female = 2,
/// <summary>
- /// Child's voice type.
+ /// child's voice type.
/// </summary>
Child = 3
}
/// <summary>
- /// Enumeration for the error values that can occur.
+ /// Enum for Error values that can occur
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, no error.
+ /// Successful, No error
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Out of memory.
+ /// Out of Memory
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// I/O error.
+ /// I/O error
/// </summary>
IoError = ErrorCode.IoError,
/// <summary>
- /// Invalid parameter.
+ /// Invalid parameter
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Network down (Out of network).
+ /// Network down(Out of network)
/// </summary>
NetworkDown = ErrorCode.NetworkDown,
/// <summary>
- /// Invalid state.
+ /// Invalid state
/// </summary>
InvalidState = ErrorCode.InvalidState,
/// <summary>
- /// Invalid voice.
+ /// Invalid voice
/// </summary>
InvalidVoice = ErrorCode.InvalidVoice,
/// <summary>
- /// Operation failed.
+ /// Operation failed
/// </summary>
OperationFailed = ErrorCode.OperationFailed,
/// <summary>
- /// Not supported feature of the current engine.
+ /// Not supported feature of current engine
/// </summary>
NotSupportedFeature = ErrorCode.NotSupportedFeature,
/// <summary>
- /// Not supported.
+ /// NOT supported
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Permission denied.
+ /// Permission denied
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied
};
/// <summary>
- /// This class represents the TTS engine, which has to be inherited to make the engine.
+ /// This Class represents the Tts Engine which has to be inherited to make the engine.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public abstract class Engine
private IntPtr _structIntPtrHandle;
/// <summary>
- /// An action with 2 input parameters returning an error.
+ /// An Action with 2 Input Parameter returning a Error
/// </summary>
- /// <typeparam name="T">Generic type for parameter 1.</typeparam>
- /// <param name="a">The input parameter 1.</param>
- /// <param name="b">The input parameter 2.</param>
- /// <returns>Error value.</returns>
+ /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
+ /// <param name="a">The Input Parameter 1</param>
+ /// <param name="b">The Input Parameter 2</param>
+ /// <returns>Error Value</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error Action<T>(T a, T b);
/// <summary>
- /// An action with 2 out parameters returning an error.
+ /// An Action with 2 Out Parameter returning a Error
/// </summary>
- /// <typeparam name="T">Generic type for parameter 1.</typeparam>
- /// <param name="a">The input parameter 1.</param>
- /// <param name="b">The input parameter 2.</param>
- /// <returns>Error value.</returns>
+ /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
+ /// <param name="a">The Input Parameter 1</param>
+ /// <param name="b">The Input Parameter 2</param>
+ /// <returns>Error Value</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error OutAction<T>(T a, out T b);
/// <summary>
- /// Called when the TTS engine informs the engine service user about whole supported language and voice type list.
- /// This callback function is implemented by the engine service user, therefore, the engine developer does NOT have to implement this callback function.
+ /// Called when TTS engine informs the engine service user about whole supported language and voice type list.
+ /// This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
/// <remarks>
/// This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices().
/// </remarks>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The voice type.</param>
- /// <param name="userData">The user data passed from ForEachSupportedVoices().</param>
- /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The voice type</param>
+ /// <param name="userData">The user data passed from ForEachSupportedVoices()</param>
+ /// <returns>true to continue with the next iteration of the loop false to break out of the loop</returns>
/// <precondition>ForEachSupportedVoices() will invoke this callback function.</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool SupportedVoice(string language, VoiceType type, IntPtr userData);
/// Called when the engine service user starts to synthesize a voice, asynchronously.
/// </summary>
/// <remarks>
- /// In this callback function, the TTS engine must transfer the synthesized result to the engine service user using SendResult().
- /// Also, if the TTS engine needs the application's credential, it can set the credential granted to the application.
+ /// In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult().
+ /// Also, if TTS engine needs the application's credential, it can set the credential granted to the application.
/// </remarks>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The voice type.</param>
- /// <param name="text">Texts.</param>
- /// <param name="speed">The speed of speaking.</param>
- /// <param name="appid">The application ID.</param>
- /// <param name="credential">The credential granted to the application.</param>
- /// <param name="userData">The user data which must be passed to the SendResult() function.</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The voice type</param>
+ /// <param name="text">Texts</param>
+ /// <param name="speed">The speed of speaking</param>
+ /// <param name="appid">The Application ID</param>
+ /// <param name="credential">The credential granted to the application</param>
+ /// <param name="userData">The user data which must be passed to SendResult() function</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// 6. NetworkDown
/// 7. PermissionDenied
/// </returns>
- /// <postcondition>This function invokes SendResult().</postcondition>
+ /// <postcondition>This function invokes SendResult()</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error StartSynthesis(string language, int type, string text, int speed, string appid, string credential, IntPtr userData);
/// <summary>
- /// Called when the engine service user requests the basic information of the TTS engine.
+ /// Called when the engine service user requests the basic information of TTS engine.
/// </summary>
/// <remarks>
/// The allocated engineUuid, engineName, and engineSetting will be released internally.
- /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary.
+ /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary.
/// Therefore, engineSetting must be transferred to the engine service user.
/// </remarks>
- /// <param name="engineUuid">UUID of the engine.</param>
- /// <param name="engineName">Name of the engine.</param>
- /// <param name="engineSetting">The engine setting application (UI application)'s ID.</param>
- /// <param name="useNetwork">The status for using the network.</param>
+ /// <param name="engineUuid">UUID of engine</param>
+ /// <param name="engineName">Name of engine</param>
+ /// <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
+ /// <param name="useNetwork">The status for using network</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork);
/// <summary>
- /// Called when the engine service user initializes the TTS engine.
+ /// Called when the engine service user initializes TTS engine.
/// </summary>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error Initialize();
/// <summary>
- /// Called when the engine service user deinitializes the TTS engine.
+ /// Called when the engine service user deinitializes TTS engine.
/// </summary>
/// <remarks>
- /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of the resources is necessary.
+ /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary.
/// </remarks>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
/// Called when the engine service user gets the whole supported voice list.
/// </summary>
/// <remarks>
- /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all the supported voices,
+ /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices,
/// and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'.</remarks>
- /// <param name="callback">The callback function.</param>
- /// <param name="userData">The user data which must be passed to SupportedVoice().</param>
+ /// <param name="callback">The callback function</param>
+ /// <param name="userData">The user data which must be passed to SupportedVoice()</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. OperationFailed
/// </returns>
- /// <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all the supported voices.</postcondition>
+ /// <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all supported voices.</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachSupportedVoices(SupportedVoice callback, IntPtr userData);
/// <summary>
- /// Called when the engine service user checks whether the voice is valid or not in the TTS engine.
+ /// Called when the engine service user checks whether the voice is valid or not in TTS engine.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The voice type.</param>
- /// <param name="isValid">A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid.</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The voice type</param>
+ /// <param name="isValid">A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error IsValidVoice(string language, int type, out bool isValid);
/// <summary>
- /// Called when the engine service user sets the default pitch of the TTS engine.
+ /// Called when the engine service user sets the default pitch of TTS engine.
/// </summary>
- /// <param name="pitch">The default pitch.</param>
+ /// <param name="pitch">The default pitch</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// <summary>
/// Called when the engine service user requests to load the corresponding voice type for the first time.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The voice type.</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The voice type</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// <summary>
/// Called when the engine service user requests to unload the corresponding voice type or to stop using voice.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
- /// <param name="type">The voice type.</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English</param>
+ /// <param name="type">The voice type</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
public abstract Error UnloadVoice(string language, int type);
/// <summary>
- /// Called when the engine service user requests for the TTS engine to check whether the application agreed the usage of the TTS engine.
- /// This callback function is called when the engine service user requests for the TTS engine to check the application's agreement about using the the engine.
+ /// Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.
+ /// This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine.
/// According to the need, the engine developer can provide some user interfaces to check the agreement.
/// </summary>
/// <remarks>
- /// If the TTS engine developer does not want to check the agreement, the developer needs to return proper values as isAgreed in accordance with the intention.
+ /// If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention.
/// true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed.
/// NOTE that, however, there may be any legal issue unless the developer checks the agreement.
/// Therefore, we suggest that the engine developers should provide a function to check the agreement.
/// </remarks>
- /// <param name="appid">The application ID.</param>
- /// <param name="isAgreed">A variable for checking whether the application agreed to use the TTS engine or not. true to agree, false to disagree.</param>
+ /// <param name="appid">The Application ID</param>
+ /// <param name="isAgreed">A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree</param>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error CheckAppAgreed(string appid, out bool isAgreed);
/// <summary>
- /// Called when the engine service user checks whether the TTS engine needs the application's credentials.
+ /// Called when the engine service user checks whether TTS engine needs the application's credential.
/// </summary>
- /// <returns>true if TTS engine needs the application's credentials, otherwise false. </returns>
+ /// <returns> true if TTS engine needs the application's credential, otherwise false </returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool NeedAppCredential();
/// Called when the engine service user cancels to synthesize a voice.
/// </summary>
/// <returns>
- /// The following error codes can be returned:
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidState
/// </returns>
/// <precondition>
- /// StartSynthesis should be performed.
+ /// StartSynthesis should be performed
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error CancelSynthesis();
/// <summary>
- /// Public constructor.
+ /// Public Constructor
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
}
/// <summary>
- /// Main function for the Text-To-Speech (TTS) engine.
- /// This function is the main function for operating the TTS engine.
+ /// Main function for Text-To-Speech (TTS) engine.
+ /// This function is the main function for operating TTS engine.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// <remarks>
/// ServiceAppMain should be used for working the engine after this function.
/// </remarks>
- /// <param name="argc">The argument count (original).</param>
- /// <param name="argv">The argument (original).</param>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
+ /// <param name="argc">The argument count(original)</param>
+ /// <param name="argv">The argument(original)</param>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <since_tizen> 4 </since_tizen>
public void EngineMain(int argc, string[] argv)
{
}
/// <summary>
- /// Gets the speed range from the Tizen platform.
+ /// Gets the speed range from Tizen platform
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used when the TTS engine wants to get the speed range from the Tizen platform.
+ /// This API is used when TTS engine wants to get the speed range from Tizen platform
/// </remarks>
- /// <param name="min">The minimum speed value.</param>
- /// <param name="normal">The normal speed value.</param>
- /// <param name="max">The maximum speed value.</param>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
+ /// <param name="min">The minimum speed value</param>
+ /// <param name="normal">The normal speed value</param>
+ /// <param name="max">The maximum speed value</param>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <since_tizen> 4 </since_tizen>
public void GetSpeedRange(out int min, out int normal, out int max)
{
}
/// <summary>
- /// Gets the pitch range from the Tizen platform.
+ /// Gets the pitch range from Tizen platform.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used when the TTS engine wants to get the pitch range from the Tizen platform.
+ /// This API is used when TTS engine wants to get the pitch range from Tizen platform.
/// </remarks>
- /// <param name="min">The minimum pitch value.</param>
- /// <param name="normal">The normal pitch value.</param>
- /// <param name="max">The maximum pitch value.</param>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
+ /// <param name="min">The minimum pitch value</param>
+ /// <param name="normal">The normal pitch value</param>
+ /// <param name="max">The maximum pitch value</param>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <since_tizen> 4 </since_tizen>
public void GetPitchRange(out int min, out int normal, out int max)
{
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used in StartSynthesis(), when the TTS engine sends the synthesized result to the engine service user.
+ /// This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user.
/// The synthesized result must be transferred to the engine service user through this function.
/// </remarks>
- /// <param name="resultEvent">The result event.</param>
- /// <param name="data">The result data.</param>
- /// <param name="dataSize">The result data size.</param>
- /// <param name="audioType">The audio type.</param>
- /// <param name="rate">The sample rate.</param>
- /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
+ /// <param name="resultEvent">The result event</param>
+ /// <param name="data">Result data</param>
+ /// <param name="dataSize">Result data size</param>
+ /// <param name="audioType">The audio type</param>
+ /// <param name="rate">The sample rate</param>
+ /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
/// EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function.
/// </precondition>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
- /// <param name="error">The error reason.</param>
- /// <param name="msg">The error message.</param>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
+ /// <param name="error">The error reason</param>
+ /// <param name="msg">The error message</param>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
/// EngineMain function should be invoked before this function is called.
/// </precondition>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <param name="callback">
- /// Called when the engine service user gets the private data from the TTS engine.
- /// In parameters:
- /// a = Key -- The key field of private data.
- /// b = data -- The data field of private data.
- /// The following error codes can be returned:
+ /// Called when the engine service user gets the private data from Tts engine.
+ /// In Parameters:
+ /// a = Key -- The key field of private data
+ /// b = data -- The data field of private data
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// 4. NotSupported
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">thrown in case of operation failure.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
/// Main function should be invoked before this function is called.
/// </precondition>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
- /// <param name="callback">The callback function.
- /// Called when the TTS engine receives the private data from the engine service user.
- /// This callback function is called when the engine service user sends the private data to the TTS engine.
- /// Out parameters:
- /// a = Key -- The key field of private data.
- /// b = data -- The data field of private data.
- /// The following error codes can be returned:
+ /// <param name="callback">callback function
+ /// Called when TTS engine receives the private data from the engine service user.
+ /// This callback function is called when the engine service user sends the private data to TTS engine.
+ /// Out Parameters:
+ /// a = Key -- The key field of private data
+ /// b = data -- The data field of private data
+ /// Following Error Codes can be returned
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// 4. NotSupported
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
- /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
- /// <exception cref="InvalidOperationException">thrown in case of operation failure.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
/// <precondition>
/// Main function should be invoked before this function is called.
/// </precondition>
/// <exception cref="NullReferenceException">This will occur if the provided parameter is null.</exception>
public void Add(VoiceCommand command)
{
- if (null == command) {
- throw new NullReferenceException("Null Parameter Provided");
- }
ErrorCode error = VcCmdListAdd(_handle, command._handle);
if (error != ErrorCode.None)
{
/// <exception cref="NullReferenceException">This will occur if the provided parameter is null.</exception>
public void Remove(VoiceCommand command)
{
- if (null == command) {
- throw new NullReferenceException("Null Parameter Provided");
- }
ErrorCode error = VcCmdListRemove(_handle, command._handle);
if (error != ErrorCode.None)
{
namespace Tizen.WebView
{
/// <summary>
- /// This class provides the methods to initialize and shutdown the Chromium-efl.
+ /// This class provides methods to initialize and shutdown Chromium-efl.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Chromium
{
/// <summary>
- /// Initializes the Chromium's instance.
+ /// Initializes Chromium's instance.
/// </summary>
- /// <returns>A reference count of the Chromium's instance.</returns>
+ /// <returns>A reference count of Chromium's instance</returns>
/// <since_tizen> 4 </since_tizen>
public static int Initialize()
{
}
/// <summary>
- /// Decreases a reference count of the WebKit's instance, possibly destroying it.
+ /// Decreases a reference count of WebKit's instance, possibly destroying it.
/// </summary>
- /// <returns>A reference count of the Chromium's instance.</returns>
+ /// <returns>A reference count of Chromium's instance</returns>
/// <since_tizen> 4 </since_tizen>
public static int Shutdown()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration for cache model options.
+ /// Enumeration that contains option for cache model.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CacheModel
/// </summary>
DocumentViewer,
/// <summary>
- /// Use the bigger cache capacity than DocumentBrowser.
+ /// Use bigger cache capacity than DocumentBrowser.
/// </summary>
DocumentBrowser,
/// <summary>
}
/// <summary>
- /// This class encapsulates all the pages related to the specific use of the Chromium-efl.
+ /// This class encapsulates all pages related to the specific use of Chromium-efl.
/// </summary>
/// <remarks>
/// Applications have the option of creating a context different from the default one and using it for a group of pages.
/// <summary>
/// Gets the CookieManager object for this context.
/// </summary>
- /// <returns>The CookieManager object.</returns>
+ /// <returns>The CookieManager object</returns>
/// <since_tizen> 4 </since_tizen>
public CookieManager GetCookieManager()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration for the cookies accept policies.
+ /// Enumeration that contains accept policies for the cookies.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CookieAcceptPolicy
/// </summary>
Always,
/// <summary>
- /// Rejects all the cookies.
+ /// Rejects all cookies.
/// </summary>
Never,
/// <summary>
- /// Accepts only cookies set by the main document that is loaded.
+ /// Accepts only cookies set by the main document loaded.
/// </summary>
NoThirdParty
}
/// <summary>
- /// Enumeration for creating a type name for the storage of persistent cookies.
+ /// Enumeration that creates a type name for the storage of persistent cookies.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CookiePersistentStorage
/// Sets the cookie acceptance policy.
/// </summary>
/// <remarks>
- /// By default, only cookies set by the main document that is loaded, are accepted.
+ /// By default, only cookies set by the main document loaded are accepted.
/// </remarks>
- /// <param name="policy">The cookie acceptance policy.</param>
+ /// <param name="policy">The cookie acceptance policy</param>
/// <since_tizen> 4 </since_tizen>
public void SetCookieAcceptPolicy(CookieAcceptPolicy policy)
{
}
/// <summary>
- /// Sets the storage where the non-session cookies are stored persistently, to read/write the cookies.
+ /// Sets the storage where non-session cookies are stored persistently to read/write the cookies.
/// </summary>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="path">The path where to read/write cookies.</param>
- /// <param name="storage">The type of storage.</param>
+ /// <param name="path">The path where to read/write Cookies</param>
+ /// <param name="storage">The type of storage</param>
/// <since_tizen> 4 </since_tizen>
public void SetPersistentStorage(string path, CookiePersistentStorage storage)
{
/// <summary>
/// The callback function that is invoked when the message is received from the script.
/// </summary>
- /// <param name="message">The JavaScriptMessage returned by the script.</param>
+ /// <param name="message">The JavaScriptMessage returned by the script</param>
/// <since_tizen> 4 </since_tizen>
public delegate void JavaScriptMessageHandler(JavaScriptMessage message);
/// <summary>
- /// A script message contains information that is sent from the JavaScript runtime.
+ /// A Script message contains information that sent from JavaScript runtime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class JavaScriptMessage
}
/// <summary>
- /// The object name in JavaScript.
+ /// Obect name in JavaScript.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Name
}
/// <summary>
- /// Gets the value of the body as an integer type.
+ /// Gets the value of body as integer type.
/// </summary>
- /// <returns>The value of the body as an integer type.</returns>
+ /// <returns>The value of body as integer type</returns>
/// <since_tizen> 4 </since_tizen>
public int GetBodyAsInteger()
{
}
/// <summary>
- /// Gets the value of the body as a double type.
+ /// Gets the value of body as double type.
/// </summary>
- /// <returns>The value of the body as a double type.</returns>
+ /// <returns>The value of body as double type</returns>
/// <since_tizen> 4 </since_tizen>
public double GetBodyAsDouble()
{
}
/// <summary>
- /// Gets the value of the body as a boolean type.
+ /// Gets the value of body as boolean type.
/// </summary>
- /// <returns>The value of the body as boolean type.</returns>
+ /// <returns>The value of body as boolean type</returns>
/// <since_tizen> 4 </since_tizen>
public bool GetBodyAsBoolean()
{
}
/// <summary>
- /// Gets the value of the body as a string type.
+ /// Gets the value of body as string type.
/// </summary>
- /// <returns>The value of the body as a string type.</returns>
+ /// <returns>The value of body as string type</returns>
/// <since_tizen> 4 </since_tizen>
public string GetBodyAsString()
{
namespace Tizen.WebView
{
/// <summary>
- /// This class provides the properties for setting the preference of a specific WebView.
+ /// This class provides properties for setting the preference of a specific WebView.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class Settings
}
/// <summary>
- /// Whether the JavaScript can be executed.
+ /// Whether JavaScript can be executable.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool JavaScriptEnabled
}
/// <summary>
- /// Whether the images can be loaded automatically.
+ /// Whether images can be loaded automatically.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool LoadImageAutomatically
namespace Tizen.WebView
{
/// <summary>
- /// The argument from the SmartCallback.
+ /// Argument from the SmartCallback.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SmartCallbackArgs : EventArgs
}
/// <summary>
- /// Gets the argument as an integer type.
+ /// Gets argument as integer type.
/// </summary>
- /// <returns>Argument as an integer type.</returns>
+ /// <returns>Argument as integer type</returns>
/// <since_tizen> 4 </since_tizen>
public int GetAsInteger()
{
}
/// <summary>
- /// Gets the argument as a double type.
+ /// Gets argument as double type.
/// </summary>
- /// <returns>Argument as a double type.</returns>
+ /// <returns>Argument as double type</returns>
/// <since_tizen> 4 </since_tizen>
public double GetAsDouble()
{
}
/// <summary>
- /// Gets the argument as a boolean type.
+ /// Gets argument as boolean type.
/// </summary>
- /// <returns>Argument as a boolean type.</returns>
+ /// <returns>Argument as boolean type</returns>
/// <since_tizen> 4 </since_tizen>
public bool GetAsBoolean()
{
}
/// <summary>
- /// Gets the argument as a string type.
+ /// Gets argument as string type.
/// </summary>
- /// <returns>Argument as a string type.</returns>
+ /// <returns>Argument as string type</returns>
/// <since_tizen> 4 </since_tizen>
public string GetAsString()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration for providing an option to the error codes.
+ /// Enumeration that provides an option to error codes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LoadErrorCode
{
/// <summary>
- /// Unknown.
+ /// Unknown
/// </summary>
Unknown = 0,
/// <summary>
- /// User canceled.
+ /// User canceled
/// </summary>
Canceled,
/// <summary>
- /// Can't show the page for this MIME type.
+ /// Can't show page for this MIME Type.
/// </summary>
CantSupportMimetype,
/// <summary>
- /// File IO error.
+ /// File IO error
/// </summary>
FailedFileIo,
/// <summary>
- /// Cannot connect to the network.
+ /// Cannot connect to network.
/// </summary>
CantConnect,
/// <summary>
- /// Fail to look up host from the DNS.
+ /// Fail to look up host from DNS.
/// </summary>
CantLookupHost,
/// <summary>
/// </summary>
InvalidCertificate,
/// <summary>
- /// Connection timeout.
+ /// Connection timeout
/// </summary>
RequestTimeout,
/// <summary>
- /// Too many redirects.
+ /// Too many redirects
/// </summary>
TooManyRedirects,
/// <summary>
- /// Too many requests during this load.
+ /// Too many requests during this load
/// </summary>
TooManyRequests,
/// <summary>
- /// Malformed URL.
+ /// Malformed url
/// </summary>
BadUrl,
/// <summary>
- /// Unsupported scheme.
+ /// Unsupported scheme
/// </summary>
UnsupportedScheme,
/// <summary>
- /// User authentication failed on the server.
+ /// User authentication failed on server
/// </summary>
Authentication,
/// <summary>
- /// Web server has an internal server error.
+ /// Web server has internal server error.
/// </summary>
InternalServer,
}
/// <summary>
- /// Arguments from the LoadError SmartCallback.
+ /// Argument from the LoadError SmartCallback.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SmartCallbackLoadErrorArgs : EventArgs
namespace Tizen.WebView
{
/// <summary>
- /// A view used to render the web contents.
+ /// A view used to render web contents.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WebView: EvasObject
/// <summary>
- /// Event that occurs when the load is started.
+ /// Event that occurs when load started.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler LoadStarted;
/// <summary>
- /// Event that occurs when the load is finished.
+ /// Event that occurs when load finished.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler LoadFinished;
/// <summary>
- /// Event that occurs when the load throws an error.
+ /// Event that occurs when load error.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackLoadErrorArgs> LoadError;
/// <summary>
- /// Event that occurs when the title of the main frame is changed.
+ /// Event that occurs when title of main frame was changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackArgs> TitleChanged;
/// <summary>
- /// Event that occurs when the URL of the main frame is changed.
+ /// Event that occurs when URL of main frame was changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackArgs> UrlChanged;
}
/// <summary>
- /// Creates a WebView object.
+ /// Create a WebView object.
/// </summary>
- /// <param name="parent">Parent object of the WebView.</param>
+ /// <param name="parent">Parent object of WebView</param>
/// <since_tizen> 4 </since_tizen>
public WebView(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Gets the context object of this view.
+ /// Gets the Context object of this view.
/// </summary>
- /// <returns>The context object of this view.</returns>
+ /// <returns>The Context object of this view</returns>
/// <since_tizen> 4 </since_tizen>
public Context GetContext()
{
}
/// <summary>
- /// Gets the settings object of this view.
+ /// Gets the Settings object of this view.
/// </summary>
- /// <returns>The settings object of this view.</returns>
+ /// <returns>The Settings object of this view</returns>
/// <since_tizen> 4 </since_tizen>
public Settings GetSettings()
{
/// Asks the object to load the given URL.
/// </summary>
/// <remarks>
- /// You can only be sure that the URL changes after UrlChanged event.
+ /// You can only be sure that url changed after UrlChanged event.
/// </remarks>
- /// <param name="url">The uniform resource identifier to load.</param>
+ /// <param name="url">The uniform resource identifier to load</param>
/// <since_tizen> 4 </since_tizen>
public void LoadUrl(string url)
{
}
/// <summary>
- /// Loads the specified HTML string as the content of the view.
+ /// Loads the specified html string as the content of the view.
/// </summary>
- /// <param name="html">HTML data to load.</param>
- /// <param name="baseUrl">Base URL used for relative paths to external objects.</param>
+ /// <param name="html">HTML data to load</param>
+ /// <param name="baseUrl">Base URL used for relative paths to external objects</param>
/// <since_tizen> 4 </since_tizen>
public void LoadHtml(string html, string baseUrl)
{
}
/// <summary>
- /// Checks whether it is possible to navigate backward one item in history.
+ /// Checks whether it is possible to navigate backwards one item in history.
/// </summary>
- /// <returns>Whether it is possible to navigate backward one item in history.</returns>
+ /// <returns>Whether it is possible to navigate backwards one item in history</returns>
/// <since_tizen> 4 </since_tizen>
public bool CanGoBack()
{
}
/// <summary>
- /// Checks whether it is possible to navigate forward one item in history.
+ /// Checks whether it is possible to navigate forwards one item in history.
/// </summary>
- /// <returns>Whether it is possible to navigate forward one item in history.</returns>
+ /// <returns>Whether it is possible to navigate forwards one item in history</returns>
/// <since_tizen> 4 </since_tizen>
public bool CanGoForward()
{
/// <summary>
/// Injects the supplied javascript message handler into the view.
/// </summary>
- /// <param name="name"> The message callback.</param>
- /// <param name="handler">The name used to expose the object in JavaScript.</param>
- /// <returns>'true' on success, otherwise 'false'.</returns>
+ /// <param name="name"> The message callback</param>
+ /// <param name="handler">The name used to expose the object in JavaScript</param>
+ /// <returns>'true' on success, otherwise 'false'</returns>
/// <since_tizen> 4 </since_tizen>
public bool AddJavaScriptMessageHandler(string name, JavaScriptMessageHandler handler)
{
}
/// <summary>
- /// Requests the execution of a given name and the result to the JavaScript runtime.
+ /// Requests the execution of given name and result to the JavaScript runtime.
/// </summary>
- /// <param name="name">The name used to expose the object in JavaScript.</param>
- /// <param name="result">The result to the JavaScript runtime.</param>
+ /// <param name="name">The name used to expose the object in JavaScript</param>
+ /// <param name="result">The result to the JavaScript runtime</param>
/// <since_tizen> 4 </since_tizen>
public void EvalWithResult(string name, string result)
{
/// <summary>
/// Requests the execution of the given script.
/// </summary>
- /// <param name="script">The JavaScript code string to execute.</param>
+ /// <param name="script">The JavaScript code string to execute</param>
/// <since_tizen> 4 </since_tizen>
public void Eval(string script)
{
/// <summary>
/// Requests to set or unset a view as the currently focused one.
/// </summary>
- /// <param name="focused">'true' to set the focus on the view, 'false' to remove the focus from the view.</param>
+ /// <param name="focused">'true' to set the focus on the view, 'false' to remove the focus from the view</param>
/// <since_tizen> 4 </since_tizen>
public void SetFocus(bool focused)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject.</param>
- /// <returns>IntPtr of the widget handle.</returns>
+ /// <param name="parent">Parent EvasObject</param>
+ /// <returns>IntPtr of the widget handle</returns>
/// <since_tizen> 4 </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
private int _value;
/// <summary>
- /// Initiates the new color with R,G,B,A components.
+ /// Initiates new Color with r,g,b,a components.
/// </summary>
- /// <param name="r">Red (0 ~ 255).</param>
- /// <param name="g">Green (0 ~ 255).</param>
- /// <param name="b">Blue (0 ~ 255).</param>
- /// <param name="a">Alpha (0 ~ 255).</param>
+ /// <param name="r">Red (0 ~ 255)</param>
+ /// <param name="g">Green (0 ~ 255)</param>
+ /// <param name="b">Blue (0 ~ 255)</param>
+ /// <param name="a">Alpha (0 ~ 255)</param>
/// <since_tizen> 3 </since_tizen>
public Color(int r, int g, int b, int a)
{
}
/// <summary>
- /// Initiates the new color with R,G,B components. The Alpha value will be 255 as default.
+ /// Initiates new Color with r,g,b components. The alpha value will be 255 as default.
/// </summary>
- /// <param name="r">Red (0 ~ 255).</param>
- /// <param name="g">Green (0 ~ 255).</param>
- /// <param name="b">Blue (0 ~ 255).</param>
+ /// <param name="r">Red (0 ~ 255)</param>
+ /// <param name="g">Green (0 ~ 255)</param>
+ /// <param name="b">Blue (0 ~ 255)</param>
/// <since_tizen> 3 </since_tizen>
public Color(int r, int g, int b) : this(r, g, b, 255)
{
}
/// <summary>
- /// Gets the Blue component of the color.
+ /// Gets the blue component of the color.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int B
}
/// <summary>
- /// Gets the Alpha component of the color.
+ /// Gets the alpha component of the color.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int A
#region Static Methods
/// <summary>
- /// Returns a boolean indicating whether the two given colors are equal.
+ /// Returns a boolean indicating whether the two given Colors are equal.
/// </summary>
- /// <param name="color1">The first color to compare.</param>
- /// <param name="color2">The second color to compare.</param>
- /// <returns>True if the colors are equal; False otherwise.</returns>
+ /// <param name="color1">The first Color to compare.</param>
+ /// <param name="color2">The second Color to compare.</param>
+ /// <returns>True if the Colors are equal; False otherwise.</returns>
/// <since_tizen> 3 </since_tizen>
public static bool operator ==(Color color1, Color color2)
{
}
/// <summary>
- /// Returns a boolean indicating whether the two given colors are not equal.
+ /// Returns a boolean indicating whether the two given Colors are not equal.
/// </summary>
- /// <param name="color1">The first color to compare.</param>
- /// <param name="color2">The second color to compare.</param>
- /// <returns>True if the colors are not equal; False if they are equal.</returns>
+ /// <param name="color1">The first Color to compare.</param>
+ /// <param name="color2">The second Color to compare.</param>
+ /// <returns>True if the Colors are not equal; False if they are equal.</returns>
/// <since_tizen> 3 </since_tizen>
public static bool operator !=(Color color1, Color color2)
{
/// <summary>
/// Returns a new RGB color instance.
/// </summary>
- /// <param name="r">The Red component of the color.</param>
- /// <param name="g">The Green component of the color.</param>
- /// <param name="b">The Blue component of the color.</param>
+ /// <param name="r">The red component of the color.</param>
+ /// <param name="g">The green component of the color.</param>
+ /// <param name="b">The blue component of the color.</param>
/// <returns></returns>
/// <since_tizen> 3 </since_tizen>
public static Color FromRgb(int r, int g, int b)
/// <summary>
/// Returns a new RGBA color instance.
/// </summary>
- /// <param name="r">The Red component of the color.</param>
- /// <param name="g">The Green component of the color.</param>
- /// <param name="b">The Blue component of the color.</param>
- /// <param name="a">The Alpha component of the color.</param>
- /// <returns>The RGBA color instance.</returns>
+ /// <param name="r">The red component of the color.</param>
+ /// <param name="g">The green component of the color.</param>
+ /// <param name="b">The blue component of the color.</param>
+ /// <param name="a">The alpha component of the color.</param>
+ /// <returns>the RGBA color instance.</returns>
/// <since_tizen> 3 </since_tizen>
public static Color FromRgba(int r, int g, int b, int a)
{
}
/// <summary>
- /// Returns a new RGB color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one.
+ /// Returns a new RGB Color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one.
/// </summary>
/// <param name="hex">A string that contains the hexadecimal RGB(A) color representation.</param>
- /// <returns>The RGBA color instance.</returns>
+ /// <returns>the RGBA color instance.</returns>
/// <since_tizen> 3 </since_tizen>
public static Color FromHex(string hex)
{
}
/// <summary>
- /// Returns a string representation in Hex (For example: \#FFFFFFFF in RGBA order).
+ /// Returns a string representation in Hex. (ex: \#FFFFFFFF in RGBA order)
/// </summary>
/// <returns>The string representation in Hex.</returns>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Returns a boolean indicating whether the given color is equal to this Color instance.
+ /// Returns a boolean indicating whether the given Color is equal to this Color instance.
/// </summary>
- /// <param name="other">The color to compare this instance to.</param>
- /// <returns>True if the other color is equal to this instance; False otherwise.</returns>
+ /// <param name="other">The Color to compare this instance to.</param>
+ /// <returns>True if the other Color is equal to this instance; False otherwise.</returns>
/// <since_tizen> 3 </since_tizen>
public bool Equals(Color other)
{
}
/// <summary>
- /// Returns a boolean indicating whether the given object is equal to this Color instance.
+ /// Returns a boolean indicating whether the given Object is equal to this Color instance.
/// </summary>
- /// <param name="obj">The object to compare against.</param>
- /// <returns>True if the object is equal to this color; False otherwise.</returns>
+ /// <param name="obj">The Object to compare against.</param>
+ /// <returns>True if the Object is equal to this Color; False otherwise.</returns>
/// <since_tizen> 3 </since_tizen>
public override bool Equals(object obj)
{
}
/// <summary>
- /// Returns a string representation of the color.
+ /// Returns a string representation of the Color.
/// </summary>
/// <returns>The string representation.</returns>
/// <since_tizen> 3 </since_tizen>
/// <summary>
/// Gets the version of Tizen .NET API.
/// </summary>
- /// <returns>The Tizen .NET API version.</returns>
+ /// <returns>The Tizen .NET API version</returns>
/// <since_tizen> 4 </since_tizen>
public static int TizenAPIVersion
{
namespace Tizen.Internals.Errors
{
/// <summary>
- /// Error codes used inside Tizen .NET API implementation.
+ /// Error codes used inside Tizen .NET API implementation
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ErrorCode : int
{
/// <summary>
- /// Successful.
+ /// Successful
/// </summary>
None = 0, // 0
/// <summary>
- /// Operation not permitted.
+ /// Operation not permitted
/// </summary>
NotPermitted = -1, // -EPERM
/// <summary>
- /// No such file or directory.
+ /// No such file or directory
/// </summary>
NoSuchFile = -2, // -ENOENT
/// <summary>
- /// No such process.
+ /// No such process
/// </summary>
NoSuchProcess = -3, // -ESRCH
/// <summary>
- /// Interrupted system call.
+ /// Interrupted system call
/// </summary>
InterruptedSysCall = -4, // -EINTR
/// <summary>
- /// I/O error.
+ /// I/O error
/// </summary>
IoError = -5, // -EIO
/// <summary>
- /// No such device or address.
+ /// No such device or address
/// </summary>
NoSuchDevice = -6, // -ENXIO
/// <summary>
- /// Argument list too long.
+ /// Argument list too long
/// </summary>
ArgumentListTooLong = -7, // -E2BIG
/// <summary>
- /// Executable format error.
+ /// Exec format error
/// </summary>
ExecFormatError = -8, // -ENOEXEC
/// <summary>
- /// Bad file number.
+ /// Bad file number
/// </summary>
BadFileNumber = -9, // -EBADF
/// <summary>
- /// Try again.
+ /// Try again
/// </summary>
TryAgain = -11, // -EAGAIN
/// <summary>
- /// Out of memory.
+ /// Out of memory
/// </summary>
OutOfMemory = -12, // -ENOMEM
/// <summary>
- /// Permission denied.
+ /// Permission denied
/// </summary>
PermissionDenied = -13, // -EACCES
/// <summary>
- /// Bad address.
+ /// Bad address
/// </summary>
BadAddress = -14, // -EFAULT
/// <summary>
- /// Block device required.
+ /// Block device required
/// </summary>
BlockDeviceRequired = -15, // -ENOTBLK
/// <summary>
- /// Device or resource busy.
+ /// Device or resource busy
/// </summary>
ResourceBusy = -16, // -EBUSY
/// <summary>
- /// File exists.
+ /// File exists
/// </summary>
FileExists = -17, // -EEXIST
/// <summary>
- /// Cross-device link.
+ /// Cross-device link
/// </summary>
CrossDeviceLink = -18, // -EXDEV
/// <summary>
- /// Not a directory.
+ /// Not a directory
/// </summary>
NotaDirectory = -20, // -ENOTDIR
/// <summary>
- /// Is a directory.
+ /// Is a directory
/// </summary>
IsADirectory = -21, // -EISDIR
/// <summary>
- /// Invalid function parameter.
+ /// Invalid function parameter
/// </summary>
InvalidParameter = -22, // -EINVAL
/// <summary>
- /// File table overflow.
+ /// File table overflow
/// </summary>
FileTableOverflow = -23, // -ENFILE
/// <summary>
- /// Too many open files.
+ /// Too many open files
/// </summary>
TooManyOpenFiles = -24, // -EMFILE
/// <summary>
- /// Not a terminal.
+ /// Not a terminal
/// </summary>
TooNotaTerminal = -25, // -ENOTTY
/// <summary>
- /// Too text file busy.
+ /// Too text file busy
/// </summary>
TooTextFileBusy = -26, // -ETXTBSY
/// <summary>
- /// File too large.
+ /// File too large
/// </summary>
FileTooLarge = -27, // -EFBIG
/// <summary>
- /// No space left on device.
+ /// No space left on device
/// </summary>
FileNoSpaceOnDevice = -28, // -ENOSPC
/// <summary>
- /// Illegal seek.
+ /// Illegal seek
/// </summary>
IllegalSeek = -29, // -ESPIPE
/// <summary>
- /// Read-only file system.
+ /// Read-only file system
/// </summary>
ReadOnlyFilesystem = -30, // -EROFS
/// <summary>
- /// No data available.
+ /// No data available
/// </summary>
NoData = -61, // -ENODATA
/// <summary>
- /// Too many links.
+ /// Too many links
/// </summary>
TooManyLinks = -31, // -EMLINK
/// <summary>
- /// Broken pipe.
+ /// Broken pipe
/// </summary>
BrokenPipe = -32, // -EPIPE
/// <summary>
- /// Math argument out of domain of the function.
+ /// Math argument out of domain of func
/// </summary>
ArgumentOutOfDomain = -33, // -EDOM
/// <summary>
- /// Math result not representable.
+ /// Math result not representable
/// </summary>
ResultOutOfRange = -34, // -ERANGE
/// <summary>
- /// Resource deadlock would occur.
+ /// Resource deadlock would occur
/// </summary>
WouldCauseDeadlock = -35, // -EDEADLK
/// <summary>
- /// File name too long.
+ /// File name too long
/// </summary>
FileNameTooLong = -36, // -ENAMETOOLONG
/// <summary>
- /// No record locks available.
+ /// No record locks available
/// </summary>
FileNoLocksAvailable = -37, // -ENOLCK
/// <summary>
- /// Function not implemented.
+ /// Function not implemented
/// </summary>
InvalidOperation = -38, // -ENOSYS
/// <summary>
- /// Directory not empty.
+ /// Directory not empty
/// </summary>
DirNotEmpty = -39, // -ENOTEMPTY
/// <summary>
- /// Too many symbolic links encountered.
+ /// Too many symbolic links encountered
/// </summary>
TooManySymbolicLinks = -40, // -ELOOP
/// <summary>
- /// Operation would block.
+ /// Operation would block
/// </summary>
WouldBlock = -11, // TryAgain (-EAGAIN)
/// <summary>
- /// Accessing a corrupted shared library.
+ /// Accessing a corrupted shared library
/// </summary>
CorruptedSharedLib = -80, // -ELIBBAD
/// <summary>
- /// .lib section in a.out corrupted.
+ /// .lib section in a.out corrupted
/// </summary>
LibSectionCorrupted = -81, // -ELIBSCN
/// <summary>
- /// Attempting to link in too many shared libraries.
+ /// Attempting to link in too many shared libraries
/// </summary>
LinkTooManySharedLib = -82, // -ELIBMAX
/// <summary>
- /// Cannot execute a shared library directly.
+ /// Cannot exec a shared library directly
/// </summary>
SharedLibExec = -83, // -ELIBEXEC
/// <summary>
- /// Illegal byte sequence.
+ /// Illegal byte sequence
/// </summary>
IllegalByteSeq = -84, // -EILSEQ
/// <summary>
- /// Interrupted system call should be restarted.
+ /// Interrupted system call should be restarted
/// </summary>
SystemCallRestart = -85, // -ERESTART
/// <summary>
- /// Streams pipe error.
+ /// Streams pipe error
/// </summary>
StreamsPipe = -86, // -ESTRPIPE
/// <summary>
- /// Too many users.
+ /// Too many users
/// </summary>
TooManyUsers = -87, // -EUSERS
/// <summary>
- /// Socket operation on non-socket.
+ /// Socket operation on non-socket
/// </summary>
NonSocket = -88, // -ENOTSOCK
/// <summary>
- /// Destination address required.
+ /// Destination address required
/// </summary>
NoDestAddress = -89, // -EDESTADDRREQ
/// <summary>
- /// Message too long.
+ /// Message too long
/// </summary>
MsgTooLong = -90, // -EMSGSIZE
/// <summary>
- /// Protocol wrong type for socket.
+ /// Protocol wrong type for socket
/// </summary>
ProtocolWrongType = -91, // -EPROTOTYPE
/// <summary>
- /// Protocol not available.
+ /// Protocol not available
/// </summary>
ProtocolNotAvaliable = -92, // -ENOPROTOOPT
/// <summary>
- /// Protocol not supported.
+ /// Protocol not supported
/// </summary>
ProtocolNotSupported = -93, // -EPROTONOSUPPORT
/// <summary>
- /// Socket type not supported.
+ /// Socket type not supported
/// </summary>
SocketTypeNotSupported = -94, // -ESOCKTNOSUPPORT
/// <summary>
- /// Operation not supported on the transport endpoint.
+ /// Operation not supported on transport endpoint
/// </summary>
EndpointOperatinNotSupported = -95, // -EOPNOTSUPP
/// <summary>
- /// Protocol family not supported.
+ /// Protocol family not supported
/// </summary>
ProtocolFamilyNotSupported = -96, // -EPFNOSUPPORT
/// <summary>
- /// Address family not supported by protocol.
+ /// Address family not supported by protocol
/// </summary>
AddressFamilyNotSupported = -97, // -EAFNOSUPPORT
/// <summary>
- /// Address already in use.
+ /// Address already in use
/// </summary>
AddresInUse = -98, // -EADDRINUSE
/// <summary>
- /// Cannot assign requested address.
+ /// Cannot assign requested address
/// </summary>
CannotAssignAddress = -99, // -EADDRNOTAVAIL
/// <summary>
- /// Network down.
+ /// Network is down
/// </summary>
Networkdown = -100, // -ENETDOWN
/// <summary>
- /// Network unreachable.
+ /// Network is unreachable
/// </summary>
NetworkUnreachable = -101, // -ENETUNREACH
/// <summary>
- /// Network dropped the connection because of the reset.
+ /// Network dropped connection because of reset
/// </summary>
NetworkReset = -102, // -ENETRESET
/// <summary>
- /// Software caused the connection to abort.
+ /// Software caused connection abort
/// </summary>
ConnectionAborted = -103, // -ECONNABORTED
/// <summary>
- /// Connection reset by the peer.
+ /// Connection reset by peer
/// </summary>
ConnectionResetByPeer = -104, // -ECONNRESET
/// <summary>
- /// No buffer space available.
+ /// No buffer space available
/// </summary>
BufferSpace = -105, // -ENOBUFS
/// <summary>
- /// Transport endpoint already connected.
+ /// Transport endpoint is already connected
/// </summary>
EndpointConnected = -106, // -EISCONN
/// <summary>
- /// Transport endpoint not connected.
+ /// Transport endpoint is not connected
/// </summary>
EndpointNotConnected = -107, // -ENOTCONN
/// <summary>
- /// Cannot send after the transport endpoint shutdown.
+ /// Cannot send after transport endpoint shutdown
/// </summary>
EndpointShutdown = -108, // -ESHUTDOWN
/// <summary>
- /// Too many references: cannot splice.
+ /// Too many references: cannot splice
/// </summary>
TooManyReferences = -109, // -ETOOMANYREFS
/// <summary>
- /// Connection timed out.
+ /// Connection timed out
/// </summary>
ConnectionTimeout = -110, // -ETIMEDOUT
/// <summary>
- /// Connection refused.
+ /// Connection refused
/// </summary>
ConnectionRefused = -111, // -ECONNREFUSED
/// <summary>
- /// Host down.
+ /// Host is down
/// </summary>
Hostdown = -112, // -EHOSTDOWN
/// <summary>
- /// No route to host.
+ /// No route to host
/// </summary>
NoRouteToHost = -113, // -EHOSTUNREACH
/// <summary>
- /// Operation already in progress.
+ /// Operation already in progress
/// </summary>
AlreadyInProgress = -114, // -EALREADY
/// <summary>
- /// Operation now in progress.
+ /// Operation now in progress
/// </summary>
NowInProgress = -115, // -EINPROGRESS
/// <summary>
- /// Stale NFS file handle.
+ /// Stale NFS file handle
/// </summary>
StaleNfsFileHandle = -116, // -ESTALE
/// <summary>
- /// Structure needs cleaning.
+ /// Structure needs cleaning
/// </summary>
StructureUnclean = -117, // -EUCLEAN
/// <summary>
- /// Not a XENIX named type file.
+ /// Not a XENIX named type file
/// </summary>
NotXenixNamedTypeFile = -118, // -ENOTNAM
/// <summary>
- /// No XENIX semaphores available.
+ /// No XENIX semaphores available
/// </summary>
NoXenixSemaphoresAvailable = -119, // -ENAVAIL
/// <summary>
- /// Is a named type file.
+ /// Is a named type file
/// </summary>
IsNamedTypeFile = -120, // -EISNAM
/// <summary>
- /// Remote I/O error.
+ /// Remote I/O error
/// </summary>
RemoteIo = -121, // -EREMOTEIO
/// <summary>
- /// Quota exceeded.
+ /// Quota exceeded
/// </summary>
QuotaExceeded = -122, // -EDQUOT
/// <summary>
- /// No medium found.
+ /// No medium found
/// </summary>
NoMedium = -123, // -ENOMEDIUM
/// <summary>
- /// Wrong medium type.
+ /// Wrong medium type
/// </summary>
WrongMediumType = -124, // -EMEDIUMTYPE
/// <summary>
- /// Operation Canceled.
+ /// Operation Canceled
/// </summary>
Canceled = -125, // -ECANCELED
/// <summary>
- /// Required key not available.
+ /// Required key not available
/// </summary>
KeyNotAvailable = -126, // -ENOKEY
/// <summary>
- /// Key has expired.
+ /// Key has expired
/// </summary>
KeyExpired = -127, // -EKEYEXPIRED
/// <summary>
- /// Key has been revoked.
+ /// Key has been revoked
/// </summary>
KeyRevoked = -128, // -EKEYREVOKED
/// <summary>
- /// Key was rejected by the service.
+ /// Key was rejected by service
/// </summary>
KeyRejected = -129, // -EKEYREJECTED
/// <summary>
- /// Owner died (for robust mutexes).
+ /// Owner died (for robust mutexes)
/// </summary>
OwnerDead = -130, // -EOWNERDEAD
/// <summary>
- /// Unknown error.
+ /// Unknown error
/// </summary>
Unknown = -1073741824, // TIZEN_ERROR_MIN_PLATFORM_ERROR
/// <summary>
- /// Timed out.
+ /// Time out
/// </summary>
TimedOut,
/// <summary>
- /// Not supported.
+ /// Not Supported
/// </summary>
NotSupported,
/// <summary>
- /// Not consented.
+ /// Not Consented
/// </summary>
UserNotConsented,
/// <summary>
- /// The end of collection.
+ /// The end of collection
/// </summary>
EndofCollection
}
namespace Tizen.Internals.Errors
{
/// <summary>
- /// Provides functions that return the additional information about <see cref="ErrorCode"/>.
+ /// Provides functions that return additional information about the <see cref="ErrorCode"/>
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class ErrorFacts
/// <summary>
/// Gets the last error code in the thread.
/// </summary>
- /// <returns>One of <see cref="ErrorCode"/>.</returns>
+ /// <returns>One of <see cref="ErrorCode"/></returns>
/// <since_tizen> 3 </since_tizen>
public static int GetLastResult()
{
}
/// <summary>
- /// Gets the message for the given error code.
+ /// Gets the message for given the error code.
/// </summary>
- /// <param name="errorCode">One of <see cref="ErrorCode"/>.</param>
+ /// <param name="errorCode">One of <see cref="ErrorCode"/></param>
/// <returns></returns>
/// <since_tizen> 3 </since_tizen>
public static string GetErrorMessage(int errorCode)
projects / platform / core / csapi / tizenfx.git / commitdiff