-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
* @brief Event arguments that passed via StatusChanged signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class StatusChangedEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionNext signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionNextEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionPrevious signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionPreviousEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionActivate signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionActivateEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionRead signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionOver signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionOverEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadNext signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadNextEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadPrevious signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadPreviousEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionUp signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionUpEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionDown signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionDownEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionClearFocus signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionClearFocusEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionBack signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionBackEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionScrollUp signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionScrollUpEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionScrollDown signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionScrollDownEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionPageLeft signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionPageLeftEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionPageRight signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionPageRightEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionPageUp signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionPageUpEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionPageDown signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionPageDownEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionMoveToFirst signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionMoveToFirstEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionMoveToLast signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionMoveToLastEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadFromTop signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadFromTopEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadFromNext signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadFromNextEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionZoom signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionZoomEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadIndicatorInformation signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadIndicatorInformationEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionReadPauseResume signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionReadPauseResumeEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
* @brief Event arguments that passed via ActionStartStop signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class ActionStartStopEventArgs : EventArgs
{
private AccessibilityManager _accessibilityManager;
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager AccessibilityManager
{
get
}
}
- /**
- * @brief Event arguments that passed via ActionScroll signal
- *
- */
- /*
- // To be replaced by a new event that takes Touch
- public class ActionScrollEventArgs : EventArgs
- {
- private AccessibilityManager _accessibilityManager;
- private TouchEvent _touchEvent;
-
- public AccessibilityManager AccessibilityManager
- {
- get
- {
- return _accessibilityManager;
- }
- set
- {
- _accessibilityManager = value;
- }
- }
-
- public TouchEvent TouchEvent
- {
- get
- {
- return _touchEvent;
- }
- set
- {
- _touchEvent = value;
- }
- }
- }
- */
-
/**
* @brief Event arguments that passed via ActionPageUp signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class FocusChangedEventArgs : EventArgs
{
private View _viewCurrent;
private View _viewNext;
+ /// <since_tizen> 3 </since_tizen>
public View ViewCurrent
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public View ViewNext
{
get
* @brief Event arguments that passed via FocusedViewActivated signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class FocusedViewActivatedEventArgs : EventArgs
{
private View _view;
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
* @brief Event arguments that passed via FocusOvershot signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class FocusOvershotEventArgs : EventArgs
{
private View _currentFocusedView;
private AccessibilityManager.FocusOvershotDirection _focusOvershotDirection;
+ /// <since_tizen> 3 </since_tizen>
public View CurrentFocusedView
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public AccessibilityManager.FocusOvershotDirection FocusOvershotDirection
{
get
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum AccessibilityAttribute
{
ACCESSIBILITY_LABEL = 0,
ACCESSIBILITY_ATTRIBUTE_NUM
}
+ /// <since_tizen> 3 </since_tizen>
public enum FocusOvershotDirection
{
OVERSHOT_PREVIOUS = -1,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
- public class Padding : global::System.IDisposable
+ /// <since_tizen> 3 </since_tizen>
+ public new class Padding : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Padding(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
~Padding()
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Padding() : this(NDalicPINVOKE.new_Alignment_Padding__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public Padding(float l, float r, float t, float b) : this(NDalicPINVOKE.new_Alignment_Padding__SWIG_1(l, r, t, b), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public float left
{
set
}
}
+ /// <since_tizen> 3 </since_tizen>
public float right
{
set
}
}
+ /// <since_tizen> 3 </since_tizen>
public float top
{
set
}
}
+ /// <since_tizen> 3 </since_tizen>
public float bottom
{
set
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
HorizontalLeft = 1,
VerticalBottom = 32
}
+ /// <since_tizen> 3 </since_tizen>
public enum Scaling
{
ScaleNone,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public class AnyContainerBase : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal AnyContainerBase(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
~AnyContainerBase()
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public AnyContainerBase(SWIGTYPE_p_std__type_info type, SWIGTYPE_p_f_r_q_const__Dali__Any__AnyContainerBase__p_Dali__Any__AnyContainerBase cloneFunc, SWIGTYPE_p_f_p_q_const__Dali__Any__AnyContainerBase__void deleteFunc) : this(NDalicPINVOKE.new_Any_AnyContainerBase(SWIGTYPE_p_std__type_info.getCPtr(type), SWIGTYPE_p_f_r_q_const__Dali__Any__AnyContainerBase__p_Dali__Any__AnyContainerBase.getCPtr(cloneFunc), SWIGTYPE_p_f_p_q_const__Dali__Any__AnyContainerBase__void.getCPtr(deleteFunc)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public SWIGTYPE_p_std__type_info GetType()
+ /// <since_tizen> 3 </since_tizen>
+ public new SWIGTYPE_p_std__type_info GetType()
{
SWIGTYPE_p_std__type_info ret = new SWIGTYPE_p_std__type_info(NDalicPINVOKE.Any_AnyContainerBase_GetType(swigCPtr), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public SWIGTYPE_p_std__type_info mType
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public SWIGTYPE_p_f_r_q_const__Dali__Any__AnyContainerBase__p_Dali__Any__AnyContainerBase mCloneFunc
{
set
}
}
+ /// <since_tizen> 3 </since_tizen>
public SWIGTYPE_p_f_p_q_const__Dali__Any__AnyContainerBase__void mDeleteFunc
{
set
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/**
* @brief Event for Terminated signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationTerminateEventHandler-DaliEventHandler<object,NUIApplicationTerminateEventArgs>)
* provided by the user. Terminated signal is emitted when application is terminating
*/
public event DaliEventHandler<object, NUIApplicationTerminatingEventArgs> Terminating
/**
* @brief Event for Paused signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationPauseEventHandler-DaliEventHandler<object,NUIApplicationPauseEventArgs>)
* provided by the user. Paused signal is emitted when application is paused
*/
public event DaliEventHandler<object, NUIApplicationPausedEventArgs> Paused
/**
* @brief Event for Resumed signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationResumeEventHandler-DaliEventHandler<object,NUIApplicationResumeEventArgs>)
* provided by the user. Resumed signal is emitted when application is resumed
*/
public event DaliEventHandler<object, NUIApplicationResumedEventArgs> Resumed
/**
* @brief Event for Reset signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationResetEventHandler-DaliEventHandler<object,NUIApplicationResetEventArgs>)
* provided by the user. Reset signal is emitted when application is reset
*/
- public event DaliEventHandler<object, NUIApplicationResetEventArgs> Reset
+ public new event DaliEventHandler<object, NUIApplicationResetEventArgs> Reset
{
add
{
/**
* @brief Event for Resized signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationResizeEventHandler-DaliEventHandler<object,NUIApplicationResizeEventArgs>)
* provided by the user. Resized signal is emitted when application is resized
*/
public event DaliEventHandler<object, NUIApplicationResizedEventArgs> Resized
/**
* @brief Event for LanguageChanged signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationLanguageChangedEventHandler-DaliEventHandler<object,NUIApplicationLanguageChangedEventArgs>)
* provided by the user. LanguageChanged signal is emitted when the region of the device is changed.
*/
public event DaliEventHandler<object, NUIApplicationLanguageChangedEventArgs> LanguageChanged
/**
* @brief Event for RegionChanged signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationRegionChangedEventHandler-DaliEventHandler<object,NUIApplicationRegionChangedEventArgs>)
* provided by the user. RegionChanged signal is emitted when the region of the device is changed.
*/
public event DaliEventHandler<object, NUIApplicationRegionChangedEventArgs> RegionChanged
/**
* @brief Event for BatteryLow signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationBatteryLowEventHandler-DaliEventHandler<object,NUIApplicationBatteryLowEventArgs>)
* provided by the user. BatteryLow signal is emitted when the battery level of the device is low.
*/
public event DaliEventHandler<object, NUIApplicationBatteryLowEventArgs> BatteryLow
/**
* @brief Event for MemoryLow signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationMemoryLowEventHandler-DaliEventHandler<object,NUIApplicationMemoryLowEventArgs>)
* provided by the user. MemoryLow signal is emitted when the memory level of the device is low.
*/
public event DaliEventHandler<object, NUIApplicationMemoryLowEventArgs> MemoryLow
/**
* @brief Event for AppControl signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NUIApplicationAppControlEventHandler-DaliEventHandler<object,NUIApplicationAppControlEventArgs>)
* provided by the user. AppControl signal is emitted when another application sends a launch request to the application.
*/
public event DaliEventHandler<object, NUIApplicationAppControlEventArgs> AppControl
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum WindowMode
{
Opaque = 0,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <since_tizen> 3 </since_tizen>
public class QuitEventArgs : EventArgs
{
}
}
catch (System.Exception e)
{
+ NUILog.Error(e.Message);
throw new global::System.InvalidOperationException("Failed to parse " + fileName);
}
}
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum UIFormat
{
JSON
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <since_tizen> 3 </since_tizen>
public class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
~Property()
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_CameraActor_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TYPE = NDalicPINVOKE.CameraActor_Property_TYPE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PROJECTION_MODE = NDalicPINVOKE.CameraActor_Property_PROJECTION_MODE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FIELD_OF_VIEW = NDalicPINVOKE.CameraActor_Property_FIELD_OF_VIEW_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ASPECT_RATIO = NDalicPINVOKE.CameraActor_Property_ASPECT_RATIO_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int NEAR_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_NEAR_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FAR_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_FAR_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LEFT_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_LEFT_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int RIGHT_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_RIGHT_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TOP_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_TOP_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BOTTOM_PLANE_DISTANCE = NDalicPINVOKE.CameraActor_Property_BOTTOM_PLANE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TARGET_POSITION = NDalicPINVOKE.CameraActor_Property_TARGET_POSITION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PROJECTION_MATRIX = NDalicPINVOKE.CameraActor_Property_PROJECTION_MATRIX_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int VIEW_MATRIX = NDalicPINVOKE.CameraActor_Property_VIEW_MATRIX_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int INVERT_Y_AXIS = NDalicPINVOKE.CameraActor_Property_INVERT_Y_AXIS_get();
}
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public new static Camera DownCast(BaseHandle handle)
+ public static Camera DownCast(BaseHandle handle)
{
Camera ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Camera;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public CameraType GetType()
+ public new CameraType GetType()
{
CameraType ret = (CameraType)NDalicPINVOKE.CameraActor_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public virtual void SignalDisconnected(SlotObserver slotObserver, SWIGTYPE_p_Dali__CallbackBase callback)
+ public new virtual void SignalDisconnected(SlotObserver slotObserver, SWIGTYPE_p_Dali__CallbackBase callback)
{
NDalicPINVOKE.ConnectionTracker_SignalDisconnected(swigCPtr, SlotObserver.getCPtr(slotObserver), SWIGTYPE_p_Dali__CallbackBase.getCPtr(callback));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
+ /// <summary>
+ /// Called when a signal is connected.
+ /// </summary>
+ /// <param name="slotObserver">The slot observer i.e. a signal. Ownership is not passed</param>
+ /// <param name="callback">The call back. Ownership is not passed</param>
+ /// <since_tizen> 4 </since_tizen>
public virtual void SignalConnected(SlotObserver slotObserver, SWIGTYPE_p_CallbackBase callback)
{
NDalicPINVOKE.ConnectionTrackerInterface_SignalConnected(swigCPtr, SlotObserver.getCPtr(slotObserver), SWIGTYPE_p_CallbackBase.getCPtr(callback));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public new static CustomActor DownCast(BaseHandle handle)
+ public static CustomActor DownCast(BaseHandle handle)
{
CustomActor ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as CustomActor;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System.Reflection;
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2016 Samsung Electronics Co., Ltd.
+/*
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
/// <summary>
/// Enumeration for texture types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TextureType
{
- Texture2D = Tizen.NUI.TextureType.TEXTURE_2D, ///< One 2D image
- TextureCube = Tizen.NUI.TextureType.TEXTURE_CUBE ///< Six 2D images arranged in a cube-shape
+ /// <summary>
+ /// One 2D image
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ Texture2D = Tizen.NUI.TextureType.TEXTURE_2D,
+ /// <summary>
+ /// Six 2D images arranged in a cube-shape
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ TextureCube = Tizen.NUI.TextureType.TEXTURE_CUBE
}
/// <summary>
/// Enumeration for stereoscopic view modes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ViewMode
{
- Mono = Tizen.NUI.ViewMode.MONO, ///< Monoscopic (single camera). This is the default.
- StereoHorizontal = Tizen.NUI.ViewMode.STEREO_HORIZONTAL, ///< Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides.
- StereoVertical = Tizen.NUI.ViewMode.STEREO_VERTICAL, ///< Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom.
- StereoInterlaced = Tizen.NUI.ViewMode.STEREO_INTERLACED ///< Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames.
+ /// <summary>
+ /// Monoscopic (single camera). This is the default.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ Mono = Tizen.NUI.ViewMode.MONO,
+ /// <summary>
+ /// Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ StereoHorizontal = Tizen.NUI.ViewMode.STEREO_HORIZONTAL,
+ /// <summary>
+ /// Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ StereoVertical = Tizen.NUI.ViewMode.STEREO_VERTICAL,
+ /// <summary>
+ /// Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ StereoInterlaced = Tizen.NUI.ViewMode.STEREO_INTERLACED
}
+ /// <summary>
+ /// Enumeration for the direction
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct Direction
{
+ /// <summary>
+ /// Enumeration for the Direction types.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
+ /// <summary>
+ /// from Left to Right
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LeftToRight = Tizen.NUI.DirectionType.LEFT_TO_RIGHT,
+ /// <summary>
+ /// from Right to Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RightToLeft = Tizen.NUI.DirectionType.RIGHT_TO_LEFT
}
}
-
+ /// <summary>
+ /// ToolTip
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct Tooltip
{
+ /// <summary>
+ /// The properties used for a Tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct Property
{
+ /// <summary>
+ /// The content to display.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Content = NDalic.TOOLTIP_CONTENT;
+ /// <summary>
+ /// The layout of the content.
+ /// </summary>\
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Layout = NDalic.TOOLTIP_LAYOUT;
+ /// <summary>
+ /// Time to wait in seconds before a tooltip is shown while the is movement is within the allowed threshold.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WaitTime = NDalic.TOOLTIP_WAIT_TIME;
+ /// <summary>
+ /// The background of the tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Background = NDalic.TOOLTIP_BACKGROUND;
+ /// <summary>
+ /// The tail used by the tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Tail = NDalic.TOOLTIP_TAIL;
+ /// <summary>
+ /// The position of the tooltip in relation to the control.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Position = NDalic.TOOLTIP_POSITION;
+ /// <summary>
+ /// If Tooltip::Position::HOVER_POINT is used for the POSITION, then this is the offset the tooltip is displayed at from the hover point.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int HoverPointOffset = NDalic.TOOLTIP_HOVER_POINT_OFFSET;
+ /// <summary>
+ /// The movement threshold allowed before showing (or hiding a popup).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MovementThreshold = NDalic.TOOLTIP_MOVEMENT_THRESHOLD;
+ /// <summary>
+ /// If true, the tooltip will disappear after hover movement beyond a certain distance.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DisappearOnMovement = NDalic.TOOLTIP_DISAPPEAR_ON_MOVEMENT;
}
+ /// <summary>
+ /// Background Property
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct BackgroundProperty
{
+ /// <summary>
+ /// The image to use as the background.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Visual = NDalic.TOOLTIP_BACKGROUND_VISUAL;
+ /// <summary>
+ /// The size of the borders in the order: left, right, bottom, top.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Border = NDalic.TOOLTIP_BACKGROUND_BORDER;
}
+ /// <summary>
+ /// The properties of the tail used by the tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct TailProperty
{
+ /// <summary>
+ /// Whether to show the tail or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Visibility = NDalic.TOOLTIP_TAIL_VISIBILITY;
+ /// <summary>
+ /// The image used for the tail if it is above the tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int AboveVisual = NDalic.TOOLTIP_TAIL_ABOVE_VISUAL;
+ /// <summary>
+ /// The image used for the tail if it is below the tooltip.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BelowVisual = NDalic.TOOLTIP_TAIL_BELOW_VISUAL;
}
}
using System;
using System.Runtime.InteropServices;
+ /// <summary>
+ /// [UnmanagedFunctionPointer(CallingConvention.StdCall)]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
public delegate R DaliEventHandlerWithReturnType<T, U, R>(T source, U e);
+ /// <summary>
+ /// [UnmanagedFunctionPointer(CallingConvention.StdCall)]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
internal delegate void EventCallbackDelegateType0();
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
internal delegate void EventCallbackDelegateType1(IntPtr arg1);
-
- //this should be removed with EventHandler from .NET
+ /// <summary>
+ /// [UnmanagedFunctionPointer(CallingConvention.StdCall)]
+ /// this should be removed with EventHandler from .NET
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
public delegate void DaliEventHandler<T, U>(T source, U e);
+ /// <summary>
+ /// [UnmanagedFunctionPointer(CallingConvention.StdCall)]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
public delegate R EventHandlerWithReturnType<T, U, R>(T source, U e);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
protected bool swigCMemOwn;
+ /// <since_tizen> 3 </since_tizen>
public delegate void CallbackDelegate();
internal EventThreadCallback(global::System.IntPtr cPtr, bool cMemoryOwn)
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
base.Dispose(type);
}
+ /// <since_tizen> 3 </since_tizen>
public class Attachment
{
+ /// <since_tizen> 3 </since_tizen>
public enum Mask
{
NONE = 0,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
+ /// <since_tizen> 3 </since_tizen>
public class FinishedEventArgs : EventArgs
{
private GaussianBlurView _gaussianBlurView;
+ /// <since_tizen> 3 </since_tizen>
public GaussianBlurView GaussianBlurView
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
* @brief Event arguments that passed via Uploaded signal
*
*/
+ /// <since_tizen> 3 </since_tizen>
public class UploadedEventArgs : EventArgs
{
private Image _image;
* @brief Image - is the image data that gets uploaded to GL.
*
*/
+ /// <since_tizen> 3 </since_tizen>
public Image Image
{
get
/**
* @brief Event for Uploaded signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of UploadedEventHandler-DaliEventHandler<object,UploadedEventArgs>)
* provided by the user. Uploaded signal is emitted when the image data gets uploaded to GL.
*/
public event DaliEventHandler<object, UploadedEventArgs> Uploaded
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
internal class ImfEventSignalType : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal ImfEventSignalType(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~ImfEventSignalType()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// Queries whether there are any connected slots.
+ /// </summary>
+ /// <returns>True if there are any slots connected to the signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Empty()
{
bool ret = NDalicManualPINVOKE.ImfEventSignalType_Empty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Queries the number of slots.
+ /// </summary>
+ /// <returns>The number of slots connected to this signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetConnectionCount()
{
uint ret = NDalicManualPINVOKE.ImfEventSignalType_GetConnectionCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects a function.
+ /// </summary>
+ /// <param name="func">The function to connect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Connect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Disconnects a function.
+ /// </summary>
+ /// <param name="func">The function to disconnect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Disconnect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Emits the signal.
+ /// </summary>
+ /// <param name="arg1">The first value to pass to callbacks</param>
+ /// <param name="arg2">The second value to pass to callbacks</param>
+ /// <returns>The value returned by the last callback, or a default constructed value if no callbacks are connected</returns>
+ /// <since_tizen> 4 </since_tizen>
public ImfManager.ImfCallbackData Emit(ImfManager arg1, ImfManager.ImfEventData arg2)
{
ImfManager.ImfCallbackData ret = new ImfManager.ImfCallbackData(NDalicManualPINVOKE.ImfEventSignalType_Emit(swigCPtr, ImfManager.getCPtr(arg1), ImfManager.ImfEventData.getCPtr(arg2)), true);
return ret;
}
+ /// <summary>
+ /// The contructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImfEventSignalType() : this(NDalicManualPINVOKE.new_ImfEventSignalType(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
internal class ImfVoidSignalType : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal ImfVoidSignalType(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~ImfVoidSignalType()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// The contructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImfVoidSignalType() : this(NDalicManualPINVOKE.new_ImfVoidSignalType(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Queries whether there are any connected slots.
+ /// </summary>
+ /// <returns>True if there are any slots connected to the signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Empty()
{
bool ret = NDalicManualPINVOKE.ImfVoidSignalType_Empty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Queries the number of slots.
+ /// </summary>
+ /// <returns>The number of slots connected to this signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetConnectionCount()
{
uint ret = NDalicManualPINVOKE.ImfVoidSignalType_GetConnectionCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects a function.
+ /// </summary>
+ /// <param name="func">The function to connect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Connect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Disconnects a function.
+ /// </summary>
+ /// <param name="func">The function to disconnect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Disconnect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
}
-
+ /// <summary>
+ /// Connects a member function.
+ /// </summary>
+ /// <param name="connectionTracker">An object which must implement the ConnectionTrackerInterface</param>
+ /// <param name="arg1">The member function to connect</param>
+ /// <since_tizen> 4 </since_tizen>
public void Connect(ConnectionTrackerInterface connectionTracker, SWIGTYPE_p_Dali__FunctorDelegate arg1)
{
NDalicManualPINVOKE.ImfVoidSignalType_Connect__SWIG_4(swigCPtr, ConnectionTrackerInterface.getCPtr(connectionTracker), SWIGTYPE_p_Dali__FunctorDelegate.getCPtr(arg1));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Emits the signal.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Emit()
{
NDalicManualPINVOKE.ImfVoidSignalType_Emit(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return new ItemContainerEnumerator(this);
}
- // Type-safe enumerator
+ // The type-safe enumerator.
/// Note that the IEnumerator documentation requires an InvalidOperationException to be thrown
/// whenever the collection is modified. This has been done for changes in the size of the
- /// collection but not when one of the elements of the collection is modified as it is a bit
+ /// collection, but not when one of the elements of the collection is modified as it is a bit
/// tricky to detect unmanaged code that modifies the collection under our feet.
+ /// <since_tizen> 3 </since_tizen>
public sealed class ItemContainerEnumerator : global::System.Collections.IEnumerator
, global::System.Collections.Generic.IEnumerator<Item>
{
private object currentObject;
private int currentSize;
+ /// <since_tizen> 3 </since_tizen>
public ItemContainerEnumerator(ItemContainer collection)
{
collectionRef = collection;
}
// Type-safe iterator Current
+ /// <since_tizen> 3 </since_tizen>
public Item Current
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public bool MoveNext()
{
int size = collectionRef.Count;
return moveOkay;
}
+ /// <since_tizen> 3 </since_tizen>
public void Reset()
{
currentIndex = -1;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
currentIndex = -1;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System.Reflection;
ItemReleased(itemId, new View(actor, true));
}
+ /// <since_tizen> 3 </since_tizen>
public delegate uint SwigDelegateItemFactory_0();
+ /// <since_tizen> 3 </since_tizen>
public delegate global::System.IntPtr SwigDelegateItemFactory_1(uint itemId);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateItemFactory_2(uint itemId, global::System.IntPtr actor);
private SwigDelegateItemFactory_0 swigDelegate0;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return new ItemIdContainerEnumerator(this);
}
- // Type-safe enumerator
+ // The type-safe enumerator.
/// Note that the IEnumerator documentation requires an InvalidOperationException to be thrown
/// whenever the collection is modified. This has been done for changes in the size of the
- /// collection but not when one of the elements of the collection is modified as it is a bit
+ /// collection, but not when one of the elements of the collection is modified as it is a bit
/// tricky to detect unmanaged code that modifies the collection under our feet.
+ /// <since_tizen> 3 </since_tizen>
public sealed class ItemIdContainerEnumerator : global::System.Collections.IEnumerator
, global::System.Collections.Generic.IEnumerator<uint>
{
private object currentObject;
private int currentSize;
+ /// <since_tizen> 3 </since_tizen>
public ItemIdContainerEnumerator(ItemIdContainer collection)
{
collectionRef = collection;
}
// Type-safe iterator Current
+ /// <since_tizen> 3 </since_tizen>
public uint Current
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public bool MoveNext()
{
int size = collectionRef.Count;
return moveOkay;
}
+ /// <since_tizen> 3 </since_tizen>
public void Reset()
{
currentIndex = -1;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
currentIndex = -1;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
}
}
- public class Property
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property
{
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LAYOUT = NDalicManualPINVOKE.ItemView_Property_LAYOUT_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MINIMUM_SWIPE_SPEED = NDalicPINVOKE.ItemView_Property_MINIMUM_SWIPE_SPEED_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MINIMUM_SWIPE_DISTANCE = NDalicPINVOKE.ItemView_Property_MINIMUM_SWIPE_DISTANCE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WHEEL_SCROLL_DISTANCE_STEP = NDalicPINVOKE.ItemView_Property_WHEEL_SCROLL_DISTANCE_STEP_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SNAP_TO_ITEM_ENABLED = NDalicPINVOKE.ItemView_Property_SNAP_TO_ITEM_ENABLED_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int REFRESH_INTERVAL = NDalicPINVOKE.ItemView_Property_REFRESH_INTERVAL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LAYOUT_POSITION = NDalicPINVOKE.ItemView_Property_LAYOUT_POSITION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_SPEED = NDalicPINVOKE.ItemView_Property_SCROLL_SPEED_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT = NDalicPINVOKE.ItemView_Property_OVERSHOOT_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_DIRECTION = NDalicPINVOKE.ItemView_Property_SCROLL_DIRECTION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LAYOUT_ORIENTATION = NDalicPINVOKE.ItemView_Property_LAYOUT_ORIENTATION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_CONTENT_SIZE = NDalicPINVOKE.ItemView_Property_SCROLL_CONTENT_SIZE_get();
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// KeyboardTypeSignalType
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class KeyboardTypeSignalType : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool swigCMemOwn;
internal KeyboardTypeSignalType(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~KeyboardTypeSignalType()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// Queries whether there are any connected slots.
+ /// </summary>
+ /// <returns>True if there are any slots connected to the signal</returns>
+ /// <since_tizen> 4 </since_tizen>
public bool Empty()
{
bool ret = NDalicManualPINVOKE.KeyboardTypeSignalType_Empty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Queries the number of slots.
+ /// </summary>
+ /// <returns>The number of slots connected to this signal</returns>
+ /// <since_tizen> 4 </since_tizen>
public uint GetConnectionCount()
{
uint ret = NDalicManualPINVOKE.KeyboardTypeSignalType_GetConnectionCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects a function.
+ /// </summary>
+ /// <param name="func">The function to connect</param>
+ /// <since_tizen> 4 </since_tizen>
public void Connect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Disconnects a function.
+ /// </summary>
+ /// <param name="func">The function to disconnect</param>
+ /// <since_tizen> 4 </since_tizen>
public void Disconnect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Connects a member function.
+ /// </summary>
+ /// <param name="arg">The member function to connect</param>
+ /// <since_tizen> 4 </since_tizen>
public void Emit(ImfManager.KeyboardType arg)
{
NDalicManualPINVOKE.KeyboardTypeSignalType_Emit(swigCPtr, (int)arg);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// The contructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public KeyboardTypeSignalType() : this(NDalicManualPINVOKE.new_KeyboardTypeSignalType(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
base.Dispose(type);
}
+ /// <since_tizen> 3 </since_tizen>
public class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- internal new static LinearConstrainer DownCast(BaseHandle handle)
+ internal static LinearConstrainer DownCast(BaseHandle handle)
{
LinearConstrainer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as LinearConstrainer;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
}
+ /// <since_tizen> 3 </since_tizen>
public class DetectedEventArgs : EventArgs
{
private View _view;
private LongPressGesture _longPressGesture;
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public LongPressGesture LongPressGesture
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
base.Dispose(type);
}
- public class Property : global::System.IDisposable
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_Model3dView_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public static readonly int GEOMETRY_URL = NDalicPINVOKE.Model3dView_Property_GEOMETRY_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MATERIAL_URL = NDalicPINVOKE.Model3dView_Property_MATERIAL_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int IMAGES_URL = NDalicPINVOKE.Model3dView_Property_IMAGES_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ILLUMINATION_TYPE = NDalicPINVOKE.Model3dView_Property_ILLUMINATION_TYPE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TEXTURE0_URL = NDalicPINVOKE.Model3dView_Property_TEXTURE0_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TEXTURE1_URL = NDalicPINVOKE.Model3dView_Property_TEXTURE1_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TEXTURE2_URL = NDalicPINVOKE.Model3dView_Property_TEXTURE2_URL_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LIGHT_POSITION = NDalicPINVOKE.Model3dView_Property_LIGHT_POSITION_get();
}
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum IluminationTypeEnum
{
DIFFUSE,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI {
protected class SWIGExceptionHelper {
+ /// <since_tizen> 3 </since_tizen>
public delegate void ExceptionDelegate(string message);
+ /// <since_tizen> 3 </since_tizen>
public delegate void ExceptionArgumentDelegate(string message, string paramName);
static ExceptionDelegate applicationDelegate = new ExceptionDelegate(SetPendingApplicationException);
protected static SWIGExceptionHelper swigExceptionHelper = new SWIGExceptionHelper();
+ /// <since_tizen> 3 </since_tizen>
public class SWIGPendingException {
[global::System.ThreadStatic]
private static global::System.Exception pendingException = null;
private static int numExceptionsPending = 0;
+ /// <since_tizen> 3 </since_tizen>
public static bool Pending {
get {
bool pending = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public static void Set(global::System.Exception e) {
if (pendingException != null)
throw new global::System.ApplicationException("FATAL: An earlier pending exception from unmanaged code was missed and thus not thrown (" + pendingException.ToString() + ")", e);
}
}
+ /// <since_tizen> 3 </since_tizen>
public static global::System.Exception Retrieve() {
global::System.Exception e = null;
if (numExceptionsPending > 0) {
protected class SWIGStringHelper {
+ /// <since_tizen> 3 </since_tizen>
public delegate string SWIGStringDelegate(string message);
static SWIGStringDelegate stringDelegate = new SWIGStringDelegate(CreateString);
class NUICoreBackend : ICoreBackend
{
/// <summary>
- /// Application instance to connect event.
+ /// The Application instance to connect event.
/// </summary>
protected Application _application;
/// <summary>
- /// Dictionary to contain each type of event callback.
+ /// The Dictionary to contain each type of event callback.
/// </summary>
protected IDictionary<EventType, object> Handlers = new Dictionary<EventType, object>();
}
/// <summary>
- /// Add NUIApplication event to Application.
- /// Put each type of event callback in Dictionary.
+ /// Adds NUIApplication event to Application.
+ /// Puts each type of event callback in Dictionary.
/// </summary>
- /// <param name="evType">Type of event</param>
- /// <param name="handler">Event callback</param>
+ /// <param name="evType">The type of event.</param>
+ /// <param name="handler">The event callback.</param>
public void AddEventHandler(EventType evType, Action handler)
{
Handlers.Add(evType, handler);
}
/// <summary>
- /// Add NUIApplication event to Application.
- /// Put each type of event callback in Dictionary.
+ /// Adds NUIApplication event to Application.
+ /// Puts each type of event callback in Dictionary.
/// </summary>
- /// <typeparam name="TEventArgs">Argument type for the event</typeparam>
- /// <param name="evType">Type of event</param>
- /// <param name="handler">Event callback</param>
+ /// <typeparam name="TEventArgs">The argument type for the event.</typeparam>
+ /// <param name="evType">The type of event.</param>
+ /// <param name="handler">The event callback.</param>
public void AddEventHandler<TEventArgs>(EventType evType, Action<TEventArgs> handler) where TEventArgs : EventArgs
{
Handlers.Add(evType, handler);
/// <summary>
- /// Dispose function.
+ /// The Dispose function.
/// </summary>
public void Dispose()
{
}
/// <summary>
- /// Exit Application.
+ /// The Exit application.
/// </summary>
public void Exit()
{
}
/// <summary>
- /// Run Application.
+ /// The Run application.
/// </summary>
- /// <param name="args">Arguments from commandline.</param>
+ /// <param name="args">The arguments from commandline.</param>
public void Run(string[] args)
{
_application.BatteryLow += OnBatteryLow;
}
/// <summary>
- /// Region changed event callback function.
+ /// The Region changed event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for RegionChanged</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for RegionChanged.</param>
private void OnRegionChanged(object source, NUIApplicationRegionChangedEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnRegionChanged Called");
}
/// <summary>
- /// Memory Low event callback function.
+ /// The Memory Low event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for MemoryLow</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for MemoryLow.</param>
private void OnMemoryLow(object source, NUIApplicationMemoryLowEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnMemoryLow Called");
}
/// <summary>
- /// Language changed event callback function.
+ /// The Language changed event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for LanguageChanged</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for LanguageChanged.</param>
private void OnLanguageChanged(object source, NUIApplicationLanguageChangedEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnLanguageChanged Called");
}
/// <summary>
- /// Battery low event callback function.
+ /// The Battery Low event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for BatteryLow</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for BatteryLow.</param>
private void OnBatteryLow(object source, NUIApplicationBatteryLowEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnBatteryLow Called");
}
/// <summary>
- /// Initialized event callback function.
+ /// The Initialized event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for Initialized</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for Initialized.</param>
private void OnInitialized(object source, NUIApplicationInitEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnInitialized Called");
}
/// <summary>
- /// Terminated event callback function.
+ /// The Terminated event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for Terminated</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for Terminated.</param>
private void OnTerminated(object source, NUIApplicationTerminatingEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnTerminated Called");
}
/// <summary>
- /// Resumed event callback function.
+ /// The Resumed event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for Resumed</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for Resumed.</param>
private void OnResumed(object source, NUIApplicationResumedEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnResumed Called");
}
/// <summary>
- /// App control event callback function.
+ /// The App control event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for AppControl</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for AppControl.</param>
private void OnAppControl(object source, NUIApplicationAppControlEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnAppControl Called");
}
/// <summary>
- /// Paused event callback function.
+ /// The Paused event callback function.
/// </summary>
- /// <param name="source">Application instance</param>
- /// <param name="e">Event argument for Paused</param>
+ /// <param name="source">The application instance.</param>
+ /// <param name="e">The event argument for Paused.</param>
private void OnPaused(object source, NUIApplicationPausedEventArgs e)
{
Log.Debug("NUI", "NUICorebackend OnPaused Called");
-/* Copyright(c) 2017 Samsung Electronics Co., Ltd.
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
/// <summary>
/// Class that represents the type of NUI event for backends. This class can be converted from string type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NUIEventType : EventType
{
/// <summary>
/// Initializes the EventType class.
/// </summary>
/// <param name="name">The name of event type.</param>
+ /// <since_tizen> 4 </since_tizen>
public NUIEventType(string name) : base(name)
{
}
/// <summary>
/// Pre-defined event type. "TimeTick"
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly NUIEventType TimeTick = "TimeTick";
/// <summary>
/// Pre-defined event type. "AmbientTick"
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly NUIEventType AmbientTick = "AmbientTick";
/// <summary>
/// Pre-defined event type. "AmbientChanged"
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly NUIEventType AmbientChanged = "AmbientChanged";
/// <summary>
/// Converts a string to NUIEventType instance.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static implicit operator NUIEventType(string value)
{
return new NUIEventType(value);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
-
-/**
- * Static Helper class for Property
- * Internal
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
*/
+
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// Static Helper class for Property
+ /// Internal
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
internal static class Object
{
public static PropertyValue GetProperty(global::System.Runtime.InteropServices.HandleRef handle, int index)
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
}
+ /// <since_tizen> 3 </since_tizen>
public class ObjectCreatedEventArgs : EventArgs
{
private BaseHandle _baseHandle;
+ /// <since_tizen> 3 </since_tizen>
public BaseHandle BaseHandle
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public class ObjectDestroyedEventArgs : EventArgs
{
private RefObject _refObject;
+ /// <since_tizen> 3 </since_tizen>
public RefObject RefObject
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <since_tizen> 3 </since_tizen>
public class PagePanStartedEventArgs : EventArgs
{
private PageTurnView _pageTurnView;
+ /// <since_tizen> 3 </since_tizen>
public PageTurnView PageTurnView
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public class PagePanFinishedEventArgs : EventArgs
{
private PageTurnView _pageTurnView;
+ /// <since_tizen> 3 </since_tizen>
public PageTurnView PageTurnView
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public class PageTurnStartedEventArgs : EventArgs
{
private PageTurnView _pageTurnView;
private uint _pageIndex;
private bool _isTurningForward;
+ /// <since_tizen> 3 </since_tizen>
public PageTurnView PageTurnView
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public uint PageIndex
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public bool IsTurningForward
{
get
}
+ /// <since_tizen> 3 </since_tizen>
public class PageTurnFinishedEventArgs : EventArgs
{
private PageTurnView _pageTurnView;
private uint _pageIndex;
private bool _isTurningForward;
+ /// <since_tizen> 3 </since_tizen>
public PageTurnView PageTurnView
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public uint PageIndex
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public bool IsTurningForward
{
get
}
- public class Property : global::System.IDisposable
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_PageTurnView_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PAGE_SIZE = NDalicPINVOKE.PageTurnView_Property_PAGE_SIZE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int CURRENT_PAGE_ID = NDalicPINVOKE.PageTurnView_Property_CURRENT_PAGE_ID_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SPINE_SHADOW = NDalicPINVOKE.PageTurnView_Property_SPINE_SHADOW_get();
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <since_tizen> 3 </since_tizen>
public class DetectedEventArgs : EventArgs
{
private View _view;
private PanGesture _panGesture;
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public PanGesture PanGesture
{
get
}
+ /// <since_tizen> 3 </since_tizen>
public class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_PanGestureDetector_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCREEN_POSITION = NDalicPINVOKE.PanGestureDetector_Property_SCREEN_POSITION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCREEN_DISPLACEMENT = NDalicPINVOKE.PanGestureDetector_Property_SCREEN_DISPLACEMENT_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCREEN_VELOCITY = NDalicPINVOKE.PanGestureDetector_Property_SCREEN_VELOCITY_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LOCAL_POSITION = NDalicPINVOKE.PanGestureDetector_Property_LOCAL_POSITION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LOCAL_DISPLACEMENT = NDalicPINVOKE.PanGestureDetector_Property_LOCAL_DISPLACEMENT_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LOCAL_VELOCITY = NDalicPINVOKE.PanGestureDetector_Property_LOCAL_VELOCITY_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PANNING = NDalicPINVOKE.PanGestureDetector_Property_PANNING_get();
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <since_tizen> 3 </since_tizen>
public class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_PathConstrainer_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public new static PathConstrainer DownCast(BaseHandle handle)
+ public static PathConstrainer DownCast(BaseHandle handle)
{
PathConstrainer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as PathConstrainer;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
}
+ /// <since_tizen> 3 </since_tizen>
public class DetectedEventArgs : EventArgs
{
private View _view;
private PinchGesture _pinchGesture;
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public PinchGesture PinchGesture
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
namespace Tizen.NUI
{
/// <summary>
- /// Helper class for calculating what property indexes should be assigned to C# View (view) classes.
+ /// The helper class for calculating what property indexes should be assigned to the C# View (view) classes.
/// </summary>
internal class PropertyRangeManager
{
}
/// <summary>
- /// Only called if a View has scriptable properties
+ /// Only called if a view has scriptable properties.
/// </summary>
private PropertyRange RegisterView(string viewName, System.Type viewType)
{
/// <summary>
/// Gets the index of the property.
- /// Each property has to have unique index for this view type
+ /// Each property has to have unique index for this view type.
/// </summary>
/// <returns>The property index.</returns>
- /// <param name="viewName">View name</param>
- /// <param name="viewType">View type</param>
+ /// <param name="viewName">The view name.</param>
+ /// <param name="viewType">The view type.</param>
/// <param name="type">Type.</param>
public int GetPropertyIndex(string viewName, System.Type viewType, ScriptableProperty.ScriptableType type)
{
}
///<summary>
- /// We calculate the start property indices, based on the type and it's class heirachy, e.g. DateView (70,000)- > Spin (60,000) -> View (50,000)
+ /// We calculate the start property indices, based on the type and it's class hierarchy, for example, DateView (70,000)- > Spin (60,000) -> View (50,000).
/// </summary>
private void GetPropertyStartRange(System.Type viewType, ref PropertyRange range)
{
}
+ /// <since_tizen> 3 </since_tizen>
public struct PropertyRange
{
+ /// <since_tizen> 3 </since_tizen>
public int GetNextFreePropertyIndex(ScriptableProperty.ScriptableType type)
{
if (type == ScriptableProperty.ScriptableType.Default)
}
- public int startEventIndex; /// start of the property range
- public int lastUsedEventIndex; /// last used of the property index
+ /// <since_tizen> 3 </since_tizen>
+ public int startEventIndex; // start of the property range
+ /// <since_tizen> 3 </since_tizen>
+ public int lastUsedEventIndex; // last used of the property index
- public int startAnimationIndex; /// start of the property range
- public int lastUsedAnimationIndex; /// last used of the property index
+ /// <since_tizen> 3 </since_tizen>
+ public int startAnimationIndex; // start of the property range
+ /// <since_tizen> 3 </since_tizen>
+ public int lastUsedAnimationIndex; // last used of the property index
};
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
internal sealed class Registry
{
/// <summary>
- /// Registry is a singleton
+ /// The registry is a singleton.
/// </summary>
private static Registry instance = null;
/// <summary>
- /// Given a C++ object the dictionary allows us to find which C# object it belongs to.
+ /// Given a C++ object, the dictionary allows us to find which C# object it belongs to.
/// By keeping the weak reference only, it will allow the object to be garbage collected.
/// </summary>
private Dictionary<IntPtr, WeakReference> _controlMap;
/// <summary>
- /// Store the mapping between this instance of BaseHandle (C# base class) and native part.
+ /// Stores the mapping between this instance of BaseHandle (C# base class) and native part.
/// </summary>
- /// <param name="baseHandle"> The instance of BaseHandle (C# base class)</param>
+ /// <param name="baseHandle">The instance of BaseHandle (C# base class).</param>
internal static void Register(BaseHandle baseHandle)
{
// We store a pointer to the RefObject for the control
RefObject refObj = baseHandle.GetObjectPtr();
IntPtr refCptr = (IntPtr)RefObject.getCPtr(refObj);
- NUILog.Debug("________Storing ref object cptr in control map Hex: {0:X}" + refCptr);
+ NUILog.Debug("Storing ref object cptr in control map Hex: {0:X}" + refCptr);
if (!Instance._controlMap.ContainsKey(refCptr))
{
}
/// <summary>
- /// Remove the this instance of BaseHandle (C# base class) and native part from the mapping table.
+ /// Removes this instance of BaseHandle (C# base class) and native part from the mapping table.
/// </summary>
- /// <param name="view"> The instance of BaseHandle (C# base class)</param>
+ /// <param name="baseHandle"> The instance of BaseHandle (C# base class)</param>
internal static void Unregister(BaseHandle baseHandle)
{
RefObject refObj = baseHandle.GetObjectPtr();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <since_tizen> 3 </since_tizen>
public Property() : this(NDalicPINVOKE.new_RenderTask_Property(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public static readonly int VIEWPORT_POSITION = NDalicPINVOKE.RenderTask_Property_VIEWPORT_POSITION_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int VIEWPORT_SIZE = NDalicPINVOKE.RenderTask_Property_VIEWPORT_SIZE_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int CLEAR_COLOR = NDalicPINVOKE.RenderTask_Property_CLEAR_COLOR_get();
+ /// <since_tizen> 3 </since_tizen>
public static readonly int REQUIRES_SYNC = NDalicPINVOKE.RenderTask_Property_REQUIRES_SYNC_get();
}
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public new static RenderTask DownCast(BaseHandle handle)
+ public static RenderTask DownCast(BaseHandle handle)
{
RenderTask ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as RenderTask;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum RefreshRate
{
REFRESH_ONCE = 0,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return ret;
}
- public Ruler.RulerType GetType()
+ public new Ruler.RulerType GetType()
{
Ruler.RulerType ret = (Ruler.RulerType)NDalicPINVOKE.Ruler_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public enum RulerType
{
Fixed,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return ret;
}
- public Ruler.RulerType GetType()
+ public new Ruler.RulerType GetType()
{
Ruler.RulerType ret = (Ruler.RulerType)NDalicPINVOKE.RulerPtr_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
}
+ /// <summary>
+ /// The Constructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected SWIGTYPE_p_CallbackBase()
{
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
}
+ /// <summary>
+ /// The Constructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected SWIGTYPE_p_Dali__CallbackBase()
{
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
}
+ /// <summary>
+ /// The Constructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected SWIGTYPE_p_Dali__FunctorDelegate()
{
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
internal class SignalObserver : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool swigCMemOwn;
internal SignalObserver(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~SignalObserver()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// This method is called when the signal is disconnecting.
+ /// </summary>
+ /// <param name="slotObserver">The signal that has disconnected</param>
+ /// <param name="callback">The callback attached to the signal disconnected</param>
+ /// <since_tizen> 4 </since_tizen>
public virtual void SignalDisconnected(SlotObserver slotObserver, SWIGTYPE_p_Dali__CallbackBase callback)
{
NDalicPINVOKE.SignalObserver_SignalDisconnected(swigCPtr, SlotObserver.getCPtr(slotObserver), SWIGTYPE_p_Dali__CallbackBase.getCPtr(callback));
*/
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
- [Obsolete("Please do not use! This will be changed to internal class")]
+ // Please do not use! This will be changed to internal class.
+ /// <summary>
+ /// A three-dimensional size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use Size2D instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class Size : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>swigCMemOwn.</summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Size(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
~Size()
{
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator for A+B
+ /// The addition operator for A+B.
/// </summary>
- /// <param name="arg1">Size, A</param>
- /// <param name="arg2">Size to assign, B</param>
- /// <returns>A Size containing the result of the addition</returns>
+ /// <param name="arg1">Size to assign A.</param>
+ /// <param name="arg2">Size to assign B.</param>
+ /// <returns>A size containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator +(Size arg1, Size arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator for A-B
+ /// The subtraction operator for A-B.
/// </summary>
- /// <param name="arg1">Size, A</param>
- /// <param name="arg2">Size to subtract, B</param>
- /// <returns>A Size containing the result of the subtraction</returns>
+ /// <param name="arg1">Size to subtract A.</param>
+ /// <param name="arg2">Size to subtract B.</param>
+ /// <returns>The size containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator -(Size arg1, Size arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Size for unary negation</param>
- /// <returns>A Size containg the negation</returns>
+ /// <param name="arg1">Size for unary negation.</param>
+ /// <returns>A size containing the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator -(Size arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Size for multiplication</param>
- /// <param name="arg2">The Size to multipl</param>
- /// <returns>A Size containing the result of the multiplication</returns>
+ /// <param name="arg1">Size for multiplication.</param>
+ /// <param name="arg2">The size to multiply.</param>
+ /// <returns>A size containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator *(Size arg1, Size arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Size for multiplication</param>
- /// <param name="arg2">The float value to scale the Size</param>
- /// <returns>A Size containing the result of the scaling</returns>
+ /// <param name="arg1">Size for multiplication.</param>
+ /// <param name="arg2">The float value to scale the size.</param>
+ /// <returns>A size containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator *(Size arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Size for division</param>
- /// <param name="arg2">The Size to divide</param>
- /// <returns>A Size containing the result of the division></returns>
+ /// <param name="arg1">Size for division.</param>
+ /// <param name="arg2">The size to divide.</param>
+ /// <returns>A size containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator /(Size arg1, Size arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Size for division</param>
- /// <param name="arg2">The float value to scale the Size by</param>
- /// <returns>A Size containing the result of the scaling</returns>
+ /// <param name="arg1">Size for division.</param>
+ /// <param name="arg2">The float value to scale the size by.</param>
+ /// <returns>A Size containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size operator /(Size arg1, float arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator.
+ /// The array subscript operator.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">Subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="x">x (or width) component</param>
- /// <param name="y">y (or height) component</param>
- /// <param name="z">z (or depth) component</param>
+ /// <param name="x">The x (or width) component.</param>
+ /// <param name="y">The y (or height) component.</param>
+ /// <param name="z">The z (or depth) component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Size(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="size2d">Size2D with x (width) and y (height)</param>
+ /// <param name="size2d">Size2D with x (width) and y (height).</param>
+ /// <since_tizen> 3 </since_tizen>
public Size(Size2D size2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Size2D.getCPtr(size2d)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Zero constant, (0.0f, 0.0f, 0.0f).
+ /// The Zero constant, (0.0f, 0.0f, 0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Size Zero
{
get
}
/// <summary>
- /// Check equality.<br>
- /// Utilizes appropriate machine epsilon values.<br>
+ /// Checks equality.<br />
+ /// Utilizes appropriate machine epsilon values.<br />
/// </summary>
- /// <param name="rhs">The Size to test against</param>
- /// <returns>True if the Sizes are equal</returns>
+ /// <param name="rhs">The size to test against.</param>
+ /// <returns>True if the sizes are equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Size rhs)
{
bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Size.getCPtr(rhs));
}
/// <summary>
- /// Check inequality.<br>
- /// Utilizes appropriate machine epsilon values.<br>
+ /// Checks inequality.<br />
+ /// Utilizes appropriate machine epsilon values.<br />
/// </summary>
- /// <param name="rhs">The Size to test against</param>
- /// <returns>True if the Sizes are not equal</returns>
+ /// <param name="rhs">The size to test against.</param>
+ /// <returns>True if the sizes are not equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Size rhs)
{
bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Size.getCPtr(rhs));
}
/// <summary>
- /// Width property for width component of Siz
+ /// The Width property for the width component of size
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Width
{
set
}
/// <summary>
- /// Height property for height component of Size
+ /// The Height property for the height component of size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Height
{
set
}
/// <summary>
- /// Depth property for depth component of Size
+ /// The Depth property for the depth component of size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Depth
{
set
}
/// <summary>
- /// Type cast operator, Size to Vector3.
+ /// The type cast operator, Size to Vector3.
/// </summary>
- /// <param name="size">Object of Size type</param>
+ /// <param name="size">The object of size type.</param>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector3(Size size)
{
return new Vector3(size.Width, size.Height, size.Depth);
}
/// <summary>
- /// Type cast operator, Vector3 to Size type.
+ /// The type cast operator, Vector3 to Size type.
/// </summary>
- /// <param name="vec">Object of Vector3 type</param>
+ /// <param name="vec">The object of Vector3 type.</param>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Size(Vector3 vec)
{
return new Size(vec.Width, vec.Height, vec.Depth);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
internal class SlotObserver : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>swigCMemOwn.</summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool swigCMemOwn;
internal SlotObserver(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~SlotObserver()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
-
+ /// <summary>
+ /// This method is called when the slot is disconnecting.
+ /// </summary>
+ /// <param name="callback">The callback attached to the signal disconnected.</param>
+ /// <since_tizen> 4 </since_tizen>
public virtual void SlotDisconnected(SWIGTYPE_p_Dali__CallbackBase callback)
{
NDalicPINVOKE.SlotObserver_SlotDisconnected(swigCPtr, SWIGTYPE_p_Dali__CallbackBase.getCPtr(callback));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
internal class StatusSignalType : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal StatusSignalType(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~StatusSignalType()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// Queries whether there are any connected slots.
+ /// </summary>
+ /// <returns>True if there are any slots connected to the signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Empty()
{
bool ret = NDalicManualPINVOKE.StatusSignalType_Empty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Queries the number of slots.
+ /// </summary>
+ /// <returns>The number of slots connected to this signal</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetConnectionCount()
{
uint ret = NDalicManualPINVOKE.StatusSignalType_GetConnectionCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects a function.
+ /// </summary>
+ /// <param name="func">The function to connect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Connect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Disconnects a function.
+ /// </summary>
+ /// <param name="func">The function to disconnect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Disconnect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Connects a member function.
+ /// </summary>
+ /// <param name="arg">The member function to connect</param>
+ /// <since_tizen> 3 </since_tizen>
public void Emit(bool arg)
{
NDalicManualPINVOKE.StatusSignalType_Emit(swigCPtr, arg);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// The constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public StatusSignalType() : this(NDalicManualPINVOKE.new_StatusSignalType(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
}
+ /// <since_tizen> 3 </since_tizen>
public class DetectedEventArgs : EventArgs
{
private View _view;
private TapGesture _tapGesture;
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public TapGesture TapGesture
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
}
}
+ /// <since_tizen> 3 </since_tizen>
public enum StateType
{
Started,
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
return new TouchPointContainerEnumerator(this);
}
- // Type-safe enumerator
+ // The type-safe enumerator.
/// Note that the IEnumerator documentation requires an InvalidOperationException to be thrown
/// whenever the collection is modified. This has been done for changes in the size of the
- /// collection but not when one of the elements of the collection is modified as it is a bit
+ /// collection, but not when one of the elements of the collection is modified as it is a bit
/// tricky to detect unmanaged code that modifies the collection under our feet.
+ /// <since_tizen> 3 </since_tizen>
public sealed class TouchPointContainerEnumerator : global::System.Collections.IEnumerator
, global::System.Collections.Generic.IEnumerator<TouchPoint>
{
private object currentObject;
private int currentSize;
+ /// <since_tizen> 3 </since_tizen>
public TouchPointContainerEnumerator(TouchPointContainer collection)
{
collectionRef = collection;
}
// Type-safe iterator Current
+ /// <since_tizen> 3 </since_tizen>
public TouchPoint Current
{
get
}
}
+ /// <since_tizen> 3 </since_tizen>
public bool MoveNext()
{
int size = collectionRef.Count;
return moveOkay;
}
+ /// <since_tizen> 3 </since_tizen>
public void Reset()
{
currentIndex = -1;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
currentIndex = -1;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// An enum of Device Class types.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
+ /// <summary>
+ /// Not a device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NONE,
+ /// <summary>
+ /// The user/seat (the user themselves).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
USER,
+ /// <summary>
+ /// A regular keyboard, numberpad or attached buttons.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
KEYBOARD,
+ /// <summary>
+ /// A mouse, trackball or touchpad relative motion device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
MOUSE,
+ /// <summary>
+ /// A touchscreen with fingers or stylus.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TOUCH,
+ /// <summary>
+ /// A special pen device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PEN,
+ /// <summary>
+ /// A pointing device based on laser, infrared or similar technology.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
POINTER,
+ /// <summary>
+ /// A gamepad controller or joystick.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
GAMEPAD
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
internal class Uint16Pair : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>swigCMemOwn.</summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Uint16Pair(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Uint16Pair()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
-
+ /// <summary>
+ /// Less than comparison operator for storing in collections (not geometrically meaningful).
+ /// </summary>
+ /// <param name="arg1">A reference for comparison.</param>
+ /// <param name="arg2">A reference for comparison</param>
+ /// <return>True if arg1 less than arg2</return>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator <(Uint16Pair arg1, Uint16Pair arg2)
{
return arg1.LessThan(arg2);
}
+ /// <summary>
+ /// More than comparison operator for storing in collections (not geometrically meaningful).
+ /// </summary>
+ /// <param name="arg1">A reference for comparison.</param>
+ /// <param name="arg2">A reference for comparison</param>
+ /// <return>True if arg1 > arg2</return>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator >(Uint16Pair arg1, Uint16Pair arg2)
{
return arg1.GreaterThan(arg2);
}
+ /// <summary>
+ /// Default constructor for the(0, 0) tuple.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair() : this(NDalicPINVOKE.new_Uint16Pair__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Default constructor for the(0, 0) tuple.
+ /// </summary>
+ /// <param name="width">The width or X dimension of the tuple. Make sure it is less than 65536.</param>
+ /// <param name="height">The height or Y dimension of the tuple.Make sure it is less than 65536.</param>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair(uint width, uint height) : this(NDalicPINVOKE.new_Uint16Pair__SWIG_1(width, height), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Constructor taking separate x and y (width and height) parameters.
+ /// </summary>
+ /// <param name="rhs">A reference to assign.</param>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair(Uint16Pair rhs) : this(NDalicPINVOKE.new_Uint16Pair__SWIG_2(Uint16Pair.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the width.
+ /// </summary>
+ /// <param name="width">The x dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWidth(ushort width)
{
NDalicPINVOKE.Uint16Pair_SetWidth(swigCPtr, width);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the width.
+ /// </summary>
+ /// <return>
+ /// The x dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetWidth()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetWidth(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the height.
+ /// </summary>
+ /// <param name="height">The y dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetHeight(ushort height)
{
NDalicPINVOKE.Uint16Pair_SetHeight(swigCPtr, height);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the height.
+ /// </summary>
+ /// <return>
+ /// The y dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetHeight()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetHeight(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the x dimension.
+ /// </summary>
+ /// <param name="x">The x dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetX(ushort x)
{
NDalicPINVOKE.Uint16Pair_SetX(swigCPtr, x);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the x dimension.
+ /// </summary>
+ /// <return>
+ /// The x dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetX()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetX(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the y dimension.
+ /// </summary>
+ /// <param name="y">The y dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetY(ushort y)
{
NDalicPINVOKE.Uint16Pair_SetY(swigCPtr, y);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the y dimension.
+ /// </summary>
+ /// <return>
+ /// The y dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetY()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetY(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Constructor taking separate x and y (width and height) parameters.
+ /// </summary>
+ /// <param name="rhs">A reference to assign.</param>
+ /// <return>The created object.</return>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair Assign(Uint16Pair rhs)
{
Uint16Pair ret = new Uint16Pair(NDalicPINVOKE.Uint16Pair_Assign(swigCPtr, Uint16Pair.getCPtr(rhs)), false);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System.Reflection;
using Tizen.NUI.BaseComponents;
SignalDisconnected((slotObserver == global::System.IntPtr.Zero) ? null : new SlotObserver(slotObserver, false), (callback == global::System.IntPtr.Zero) ? null : new SWIGTYPE_p_Dali__CallbackBase(callback, false));
}
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_0(int depth);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_1();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_2(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_3(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_4(int index, global::System.IntPtr propertyValue);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_5(global::System.IntPtr targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_6(global::System.IntPtr animation, global::System.IntPtr targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_7(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_8(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_9(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_10(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_11(global::System.IntPtr size, global::System.IntPtr container);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_12(int policy, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate global::System.IntPtr SwigDelegateViewImpl_13();
+ /// <since_tizen> 3 </since_tizen>
public delegate float SwigDelegateViewImpl_14(global::System.IntPtr child, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate float SwigDelegateViewImpl_15(float width);
+ /// <since_tizen> 3 </since_tizen>
public delegate float SwigDelegateViewImpl_16(float height);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_17(int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_18();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_19(int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_20(float size, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_21();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_22(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_23(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_24(global::System.IntPtr styleManager, int change);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_25();
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_26(global::System.IntPtr gesture);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_27(global::System.IntPtr touchEvent);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_28(bool isIncrease);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_29();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_30();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_31();
+ /// <since_tizen> 3 </since_tizen>
public delegate global::System.IntPtr SwigDelegateViewImpl_32(global::System.IntPtr currentFocusedActor, int direction, bool loopEnabled);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_33(global::System.IntPtr commitedFocusableActor);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool SwigDelegateViewImpl_34();
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_35(global::System.IntPtr pinch);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_36(global::System.IntPtr pan);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_37(global::System.IntPtr tap);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_38(global::System.IntPtr longPress);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_39(global::System.IntPtr slotObserver, global::System.IntPtr callback);
+ /// <since_tizen> 3 </since_tizen>
public delegate void SwigDelegateViewImpl_40(global::System.IntPtr slotObserver, global::System.IntPtr callback);
private SwigDelegateViewImpl_0 swigDelegate0;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
namespace Tizen.NUI
internal sealed class ViewWrapperImpl : ViewImpl
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnStageConnectionDelegate(int depth);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnStageDisconnectionDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnChildAddDelegate(View view);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnChildRemoveDelegate(View view);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnPropertySetDelegate(int index, PropertyValue propertyValue);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnSizeSetDelegate(Vector3 targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnSizeAnimationDelegate(Animation animation, Vector3 targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnTouchDelegate(Touch touch);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnHoverDelegate(Hover hover);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnKeyDelegate(Key key);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnWheelDelegate(Wheel wheel);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnRelayoutDelegate(Vector2 size, RelayoutContainer container);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnSetResizePolicyDelegate(ResizePolicyType policy, DimensionType dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate Size2D GetNaturalSizeDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate float CalculateChildSizeDelegate(View child, DimensionType dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate float GetHeightForWidthDelegate(float width);
+ /// <since_tizen> 3 </since_tizen>
public delegate float GetWidthForHeightDelegate(float height);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool RelayoutDependentOnChildrenDimensionDelegate(DimensionType dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool RelayoutDependentOnChildrenDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnCalculateRelayoutSizeDelegate(DimensionType dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnLayoutNegotiatedDelegate(float size, DimensionType dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnControlChildAddDelegate(View child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnControlChildRemoveDelegate(View child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnStyleChangeDelegate(StyleManager styleManager, StyleChangeType change);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnAccessibilityActivatedDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnAccessibilityPanDelegate(PanGesture gestures);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnAccessibilityTouchDelegate(Touch touch);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnAccessibilityValueChangeDelegate(bool isIncrease);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnAccessibilityZoomDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnFocusGainedDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnFocusLostDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate View GetNextFocusableViewDelegate(View currentFocusedView, View.FocusDirection direction, bool loopEnabled);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnFocusChangeCommittedDelegate(View commitedFocusableView);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool OnKeyboardEnterDelegate();
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnPinchDelegate(PinchGesture pinch);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnPanDelegate(PanGesture pan);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnTapDelegate(TapGesture tap);
+ /// <since_tizen> 3 </since_tizen>
public delegate void OnLongPressDelegate(LongPressGesture longPress);
- public OnStageConnectionDelegate OnStageConnection;
- public OnStageDisconnectionDelegate OnStageDisconnection;
- public OnChildAddDelegate OnChildAdd;
- public OnChildRemoveDelegate OnChildRemove;
- public OnPropertySetDelegate OnPropertySet;
- public OnSizeSetDelegate OnSizeSet;
- public OnSizeAnimationDelegate OnSizeAnimation;
+ public new OnStageConnectionDelegate OnStageConnection;
+ public new OnStageDisconnectionDelegate OnStageDisconnection;
+ public new OnChildAddDelegate OnChildAdd;
+ public new OnChildRemoveDelegate OnChildRemove;
+ public new OnPropertySetDelegate OnPropertySet;
+ public new OnSizeSetDelegate OnSizeSet;
+ public new OnSizeAnimationDelegate OnSizeAnimation;
public OnTouchDelegate OnTouch;
public OnHoverDelegate OnHover;
public OnKeyDelegate OnKey;
public OnWheelDelegate OnWheel;
- public OnRelayoutDelegate OnRelayout;
- public OnSetResizePolicyDelegate OnSetResizePolicy;
- public GetNaturalSizeDelegate GetNaturalSize;
- public CalculateChildSizeDelegate CalculateChildSize;
- public GetHeightForWidthDelegate GetHeightForWidth;
- public GetWidthForHeightDelegate GetWidthForHeight;
+ public new OnRelayoutDelegate OnRelayout;
+ public new OnSetResizePolicyDelegate OnSetResizePolicy;
+ public new GetNaturalSizeDelegate GetNaturalSize;
+ public new CalculateChildSizeDelegate CalculateChildSize;
+ public new GetHeightForWidthDelegate GetHeightForWidth;
+ public new GetWidthForHeightDelegate GetWidthForHeight;
public RelayoutDependentOnChildrenDimensionDelegate RelayoutDependentOnChildrenDimension;
- public RelayoutDependentOnChildrenDelegate RelayoutDependentOnChildren;
- public OnCalculateRelayoutSizeDelegate OnCalculateRelayoutSize;
- public OnLayoutNegotiatedDelegate OnLayoutNegotiated;
- public OnControlChildAddDelegate OnControlChildAdd;
- public OnControlChildRemoveDelegate OnControlChildRemove;
- public OnStyleChangeDelegate OnStyleChange;
- public OnAccessibilityActivatedDelegate OnAccessibilityActivated;
- public OnAccessibilityPanDelegate OnAccessibilityPan;
- public OnAccessibilityTouchDelegate OnAccessibilityTouch;
- public OnAccessibilityValueChangeDelegate OnAccessibilityValueChange;
- public OnAccessibilityZoomDelegate OnAccessibilityZoom;
+ public new RelayoutDependentOnChildrenDelegate RelayoutDependentOnChildren;
+ public new OnCalculateRelayoutSizeDelegate OnCalculateRelayoutSize;
+ public new OnLayoutNegotiatedDelegate OnLayoutNegotiated;
+ public new OnControlChildAddDelegate OnControlChildAdd;
+ public new OnControlChildRemoveDelegate OnControlChildRemove;
+ public new OnStyleChangeDelegate OnStyleChange;
+ public new OnAccessibilityActivatedDelegate OnAccessibilityActivated;
+ public new OnAccessibilityPanDelegate OnAccessibilityPan;
+ public new OnAccessibilityTouchDelegate OnAccessibilityTouch;
+ public new OnAccessibilityValueChangeDelegate OnAccessibilityValueChange;
+ public new OnAccessibilityZoomDelegate OnAccessibilityZoom;
public OnFocusGainedDelegate OnFocusGained;
public OnFocusLostDelegate OnFocusLost;
- public GetNextFocusableViewDelegate GetNextFocusableView;
- public OnFocusChangeCommittedDelegate OnFocusChangeCommitted;
- public OnKeyboardEnterDelegate OnKeyboardEnter;
- public OnPinchDelegate OnPinch;
- public OnPanDelegate OnPan;
- public OnTapDelegate OnTap;
- public OnLongPressDelegate OnLongPress;
+ public new GetNextFocusableViewDelegate GetNextFocusableView;
+ public new OnFocusChangeCommittedDelegate OnFocusChangeCommitted;
+ public new OnKeyboardEnterDelegate OnKeyboardEnter;
+ public new OnPinchDelegate OnPinch;
+ public new OnPanDelegate OnPan;
+ public new OnTapDelegate OnTap;
+ public new OnLongPressDelegate OnLongPress;
internal ViewWrapperImpl(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicManualPINVOKE.ViewWrapperImpl_SWIGUpcast(cPtr), cMemoryOwn)
{
OnLongPress(new LongPressGesture(longPress, false));
}
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_0(int depth);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_1();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_2(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_3(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_4(int index, global::System.IntPtr propertyValue);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_5(global::System.IntPtr targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_6(global::System.IntPtr animation, global::System.IntPtr targetSize);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_7(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_8(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_9(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_10(global::System.IntPtr arg0);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_11(global::System.IntPtr size, global::System.IntPtr container);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_12(int policy, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate global::System.IntPtr DelegateViewWrapperImpl_13();
+ /// <since_tizen> 3 </since_tizen>
public delegate float DelegateViewWrapperImpl_14(global::System.IntPtr child, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate float DelegateViewWrapperImpl_15(float width);
+ /// <since_tizen> 3 </since_tizen>
public delegate float DelegateViewWrapperImpl_16(float height);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_17(int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_18();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_19(int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_20(float size, int dimension);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_21();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_22(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_23(global::System.IntPtr child);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_24(global::System.IntPtr styleManager, int change);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_25();
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_26(global::System.IntPtr gesture);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_27(global::System.IntPtr touch);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_28(bool isIncrease);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_29();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_30();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_31();
+ /// <since_tizen> 3 </since_tizen>
public delegate global::System.IntPtr DelegateViewWrapperImpl_32(global::System.IntPtr currentFocusedActor, int direction, bool loopEnabled);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_33(global::System.IntPtr commitedFocusableActor);
+ /// <since_tizen> 3 </since_tizen>
public delegate bool DelegateViewWrapperImpl_34();
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_35(global::System.IntPtr pinch);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_36(global::System.IntPtr pan);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_37(global::System.IntPtr tap);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_38(global::System.IntPtr longPress);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_39(global::System.IntPtr slotObserver, global::System.IntPtr callback);
+ /// <since_tizen> 3 </since_tizen>
public delegate void DelegateViewWrapperImpl_40(global::System.IntPtr slotObserver, global::System.IntPtr callback);
private DelegateViewWrapperImpl_0 Delegate0;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
using System;
using System.Runtime.InteropServices;
namespace Tizen.NUI
/// <summary>
/// Event arguments that passed via time tick event signal.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class TimeTickEventArgs : EventArgs
{
/// <summary>
/// Application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Application Application
{
get;
/// <summary>
/// WatchTime.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public WatchTime WatchTime
{
get;
/// <summary>
/// Event arguments that passed via ambient tick event signal.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class AmbientTickEventArgs : EventArgs
{
/// <summary>
/// Application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Application Application
{
get;
/// <summary>
/// WatchTime.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public WatchTime WatchTime
{
get;
/// <summary>
/// Event arguments that passed via ambient tick event signal.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class AmbientChangedEventArgs : EventArgs
{
/// <summary>
/// Application.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Application Application
{
get;
/// <summary>
/// Changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool Changed
{
get;
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time.<br>
+ /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time.<br />
/// Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of
/// the animation before computing the final animation value.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class AlphaFunction : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>swigCMemOwn.</summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal AlphaFunction(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~AlphaFunction()
{
if(!isDisposeQueued)
}
}
/// <summary>
- /// To make AlphaFunction instance be disposed.
+ /// To make the AlphaFunction instance be disposed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// To make the AlphaFunction instance be disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Constructor.<br>
- /// Creates an alpha function object with user defined alpha function.<br>
+ /// The constructor.<br />
+ /// Creates an alpha function object with the user-defined alpha function.<br />
/// </summary>
/// <param name="func">User defined fuction. It must be a method formatted as float alphafunction(float progress)</param>
- public AlphaFunction(System.Delegate func) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_2(SWIGTYPE_p_f_float__float.getCPtr(new SWIGTYPE_p_f_float__float(System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func), true))), true)
+ /// <since_tizen> 3 </since_tizen>
+ public AlphaFunction(System.Delegate func) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_2(SWIGTYPE_p_f_float__float.getCPtr(new SWIGTYPE_p_f_float__float(System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate<System.Delegate>(func), true))), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Default constructor.<br>
- /// Creates an alpha function object with the default built-in alpha function.<br>
+ /// The default constructor.<br />
+ /// Creates an alpha function object with the default built-in alpha function.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction() : this(NDalicPINVOKE.new_AlphaFunction__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.<br>
- /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.<br>
+ /// The constructor.<br />
+ /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.<br />
/// </summary>
- /// <param name="function">One of the built-in alpha functions</param>
+ /// <param name="function">One of the built-in alpha functions.</param>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction(AlphaFunction.BuiltinFunctions function) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_1((int)function), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.<br>
- /// Creates a bezier alpha function.The bezier will have the first point at(0,0) and the end point at(1,1).<br>
+ /// The constructor.<br />
+ /// Creates a bezier alpha function. The bezier will have the first point at (0,0) and the end point at (1,1).<br />
/// </summary>
- /// <remarks>The x components of the control points will be clamped to the range[0, 1] to prevent non monotonic curves.</remarks>
- /// <param name="controlPoint0">A Vector2 which will be used as the first control point of the curve</param>
- /// <param name="controlPoint1">A Vector2 which will be used as the second control point of the curve</param>
+ /// <remarks>The x components of the control points will be clamped to the range [0, 1] to prevent non-monotonic curves.</remarks>
+ /// <param name="controlPoint0">A Vector2 which will be used as the first control point of the curve.</param>
+ /// <param name="controlPoint1">A Vector2 which will be used as the second control point of the curve.</param>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction(Vector2 controlPoint0, Vector2 controlPoint1) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_3(Vector2.getCPtr(controlPoint0), Vector2.getCPtr(controlPoint1)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Retrives the control points of the alpha function.<br>
+ /// Retrives the control points of the alpha function.<br />
/// </summary>
- /// <param name="controlPoint0">A Vector2 which is used as the first control point of the curve</param>
- /// <param name="controlPoint1">A Vector2 which is used as the second control point of the curve</param>
+ /// <param name="controlPoint0">A Vector2 which will be used as the first control point of the curve.</param>
+ /// <param name="controlPoint1">A Vector2 which will be used as the second control point of the curve.</param>
+ /// <since_tizen> 3 </since_tizen>
public void GetBezierControlPoints(out Vector2 controlPoint0, out Vector2 controlPoint1)
{
Vector4 ret = new Vector4(NDalicPINVOKE.AlphaFunction_GetBezierControlPoints(swigCPtr), true);
}
/// <summary>
- /// Returns the built-in function used by the alpha function.<br>
- /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.<br>
+ /// Returns the built-in function used by the alpha function.<br />
+ /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.<br />
/// </summary>
/// <returns>One of the built-in alpha functions.</returns>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction.BuiltinFunctions GetBuiltinFunction()
{
AlphaFunction.BuiltinFunctions ret = (AlphaFunction.BuiltinFunctions)NDalicPINVOKE.AlphaFunction_GetBuiltinFunction(swigCPtr);
}
/// <summary>
- /// Returns the functioning mode of the alpha function
+ /// Returns the functioning mode of the alpha function.
/// </summary>
- /// <returns>The functioning mode of the alpha function</returns>
+ /// <returns>The functioning mode of the alpha function.</returns>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction.Modes GetMode()
{
AlphaFunction.Modes ret = (AlphaFunction.Modes)NDalicPINVOKE.AlphaFunction_GetMode(swigCPtr);
}
/// <summary>
- /// This specifies the various types of BuiltinFunctions
+ /// This specifies the various types of BuiltinFunctions.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum BuiltinFunctions
{
/// <summary>
- /// Linear
+ /// Linear.
/// </summary>
Default,
/// <summary>
- /// No transformation
+ /// No transformation.
/// </summary>
Linear,
/// <summary>
- /// Reverse linear
+ /// Reverse linear.
/// </summary>
Reverse,
/// <summary>
- /// Speeds up and comes to a sudden stop (Square)
+ /// Speeds up and comes to a sudden stop (square).
/// </summary>
EaseInSquare,
/// <summary>
- /// Sudden start and slows to a gradual stop (Square)
+ /// Sudden start and slows to a gradual stop (square).
/// </summary>
EaseOutSquare,
/// <summary>
- /// Speeds up and comes to a sudden stop (Cubic)
+ /// Speeds up and comes to a sudden stop (cubic).
/// </summary>
EaseIn,
/// <summary>
- /// Sudden start and slows to a gradual stop (Cubic)
+ /// Sudden start and slows to a gradual stop (cubic).
/// </summary>
EaseOut,
/// <summary>
- /// Speeds up and slows to a gradual stop (Cubic)
+ /// Speeds up and slows to a gradual stop (cubic).
/// </summary>
EaseInOut,
/// <summary>
- /// Speeds up and comes to a sudden stop (sinusoidal)
+ /// Speeds up and comes to a sudden stop (sinusoidal).
/// </summary>
EaseInSine,
/// <summary>
- /// Sudden start and slows to a gradual stop (sinusoidal)
+ /// Sudden start and slows to a gradual stop (sinusoidal).
/// </summary>
EaseOutSine,
/// <summary>
- /// Speeds up and slows to a gradual stop (sinusoidal)
+ /// Speeds up and slows to a gradual stop (sinusoidal).
/// </summary>
EaseInOutSine,
/// <summary>
- /// Sudden start, loses momentum and returns to start position
+ /// Sudden start, loses momentum and returns to start position.
/// </summary>
Bounce,
/// <summary>
- /// Single revolution
+ /// Single revolution.
/// </summary>
Sin,
/// <summary>
- /// Sudden start, exceed end position and return to a gradual stop
+ /// Sudden start, exceed end position and return to a gradual stop.
/// </summary>
EaseOutBack,
+ /// <summary>
+ /// The count of the BuiltinFunctions enum.
+ /// </summary>
Count
}
/// <summary>
- /// This specifies which mode is set for AlphaFuction
+ /// This specifies which mode is set for AlphaFunction.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Modes
{
/// <summary>
BuiltinFunction,
/// <summary>
- /// The user has provided a custom function
+ /// The user has provided a custom function.
/// </summary>
CustomFunction,
/// <summary>
- /// The user has provided the control points of a bezier curve
+ /// The user has provided the control points of a bezier curve.
/// </summary>
Bezier
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// Animatable.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Animatable : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// To make the Animatable instance be disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Create an instance of animatable.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Animatable() : this(NDalicPINVOKE.Handle_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Queries the name of a property.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <returns>The name of the property.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetPropertyName(int index)
{
string ret = NDalicPINVOKE.Handle_GetPropertyName(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Queries the index of a property.
+ /// </summary>
+ /// <param name="name">The name of the property.</param>
+ /// <returns>The index of the property.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetPropertyIndex(string name)
{
string daliPropertyName = name.Substring(0, 1).ToLower() + name.Substring(1);
return ret;
}
+ /// <summary>
+ /// Queries whether a property can be writable.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <returns>True if the property is writable.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsPropertyWritable(int index)
{
bool ret = NDalicPINVOKE.Handle_IsPropertyWritable(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// whether a writable property can be the target of an animation.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <returns>True if the property is animatable.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsPropertyAnimatable(int index)
{
bool ret = NDalicPINVOKE.Handle_IsPropertyAnimatable(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Queries the type of a property.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <returns>The type of the property.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyType GetPropertyType(int index)
{
PropertyType ret = (PropertyType)NDalicPINVOKE.Handle_GetPropertyType(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Sets the value of an existing property.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <param name="propertyValue">The new value of the property.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetProperty(int index, PropertyValue propertyValue)
{
Tizen.NUI.Object.SetProperty(swigCPtr, index, propertyValue);
}
+ /// <summary>
+ /// Registers a new animatable property.
+ /// </summary>
+ /// <param name="name">The name of the property.</param>
+ /// <param name="propertyValue">The new value of the property.</param>
+ /// <returns>The type of the property.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int RegisterProperty(string name, PropertyValue propertyValue)
{
int ret = NDalicPINVOKE.Handle_RegisterProperty__SWIG_0(swigCPtr, name, PropertyValue.getCPtr(propertyValue));
return ret;
}
+ /// <summary>
+ /// Registers a new animatable property.
+ /// </summary>
+ /// <param name="name">The name of the property.</param>
+ /// <param name="propertyValue">The new value of the property.</param>
+ /// <param name="accessMode">The property access mode (writable, animatable etc).</param>
+ /// <returns>The type of the property.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int RegisterProperty(string name, PropertyValue propertyValue, PropertyAccessMode accessMode)
{
int ret = NDalicPINVOKE.Handle_RegisterProperty__SWIG_1(swigCPtr, name, PropertyValue.getCPtr(propertyValue), (int)accessMode);
return ret;
}
+ /// <summary>
+ /// Retrieves a property value.
+ /// </summary>
+ /// <param name="index">The index of the property.</param>
+ /// <returns>The property value.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue GetProperty(int index)
{
PropertyValue ret = Tizen.NUI.Object.GetProperty(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Adds a property notification to this object.
+ /// </summary>
+ /// <param name="property">The name of the property.</param>
+ /// <param name="condition">The notification will be triggered when this condition is satisfied.</param>
+ /// <returns>A handle to the newly created PropertyNotification.</returns>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotification AddPropertyNotification(string property, PropertyCondition condition)
{
PropertyNotification ret = new PropertyNotification(NDalicPINVOKE.Handle_AddPropertyNotification__SWIG_0(swigCPtr, PropertyHelper.GetPropertyFromString(this, property).propertyIndex, PropertyCondition.getCPtr(condition)), true);
return ret;
}
+ /// <summary>
+ /// Removes a property notification from this object.
+ /// </summary>
+ /// <param name="propertyNotification">The propertyNotification to be removed.</param>
+ /// <since_tizen> 4 </since_tizen>
public void RemovePropertyNotification(PropertyNotification propertyNotification)
{
NDalicPINVOKE.Handle_RemovePropertyNotification(swigCPtr, PropertyNotification.getCPtr(propertyNotification));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Removes a property notification from this object.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void RemovePropertyNotifications()
{
NDalicPINVOKE.Handle_RemovePropertyNotifications(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Enumeration for Handle's capabilities that can be queried.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Capability
{
+ /// <summary>
+ /// Some objects support dynamic property creation at run-time.
+ /// New properties are registered by calling RegisterProperty() with an unused property name.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
DYNAMIC_PROPERTIES = 0x01
}
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Animation can be used to animate the properties of any number of objects, typically View.<br>
- /// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.<br>
- /// This is typically done in the object destructor, and requires either the Animation handle to be stored.<br>
- /// The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.<br>
- /// If any of the individual calls to those functions exceeds the overall animation time(Duration), then the overall animation time is automatically extended.<br>
+ /// Animation can be used to animate the properties of any number of objects, typically view.<br />
+ /// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.<br />
+ /// This is typically done in the object destructor, and requires either the animation handle to be stored.<br />
+ /// The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.<br />
+ /// If any of the individual calls to those functions exceeds the overall animation time (Duration), then the overall animation time is automatically extended.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Animation : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make Animation instance be disposed.
+ /// To make animation instance be disposed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
{
return;
}
-
if(type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
//You should release all of your own disposable objects here.
+
}
if (_animationFinishedEventCallback != null)
}
/// <summary>
- /// Create an initialized Animation.<br>
- /// The animation will not loop.<br>
- /// The default end action is "Cancel".<br>
- /// The default Alpha function is linear.<br>
+ /// Creates an initialized animation.<br />
+ /// The animation will not loop.<br />
+ /// The default end action is "Cancel".<br />
+ /// The default alpha function is linear.<br />
/// </summary>
/// <remarks>DurationmSeconds must be greater than zero.</remarks>
- /// <param name="durationMilliSeconds">The duration in milli seconds.</param>
+ /// <param name="durationMilliSeconds">The duration in milliseconds.</param>
+ /// <since_tizen> 3 </since_tizen>
public Animation(int durationMilliSeconds) : this(NDalicPINVOKE.Animation_New((float)durationMilliSeconds / 1000.0f), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
private delegate void AnimationFinishedEventCallbackType(IntPtr data);
private event EventHandler _animationFinishedEventHandler;
/**
- * @brief Event for Finished signal which can be used to subscribe/unsubscribe the event handler.
- * Finished signal is emitted when an Animation's animations have finished.
+ * @brief Event for the finished signal which can be used to subscribe or unsubscribe the event handler.
+ * The finished signal is emitted when an animation's animations have finished.
*/
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Finished
{
add
private AnimationProgressReachedEventCallbackType _animationProgressReachedEventCallback;
private event EventHandler _animationProgressReachedEventHandler;
/**
- * @brief Event for ProgressReached signal which can be used to subscribe/unsubscribe the event handler.
- * ProgressReached signal is emitted when the Animation has reached a given progress percentage, this is set in the api SetProgressNotification.
+ * @brief Event for the ProgressReached signal, which can be used to subscribe or unsubscribe the event handler.
+ * The ProgressReached signal is emitted when the animation has reached a given progress percentage, this is set in the api SetProgressNotification.
*/
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler ProgressReached
{
add
/// <summary>
- /// Gets/Sets the duration in milli seconds of the animation.
+ /// Gets or sets the duration in milliseconds of the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Duration
{
set
}
/// <summary>
- /// Gets/Sets the default alpha function for the animation.
+ /// Gets or sets the default alpha function for the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction DefaultAlphaFunction
{
set
/// <summary>
/// Queries the state of the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public States State
{
get
}
/// <summary>
- /// Set : Enables looping for 'count' repeats. A zero is the same as Looping = true; i.e.repeat forever.<br>
- /// If Play() Stop() or 'count' loops is reached, the loop counter will reset.<br>
- /// Setting this parameter does not cause the animation to Play().<br>
- /// Get : Gets the loop count. A zero is the same as Looping = true; ie repeat forever.<br>
- /// The loop count is initially 1 for play once.<br>
+ /// Set: Enables looping for 'count' repeats. A zero is the same as Looping = true; i.e., repeat forever.<br />
+ /// If Play() Stop() or 'count' loops is reached, the loop counter will reset.<br />
+ /// Setting this parameter does not cause the animation to Play().<br />
+ /// Get: Gets the loop count. A zero is the same as Looping = true; i.e., repeat forever.<br />
+ /// The loop count is initially 1 for play once.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int LoopCount
{
set
}
/// <summary>
- /// Gets/Sets the status of whether the animation will loop.<br>
- /// This property resets the loop count and should not be used with LoopCount property.<br>
- /// Setting this parameter does not cause the animation to Play().<br>
+ /// Gets or sets the status of whether the animation will loop.<br />
+ /// This property resets the loop count and should not be used with the LoopCount property.<br />
+ /// Setting this parameter does not cause the animation to Play().<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Looping
{
set
/// <summary>
- /// Gets/Sets the end action of the animation.<br>
- /// This action is performed when the animation ends or if it is stopped.<br>
- /// Default end action is Cancel.<br>
+ /// Gets or sets the end action of the animation.<br />
+ /// This action is performed when the animation ends or if it is stopped.<br />
+ /// The default end action is cancel.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public EndActions EndAction
{
set
/// <summary>
/// Stops the animation.
/// </summary>
- /// <param name="action">end action can be set</param>
+ /// <param name="action">The end action can be set.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Stop(EndActions action = EndActions.Cancel)
{
SetEndAction(action);
}
/// <summary>
- /// Gets the current loop count.<br>
- /// A value 0 indicating the current loop count when looping.<br>
+ /// Gets the current loop count.<br />
+ /// A value 0 indicating the current loop count when looping.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int CurrentLoop
{
get
}
/// <summary>
- /// Gets/Sets the disconnect action.<br>
- /// If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.<br>
- /// Default action is to Cancel.<br>
+ /// Gets or sets the disconnect action.<br />
+ /// If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.<br />
+ /// The default action is cancel.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public EndActions DisconnectAction
{
set
/// <summary>
- /// Gets/Sets the progress of the animation.<br>
- /// The animation will play(or continue playing) from this point.<br>
- /// The progress must be in the 0-1 interval or in the play range interval if defined.<br>
- /// otherwise, it will be ignored.<br>
+ /// Gets or sets the progress of the animation.<br />
+ /// The animation will play (or continue playing) from this point.<br />
+ /// The progress must be in the 0-1 interval or in the play range interval if defined<br />
+ /// otherwise, it will be ignored.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CurrentProgress
{
set
}
/// <summary>
- /// Gets/Sets Specifies a speed factor for the animation.<br>
- /// The speed factor is a multiplier of the normal velocity of the animation.<br>
- /// Values between[0, 1] will slow down the animation and values above one will speed up the animation.<br>
- /// It is also possible to specify a negative multiplier to play the animation in reverse.<br>
+ /// Gets or sets specificifications of a speed factor for the animation.<br />
+ /// The speed factor is a multiplier of the normal velocity of the animation.<br />
+ /// Values between [0, 1] will slow down the animation and values above one will speed up the animation.<br />
+ /// It is also possible to specify a negative multiplier to play the animation in reverse.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SpeedFactor
{
set
}
/// <summary>
- /// Gets/Sets the playing range.<br>
- /// Animation will play between the values specified. Both values(range.x and range.y ) should be between 0-1,
- /// otherwise they will be ignored.If the range provided is not in proper order(minimum, maximum ), it will be reordered.<br>
+ /// Gets or sets the playing range.<br />
+ /// Animation will play between the values specified. Both values (range.x and range.y ) should be between 0-1,
+ /// otherwise they will be ignored. If the range provided is not in proper order (minimum, maximum ), it will be reordered.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2 PlayRange
{
set
/// <summary>
- /// Gets/Sets the Progress notification marker which triggers the ProgressReachedSignal.<br>
- /// percentage of animation progress should be greater than 0 and less than 1, e.g 0.3 for 30% <br>
- /// One notification can be set on each animation
+ /// Gets or sets the progress notification marker which triggers the ProgressReachedSignal.<br />
+ /// Percentage of animation progress should be greater than 0 and less than 1, for example, 0.3 for 30% <br />
+ /// One notification can be set on each animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ProgressNotification
{
set
}
/// <summary>
- /// Animates a property value by a relative amount.<br>
+ /// Animates a property value by a relative amount.<br />
/// </summary>
- /// <param name="target">The target object to animate</param>
- /// <param name="property">The target property to animate</param>
- /// <param name="relativeValue">The property value will change by this amount</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="target">The target object to animate.</param>
+ /// <param name="property">The target property to animate.</param>
+ /// <param name="relativeValue">The property value will change by this amount.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateBy(View target, string property, object relativeValue, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
}
/// <summary>
- /// Animates a property value by a relative amount.<br>
+ /// Animates a property value by a relative amount.<br />
/// </summary>
- /// <param name="target">The target object to animate</param>
- /// <param name="property">The target property to animate</param>
- /// <param name="relativeValue">The property value will change by this amount</param>
- /// <param name="startTime">Start time of animation</param>
- /// <param name="endTime">End time of animation</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="target">The target object to animate.</param>
+ /// <param name="property">The target property to animate.</param>
+ /// <param name="relativeValue">The property value will change by this amount.</param>
+ /// <param name="startTime">The start time of the animation.</param>
+ /// <param name="endTime">The end time of the animation.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateBy(View target, string property, object relativeValue, int startTime, int endTime, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
}
/// <summary>
- /// Animates a property to a destination value.<br>
+ /// Animates a property to a destination value.<br />
/// </summary>
- /// <param name="target">The target object to animate</param>
- /// <param name="property">The target property to animate</param>
- /// <param name="destinationValue">The destination value</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="target">The target object to animate.</param>
+ /// <param name="property">The target property to animate.</param>
+ /// <param name="destinationValue">The destination value.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateTo(View target, string property, object destinationValue, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
}
/// <summary>
- /// Animates a property to a destination value.<br>
+ /// Animates a property to a destination value.<br />
/// </summary>
- /// <param name="target">The target object to animate</param>
- /// <param name="property">The target property to animate</param>
- /// <param name="destinationValue">The destination value</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
- /// <param name="startTime">Start time of animation</param>
- /// <param name="endTime">End time of animation</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="target">The target object to animate.</param>
+ /// <param name="property">The target property to animate.</param>
+ /// <param name="destinationValue">The destination value.</param>
+ /// <param name="startTime">The start time of the animation.</param>
+ /// <param name="endTime">The end time of the animation.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateTo(View target, string property, object destinationValue, int startTime, int endTime, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
/// <summary>
/// Animates a property between keyframes.
/// </summary>
- /// <param name="target">The target object to animate</param>
- /// <param name="property">The target property to animate</param>
- /// <param name="keyFrames">The set of time/value pairs between which to animate</param>
- /// <param name="interpolation">The method used to interpolate between values</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="target">The target object to animate.</param>
+ /// <param name="property">The target property to animate.</param>
+ /// <param name="keyFrames">The set of time or value pairs between which to animate.</param>
+ /// <param name="interpolation">The method used to interpolate between values.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateBetween(View target, string property, KeyFrames keyFrames, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
/// <param name="target">The target object to animate</param>
/// <param name="property">The target property to animate</param>
/// <param name="keyFrames">The set of time/value pairs between which to animate</param>
- /// <param name="startTime">Start time of animation in milli seconds</param>
- /// <param name="endTime">End time of animation in milli seconds</param>
- /// <param name="interpolation">The method used to interpolate between values</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="startTime">The start time of animation in milliseconds.</param>
+ /// <param name="endTime">The end time of animation in milliseconds.</param>
+ /// <param name="interpolation">The method used to interpolate between values.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateBetween(View target, string property, KeyFrames keyFrames, int startTime, int endTime, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null)
{
Property _prop = PropertyHelper.GetPropertyFromString(target, property);
}
/// <summary>
- /// Animates an view's position and orientation through a predefined path.<br>
- /// The view will rotate to orient the supplied forward vector with the path's tangent.<br>
- /// If forward is the zero vector then no rotation will happen.<br>
+ /// Animates the view's position and orientation through a predefined path.<br />
+ /// The view will rotate to orient the supplied forward vector with the path's tangent.<br />
+ /// If forward is the zero vector then no rotation will happen.<br />
/// </summary>
- /// <param name="view">The view to animate</param>
- /// <param name="path">It defines position and orientation</param>
- /// <param name="forward">The vector (in local space coordinate system) that will be oriented with the path's tangent direction</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="view">The view to animate.</param>
+ /// <param name="path">It defines position and orientation.</param>
+ /// <param name="forward">The vector (in local space coordinate system) will be oriented with the path's tangent direction.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimatePath(View view, Path path, Vector3 forward, AlphaFunction alphaFunction = null)
{
if (alphaFunction == null)
}
/// <summary>
- /// Animates an view's position and orientation through a predefined path.<br>
- /// The view will rotate to orient the supplied forward vector with the path's tangent.<br>
- /// If forward is the zero vector then no rotation will happen.<br>
+ /// Animates the view's position and orientation through a predefined path.<br />
+ /// The view will rotate to orient the supplied forward vector with the path's tangent.<br />
+ /// If forward is the zero vector then no rotation will happen.<br />
/// </summary>
- /// <param name="view">The view to animate</param>
- /// <param name="path">It defines position and orientation</param>
- /// <param name="forward">The vector (in local space coordinate system) that will be oriented with the path's tangent direction</param>
- /// <param name="startTime">Start time of animation</param>
- /// <param name="endTime">End time of animation</param>
- /// <param name="alphaFunction">The alpha function to apply</param>
+ /// <param name="view">The view to animate.</param>
+ /// <param name="path">It defines position and orientation.</param>
+ /// <param name="forward">The vector (in local space coordinate system) will be oriented with the path's tangent direction.</param>
+ /// <param name="startTime">The start time of the animation.</param>
+ /// <param name="endTime">The end time of the animation.</param>
+ /// <param name="alphaFunction">The alpha function to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimatePath(View view, Path path, Vector3 forward, int startTime, int endTime, AlphaFunction alphaFunction = null)
{
TimePeriod time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime));
}
/// <summary>
- /// Creates an initialized Animation.<br>
- /// The animation will not loop.<br>
- /// The default end action is "Cancel".<br>
- /// The default alpha function is linear.<br>
+ /// Creates an initialized animation.<br />
+ /// The animation will not loop.<br />
+ /// The default end action is "Cancel".<br />
+ /// The default alpha function is linear.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Animation() : this(NDalicPINVOKE.Animation_New(0.0f), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Downcasts a handle to Animation handle.<br>
- /// If handle points to an Animation object, the downcast produces valid handle.<br>
- /// If not, the returned handle is left uninitialized.<br>
+ /// Downcasts a handle to animation handle.<br />
+ /// If handle points to an animation object, the downcast produces a valid handle.<br />
+ /// If not, the returned handle is left uninitialized.<br />
/// </summary>
- /// <param name="handle">Handle to an object</param>
- /// <returns>Handle to an Animation object or an uninitialized handle</returns>
+ /// <param name="handle">Handle to an object.</param>
+ /// <returns>Handle to an animation object or an uninitialized handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Animation DownCast(BaseHandle handle)
{
Animation ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Animation;
/// <summary>
/// Plays the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Play()
{
NDalicPINVOKE.Animation_Play(swigCPtr);
}
/// <summary>
- /// Plays the animation from a given point.<br>
+ /// Plays the animation from a given point.<br />
/// The progress must be in the 0-1 interval or in the play range interval if defined,
- /// otherwise, it will be ignored.<br>
+ /// otherwise, it will be ignored.<br />
/// </summary>
- /// <param name="progress">A value between [0,1], or between the play range if specified, from where the animation should start playing</param>
+ /// <param name="progress">A value between [0,1], or between the play range if specified, from where the animation should start playing.</param>
+ /// <since_tizen> 3 </since_tizen>
public void PlayFrom(float progress)
{
NDalicPINVOKE.Animation_PlayFrom(swigCPtr, progress);
}
/// <summary>
- /// Play the animation after a given delay time.<br/>
+ /// Plays the animation after a given delay time.<br/>
/// The delay time is not included in the looping time.<br/>
- /// When the delay time is negative value, it would treat as play immediately.<br/>
+ /// When the delay time is a negative value, it would treat as play immediately.<br/>
/// </summary>
- /// <param name="delayMilliseconds">The delay time</param>
+ /// <param name="delayMilliseconds">The delay time.</param>
+ /// <since_tizen> 4 </since_tizen>
public void PlayAfter(int delayMilliseconds)
{
NDalicPINVOKE.Animation_PlayAfter(swigCPtr, MilliSecondsToSeconds(delayMilliseconds));
/// <summary>
/// Pauses the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Pause()
{
NDalicPINVOKE.Animation_Pause(swigCPtr);
/// <summary>
/// Stops the animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Stop()
{
NDalicPINVOKE.Animation_Stop(swigCPtr);
}
/// <summary>
- /// Clears the animation.<br>
- /// This disconnects any objects that were being animated, effectively stopping the animation.<br>
+ /// Clears the animation.<br />
+ /// This disconnects any objects that were being animated, effectively stopping the animation.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Clear()
{
NDalicPINVOKE.Animation_Clear(swigCPtr);
}
/// <summary>
- /// Enumeration for what to do when the animation ends, is stopped, or is destroyed.
+ /// Enumeration for what to do when the animation ends, stopped, or destroyed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum EndActions
{
/// <summary>
/// </summary>
Discard,
/// <summary>
- /// If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel.
+ /// If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like cancel.
/// </summary>
StopFinal
}
/// <summary>
/// Enumeration for what interpolation method to use on key-frame animations.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Interpolation
{
/// <summary>
/// <summary>
/// Enumeration for what state the animation is in.
/// </summary>
- /// <remarks>Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle.</remarks>
+ /// <remarks>Calling Reset() on this class will not reset the animation. It will call the BaseHandle.Reset() which drops the object handle.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public enum States
{
/// <summary>
- /// Animation has stopped
+ /// The animation has stopped.
/// </summary>
Stopped,
/// <summary>
- /// The animation is playing
+ /// The animation is playing.
/// </summary>
Playing,
/// <summary>
- /// The animation is paused
+ /// The animation is paused.
/// </summary>
Paused
}
/// <summary>
/// CustomView provides some common functionality required by all views.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class CustomView : ViewWrapper
{
+ /// <summary>
+ /// Create an instance of customView.
+ /// </summary>
+ /// <param name="typeName">typename</param>
+ /// <param name="behaviour">CustomView Behaviour</param>
+ /// <since_tizen> 3 </since_tizen>
public CustomView(string typeName, CustomViewBehaviour behaviour) : base(typeName, new ViewWrapperImpl(behaviour))
{
// Registering CustomView virtual functions to viewWrapperImpl delegates.
}
/// <summary>
- /// Set the background with a property map.
+ /// Sets the background with a property map.
/// </summary>
- /// <param name="map">The background property map</param>
+ /// <param name="map">The background property map.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetBackground(Tizen.NUI.PropertyMap map)
{
viewWrapperImpl.SetBackground(map);
}
/// <summary>
- /// Allows deriving classes to enable any of the gesture detectors that are available.<br>
- /// Gesture detection can be enabled one at a time or in bitwise format.<br>
+ /// Allows deriving classes to enable any of the gesture detectors that are available.<br />
+ /// Gesture detection can be enabled one at a time or in a bitwise format.<br />
/// </summary>
- /// <param name="type">The gesture type(s) to enable</param>
+ /// <param name="type">The gesture type(s) to enable.</param>
+ /// <since_tizen> 3 </since_tizen>
public void EnableGestureDetection(Gesture.GestureType type)
{
viewWrapperImpl.EnableGestureDetection(type);
}
/// <summary>
- /// Allows deriving classes to disable any of the gesture detectors.<br>
- /// Like EnableGestureDetection, this can also be called using bitwise or one at a time.<br>
+ /// Allows deriving classes to disable any of the gesture detectors.<br />
+ /// Like EnableGestureDetection, this can also be called using bitwise or one at a time.<br />
/// </summary>
- /// <param name="type">The gesture type(s) to disable</param>
+ /// <param name="type">The gesture type(s) to disable.</param>
internal void DisableGestureDetection(Gesture.GestureType type)
{
viewWrapperImpl.DisableGestureDetection(type);
/// <summary>
/// Sets whether this control supports two dimensional keyboard navigation
- /// (i.e. whether it knows how to handle the keyboard focus movement between its child views).<br>
- /// The control doesn't support it by default.<br>
+ /// (i.e., whether it knows how to handle the keyboard focus movement between its child views).<br />
+ /// The control doesn't support it by default.<br />
/// </summary>
- /// <param name="isSupported">Whether this control supports two dimensional keyboard navigation.</param>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusNavigationSupport
{
get
}
/// <summary>
- /// Gets whether this control supports two dimensional keyboard navigation.
+ /// Gets whether this control supports two-dimensional keyboard navigation.
/// </summary>
- /// <returns>true if this control supports two dimensional keyboard navigation</returns>
+ /// <returns>True if this control supports two-dimensional keyboard navigation.</returns>
internal bool IsKeyboardNavigationSupported()
{
return viewWrapperImpl.IsKeyboardNavigationSupported();
/// <summary>
- /// Sets or Gets whether this control is a focus group for keyboard navigation.
+ /// Sets or gets whether this control is a focus group for keyboard navigation.
/// </summary>
- /// <returns>true if this control is set as a focus group for keyboard navigation</returns>
+ /// <returns>True if this control is set as a focus group for keyboard navigation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGroup
{
get
/// <summary>
/// Sets whether this control is a focus group for keyboard navigation.
- /// (i.e. the scope of keyboard focus movement can be limitied to its child views). The control is not a focus group by default.
+ /// (i.e., the scope of keyboard focus movement can be limitied to its child views). The control is not a focus group by default.
/// </summary>
- /// <param name="isFocusGroup">Whether this control is set as a focus group for keyboard navigation</param>
+ /// <param name="isFocusGroup">Whether this control is set as a focus group for keyboard navigation.</param>
internal void SetAsKeyboardFocusGroup(bool isFocusGroup)
{
viewWrapperImpl.SetAsFocusGroup(isFocusGroup);
}
/// <summary>
- /// Called by the AccessibilityManager to activate the Control.
+ /// Called by the AccessibilityManager to activate the control.
/// </summary>
internal void AccessibilityActivate()
{
/// <summary>
/// Called by the KeyInputFocusManager to emit key event signals.
/// </summary>
- /// <param name="key">The key event</param>
- /// <returns>True if the event was consumed</returns>
+ /// <param name="key">The key event.</param>
+ /// <returns>True if the event was consumed.</returns>
internal bool EmitKeyEventSignal(Key key)
{
return viewWrapperImpl.EmitKeyEventSignal(key);
}
/// <summary>
- /// Request a relayout, which means performing a size negotiation on this view, its parent and children (and potentially whole scene).<br>
- /// This method can also be called from a derived class every time it needs a different size.<br>
- /// At the end of event processing, the relayout process starts and all controls which requested Relayout will have their sizes (re)negotiated.<br>
- /// It can be called multiple times; the size negotiation is still only performed once, i.e. there is no need to keep track of this in the calling side.<br>
- /// <summary>
+ /// Requests a relayout, which means performing a size negotiation on this view, its parent, and children (and potentially whole scene).<br />
+ /// This method can also be called from a derived class every time it needs a different size.<br />
+ /// At the end of event processing, the relayout process starts and all controls which requested relayout will have their sizes (re)negotiated.<br />
+ /// It can be called multiple times; the size negotiation is still only performed once, i.e., there is no need to keep track of this in the calling side.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected void RelayoutRequest()
{
viewWrapperImpl.RelayoutRequest();
}
/// <summary>
- /// Provides the View implementation of GetHeightForWidth.
- /// <summary>
- /// <param name="width">Width to use</param>
- /// <returns>The height based on the width</returns>
+ /// Provides the view implementation of GetHeightForWidth.
+ /// </summary>
+ /// <param name="width">The width to use.</param>
+ /// <returns>The height based on the width.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected float GetHeightForWidthBase(float width)
{
return viewWrapperImpl.GetHeightForWidthBase(width);
}
/// <summary>
- /// Provides the View implementation of GetWidthForHeight.
+ /// Provides the view implementation of GetWidthForHeight.
/// </summary>
- /// <param name="height">Height to use</param>
- /// <returns>The width based on the height</returns>
+ /// <param name="height">The height to use.</param>
+ /// <returns>The width based on the height.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected float GetWidthForHeightBase(float height)
{
return viewWrapperImpl.GetWidthForHeightBase(height);
}
/// <summary>
- /// Calculate the size for a child using the base view object.
+ /// Calculates the size for a child using the base view object.
/// </summary>
- /// <param name="child">The child view to calculate the size for</param>
- /// <param name="dimension">The dimension to calculate the size for. E.g. width or height</param>
- /// <returns>Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found</returns>
+ /// <param name="child">The child view to calculate the size for.</param>
+ /// <param name="dimension">The dimension to calculate the size, for example, the width or the height.</param>
+ /// <returns>Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected float CalculateChildSizeBase(View child, DimensionType dimension)
{
return viewWrapperImpl.CalculateChildSizeBase(child, dimension);
}
/// <summary>
- /// Determine if this view is dependent on it's children for relayout from the base class.
+ /// Determines if this view is dependent on it's children for relayout from the base class.
/// </summary>
- /// <param name="dimension">The dimension(s) to check for</param>
- /// <returns>Return if the view is dependent on it's children</returns>
+ /// <param name="dimension">The dimension(s) to check for.</param>
+ /// <returns>Return if the view is dependent on it's children.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected bool RelayoutDependentOnChildrenBase(DimensionType dimension)
{
return viewWrapperImpl.RelayoutDependentOnChildrenBase(dimension);
}
/// <summary>
- /// Determine if this view is dependent on it's children for relayout from the base class.
+ /// Determines if this view is dependent on it's children for relayout from the base class.
/// </summary>
- /// <returns>Return if the view is dependent on it's children</returns>
+ /// <returns>Return if the view is dependent on it's children.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected bool RelayoutDependentOnChildrenBase()
{
return viewWrapperImpl.RelayoutDependentOnChildrenBase();
}
/// <summary>
- /// Register a visual by Property Index, linking an View to visual when required.<br>
- /// In the case of the visual being an view or control deeming visual not required then visual should be an empty handle.<br>
- /// No parenting is done during registration, this should be done by derived class.<br>
+ /// Registers a visual by property index, linking a view to visual when required.<br />
+ /// In the case of the visual being a view or control deeming visual not required, then the visual should be an empty handle.<br />
+ /// No parenting is done during registration, this should be done by a derived class.<br />
/// </summary>
- /// <param name="index">The Property index of the visual, used to reference visual</param>
- /// <param name="visual">The visual to register</param>
+ /// <param name="index">The property index of the visual used to reference visual.</param>
+ /// <param name="visual">The visual to register.</param>
+ /// <since_tizen> 3 </since_tizen>
protected void RegisterVisual(int index, VisualBase visual)
{
viewWrapperImpl.RegisterVisual(index, visual);
}
/// <summary>
- /// Register a visual by Property Index, linking an View to visual when required.<br>
- /// In the case of the visual being an view or control deeming visual not required then visual should be an empty handle.<br>
- /// If enabled is false then the visual is not set on stage until enabled by the derived class.<br>
+ /// Registers a visual by the property index, linking a view to visual when required.<br />
+ /// In the case of the visual being a view or control deeming visual not required, then the visual should be an empty handle.<br />
+ /// If enabled is false, then the visual is not set on the stage until enabled by the derived class.<br />
/// </summary>
- /// <param name="index">The Property index of the visual, used to reference visual</param>
- /// <param name="visual">The visual to register</param>
- /// <param name="enabled">false if derived class wants to control when visual is set on stage</param>
+ /// <param name="index">The property index of the visual used to reference visual.</param>
+ /// <param name="visual">The visual to register.</param>
+ /// <param name="enabled">False if derived class wants to control when the visual is set on the stage.</param>
+ /// <since_tizen> 3 </since_tizen>
protected void RegisterVisual(int index, VisualBase visual, bool enabled)
{
viewWrapperImpl.RegisterVisual(index, visual, enabled);
}
/// <summary>
- /// Erase the entry matching the given index from the list of registered visuals.
+ /// Erases the entry matching the given index from the list of registered visuals.
/// </summary>
- /// <param name="index">The Property index of the visual, used to reference visual</param>
+ /// <param name="index">The property index of the visual used to reference visual.</param>
+ /// <since_tizen> 3 </since_tizen>
protected void UnregisterVisual(int index)
{
viewWrapperImpl.UnregisterVisual(index);
}
/// <summary>
- /// Retrieve the visual associated with the given property index.<br>
- /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.<br>
+ /// Retrieves the visual associated with the given property index.<br />
+ /// For managing the object lifecycle, do not store the returned visual as a member which increments its reference count.<br />
/// </summary>
- /// <param name="index">The Property index of the visual, used to reference visual</param>
- /// <returns>The registered visual if exist, otherwise empty handle</returns>
+ /// <param name="index">The property index of the visual used to reference visual.</param>
+ /// <returns>The registered visual if exists, otherwise an empty handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected VisualBase GetVisual(int index)
{
return viewWrapperImpl.GetVisual(index);
}
/// <summary>
- /// Sets the given visual to be displayed or not when parent staged.<br>
- /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.<br>
+ /// Sets the given visual to be displayed or not when parent staged.<br />
+ /// For managing the object lifecycle, do not store the returned visual as a member which increments its reference count.<br />
/// </summary>
- /// <param name="index">The Property index of the visual, used to reference visual</param>
- /// <param name="enable">flag to set enabled or disabled</param>
+ /// <param name="index">The property index of the visual, used to reference visual.</param>
+ /// <param name="enable">Flag set to enabled or disabled.</param>
+ /// <since_tizen> 3 </since_tizen>
protected void EnableVisual(int index, bool enable)
{
viewWrapperImpl.EnableVisual(index, enable);
}
/// <summary>
- /// Queries if the given visual is to be displayed when parent staged.<br>
- /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.<br>
+ /// Queries if the given visual is to be displayed when parent staged.<br />
+ /// For managing the object lifecycle, do not store the returned visual as a member which increments its reference count.<br />
/// </summary>
- /// <param name="index">The Property index of the visual</param>
- /// <returns>Whether visual is enabled or not</returns>
+ /// <param name="index">The property index of the visual.</param>
+ /// <returns>Whether visual is enabled or not.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected bool IsVisualEnabled(int index)
{
return viewWrapperImpl.IsVisualEnabled(index);
}
/// <summary>
- /// Create a transition effect on the control.
+ /// Creates a transition effect on the control.
/// </summary>
- /// <param name="transitionData">transitionData The transition data describing the effect to create</param>
- /// <returns>A handle to an animation defined with the given effect, or an empty handle if no properties match </returns>
+ /// <param name="transitionData">The transition data describing the effect to create.</param>
+ /// <returns>A handle to an animation defined with the given effect, or an empty handle if no properties match.</returns>
+ /// <since_tizen> 3 </since_tizen>
protected Animation CreateTransition(TransitionData transitionData)
{
return viewWrapperImpl.CreateTransition(transitionData);
}
/// <summary>
- /// Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.<br>
- /// Should be called last by the control after it acts on the Input Focus change.<br>
+ /// Emits the KeyInputFocusGained signal if true, else, emits the KeyInputFocusLost signal.<br />
+ /// Should be called last by the control after it acts on the input focus change.<br />
/// </summary>
- /// <param name="focusGained">focusGained True if gained, False if lost</param>
+ /// <param name="focusGained">True if gained, false if lost.</param>
+ /// <since_tizen> 3 </since_tizen>
protected void EmitFocusSignal(bool focusGained)
{
viewWrapperImpl.EmitFocusSignal(focusGained);
}
/// <summary>
- /// This method is called after the Control has been initialized.<br>
- /// Derived classes should do any second phase initialization by overriding this method.<br>
+ /// This method is called after the control has been initialized.<br />
+ /// Derived classes should do any second phase initialization by overriding this method.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnInitialize()
{
}
/// <summary>
- /// Called after the view has been connected to the stage.<br>
- /// When an view is connected, it will be directly or indirectly parented to the root View.<br>
- /// The root View is provided automatically by Tizen.NUI.Stage, and is always considered to be connected.<br>
- /// When the parent of a set of views is connected to the stage, then all of the children will received this callback.<br>
+ /// Called after the view has been connected to the stage.<br />
+ /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
+ /// The root view is provided automatically by Tizen.NUI.Stage, and is always considered to be connected.<br />
+ /// When the parent of a set of views is connected to the stage, then all of the children will receive this callback.<br />
/// </summary>
- /// <param name="depth">The depth in the hierarchy for the view</param>
+ /// <param name="depth">The depth in the hierarchy for the view.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnStageConnection(int depth)
{
}
/// <summary>
- /// Called after the view has been disconnected from Stage.<br>
- /// If an view is disconnected it either has no parent, or is parented to a disconnected view.<br>
- /// When the parent of a set of views is disconnected to the stage, then all of the children will received this callback, starting with the leaf views.<br>
+ /// Called after the view has been disconnected from the stage.<br />
+ /// If a view is disconnected, it either has no parent, or is parented to a disconnected view.<br />
+ /// When the parent of a set of views is disconnected to the stage, then all of the children will receive this callback, starting with the leaf views.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnStageDisconnection()
{
}
/// <summary>
/// Called after a child has been added to the owning view.
/// </summary>
- /// <param name="view">The child which has been added</param>
+ /// <param name="view">The child which has been added.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnChildAdd(View view)
{
}
/// <summary>
/// Called after the owning view has attempted to remove a child( regardless of whether it succeeded or not ).
/// </summary>
- /// <param name="view">The child being removed</param>
+ /// <param name="view">The child being removed.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnChildRemove(View view)
{
}
/// <summary>
/// Called when the owning view property is set.
/// </summary>
- /// <param name="index">The Property index that was set</param>
- /// <param name="propertyValue">The value to set</param>
+ /// <param name="index">The property index that was set.</param>
+ /// <param name="propertyValue">The value to set.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnPropertySet(int index, Tizen.NUI.PropertyValue propertyValue)
{
}
/// <summary>
- /// Called when the owning view's size is set e.g. using View.SetSize().
+ /// Called when the owning view's size is set, for example, using View.SetSize().
/// </summary>
- /// <param name="targetSize">The target size</param>
+ /// <param name="targetSize">The target size.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnSizeSet(Vector3 targetSize)
{
}
/// <summary>
- /// Called when the owning view's size is animated e.g. using Animation::AnimateTo( Property( view, View::Property::SIZE ), ... ).
+ /// Called when the owning view's size is animated, for example, using Animation::AnimateTo( Property ( view, View::Property::SIZE ), ... ).
/// </summary>
- /// <param name="animation">The object which is animating the owning view</param>
- /// <param name="targetSize">The target size</param>
+ /// <param name="animation">The object which is animating the owning view.</param>
+ /// <param name="targetSize">The target size.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnSizeAnimation(Animation animation, Vector3 targetSize)
{
}
/// <summary>
- /// Called after a touch-event is received by the owning view.<br>
- /// CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br>
+ /// Called after a touch event is received by the owning view.<br />
+ /// CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br />
/// </summary>
- /// <param name="touch">The touch event</param>
- /// <returns>True if the event should be consumed</returns>
+ /// <param name="touch">The touch event.</param>
+ /// <returns>True if the event should be consumed.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool OnTouch(Touch touch)
{
return false; // Do not consume
}
/// <summary>
- /// Called after a hover-event is received by the owning view.<br>
- /// CustomViewBehaviour.REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br>
+ /// Called after a hover event is received by the owning view.<br />
+ /// CustomViewBehaviour.REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br />
/// </summary>
- /// <param name="hover">The hover event</param>
- /// <returns>True if the hover event should be consumed</returns>
+ /// <param name="hover">The hover event.</param>
+ /// <returns>True if the hover event should be consumed.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool OnHover(Hover hover)
{
return false; // Do not consume
}
/// <summary>
- /// Called after a key-event is received by the view that has had its focus set.
+ /// Called after a key event is received by the view that has had its focus set.
/// </summary>
- /// <param name="key">The key event</param>
- /// <returns>True if the key event should be consumed</returns>
+ /// <param name="key">The key event.</param>
+ /// <returns>True if the key event should be consumed.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool OnKey(Key key)
{
return false; // Do not consume
}
/// <summary>
- /// Called after a wheel-event is received by the owning view.<br>
- /// CustomViewBehaviour.REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br>
+ /// Called after a wheel event is received by the owning view.<br />
+ /// CustomViewBehaviour.REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br />
/// </summary>
- /// <param name="wheel">The wheel event</param>
- /// <returns>True if the wheel event should be consumed</returns>
+ /// <param name="wheel">The wheel event.</param>
+ /// <returns>True if the wheel event should be consumed.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool OnWheel(Wheel wheel)
{
return false; // Do not consume
}
/// <summary>
- /// Called after the size negotiation has been finished for this control.<br>
- /// The control is expected to assign this given size to itself/its children.<br>
- /// Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize or after changing specific properties.<br>
- /// As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).<br>
+ /// Called after the size negotiation has been finished for this control.<br />
+ /// The control is expected to assign this given size to itself or its children.<br />
+ /// Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize, or after changing specific properties.<br />
+ /// As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).<br />
/// </summary>
- /// <param name="size">The allocated size</param>
- /// <param name="container">The control should add views to this container that it is not able to allocate a size for</param>
+ /// <param name="size">The allocated size.</param>
+ /// <param name="container">The control should add views to this container that it is not able to allocate a size for.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnRelayout(Vector2 size, RelayoutContainer container)
{
}
/// <summary>
/// Notification for deriving classes.
/// </summary>
- /// <param name="policy">policy The policy being set</param>
- /// <param name="dimension">dimension The dimension the policy is being set for</param>
+ /// <param name="policy">The policy being set.</param>
+ /// <param name="dimension">The policy is being set for.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnSetResizePolicy(ResizePolicyType policy, DimensionType dimension)
{
}
/// <summary>
- /// Return the natural size of the view.
+ /// Returns the natural size of the view.
/// </summary>
/// <returns>The view's natural size</returns>
- public virtual Size2D GetNaturalSize()
+ /// <since_tizen> 3 </since_tizen>
+ public new virtual Size2D GetNaturalSize()
{
return new Size2D(0, 0);
}
/// <summary>
- /// Calculate the size for a child.
+ /// Calculates the size for a child.
/// </summary>
- /// <param name="child">The child view to calculate the size for</param>
- /// <param name="dimension">The dimension to calculate the size for. E.g. width or height</param>
+ /// <param name="child">The child view to calculate the size for.</param>
+ /// <param name="dimension">The dimension to calculate the size, for example, the width or the height.</param>
/// <returns>Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual float CalculateChildSize(View child, DimensionType dimension)
{
return viewWrapperImpl.CalculateChildSizeBase(child, dimension);
}
/// <summary>
- /// This method is called during size negotiation when a height is required for a given width.<br>
- /// Derived classes should override this if they wish to customize the height returned.<br>
+ /// This method is called during size negotiation when a height is required for a given width.<br />
+ /// Derived classes should override this if they wish to customize the height returned.<br />
/// </summary>
/// <param name="width">Width to use</param>
/// <returns>The height based on the width</returns>
- public virtual float GetHeightForWidth(float width)
+ /// <since_tizen> 3 </since_tizen>
+ public new virtual float GetHeightForWidth(float width)
{
return viewWrapperImpl.GetHeightForWidthBase(width);
}
/// <summary>
- /// This method is called during size negotiation when a width is required for a given height.<br>
- /// Derived classes should override this if they wish to customize the width returned.<br>
+ /// This method is called during size negotiation when a width is required for a given height.<br />
+ /// Derived classes should override this if they wish to customize the width returned.<br />
/// </summary>
/// <param name="height">Height to use</param>
/// <returns>The width based on the width</returns>
- public virtual float GetWidthForHeight(float height)
+ /// <since_tizen> 3 </since_tizen>
+ public new virtual float GetWidthForHeight(float height)
{
return viewWrapperImpl.GetWidthForHeightBase(height);
}
/// <summary>
- /// Determine if this view is dependent on it's children for relayout.
+ /// Determines if this view is dependent on it's children for relayout.
/// </summary>
- /// <param name="dimension">The dimension(s) to check for</param>
- /// <returns>Return if the view is dependent on it's children</returns>
+ /// <param name="dimension">The dimension(s) to check for.</param>
+ /// <returns>Return if the view is dependent on it's children.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool RelayoutDependentOnChildren(DimensionType dimension)
{
return viewWrapperImpl.RelayoutDependentOnChildrenBase(dimension);
}
/// <summary>
- /// Determine if this view is dependent on it's children for relayout from the base class.
+ /// Determines if this view is dependent on it's children for relayout from the base class.
/// </summary>
- /// <returns>Return true if the view is dependent on it's children</returns>
+ /// <returns>Return true if the view is dependent on it's children.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool RelayoutDependentOnChildren()
{
return viewWrapperImpl.RelayoutDependentOnChildrenBase();
}
/// <summary>
- /// Virtual method to notify deriving classes that relayout dependencies have been
+ /// The virtual method to notify deriving classes that relayout dependencies have been
/// met and the size for this object is about to be calculated for the given dimension.
/// </summary>
- /// <param name="dimension">The dimension that is about to be calculated</param>
+ /// <param name="dimension">The dimension that is about to be calculated.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnCalculateRelayoutSize(DimensionType dimension)
{
}
/// <summary>
- /// Virtual method to notify deriving classes that the size for a dimension has just been negotiated.
+ /// The virtual method to notify deriving classes that the size for a dimension has just been negotiated.
/// </summary>
- /// <param name="size">The new size for the given dimension</param>
- /// <param name="dimension">The dimension that was just negotiated</param>
+ /// <param name="size">The new size for the given dimension.</param>
+ /// <param name="dimension">The dimension that was just negotiated.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnLayoutNegotiated(float size, DimensionType dimension)
{
}
/// <summary>
/// This method should be overridden by deriving classes requiring notifications when the style changes.
/// </summary>
- /// <param name="styleManager">The StyleManager object</param>
- /// <param name="change">Information denoting what has changed</param>
+ /// <param name="styleManager">The StyleManager object.</param>
+ /// <param name="change">Information denoting what has changed.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnStyleChange(StyleManager styleManager, StyleChangeType change)
{
}
/// <summary>
- /// This method is called when the control is accessibility activated.<br>
- /// Derived classes should override this to perform custom accessibility activation.<br>
+ /// This method is called when the control accessibility is activated.<br />
+ /// Derived classes should override this to perform custom accessibility activation.<br />
/// </summary>
- /// <returns>true if this control can perform accessibility activation</returns>
+ /// <returns>True if this control can perform accessibility activation.</returns>
internal virtual bool OnAccessibilityActivated()
{
return false;
/// <summary>
/// This method should be overridden by deriving classes when they wish to respond the accessibility.
/// </summary>
- /// <param name="gestures">The pan gesture</param>
- /// <returns>true if the pan gesture has been consumed by this control</returns>
+ /// <param name="gestures">The pan gesture.</param>
+ /// <returns>True if the pan gesture has been consumed by this control.</returns>
internal virtual bool OnAccessibilityPan(PanGesture gestures)
{
return false;
}
/// <summary>
- /// This method should be overridden by deriving classes when they wish to respond the accessibility
+ /// This method should be overridden by deriving classes when they wish to respond the accessibility.
/// </summary>
- /// <param name="touch">The touch gesture</param>
- /// <returns>true if the touch event has been consumed by this control</returns>
+ /// <param name="touch">The touch gesture.</param>
+ /// <returns>True if the touch event has been consumed by this control.</returns>
internal virtual bool OnAccessibilityTouch(Touch touch)
{
return false;
}
/// <summary>
- /// This method should be overridden by deriving classes when they wish to respond the accessibility up and down action (i.e. value change of slider control).
+ /// This method should be overridden by deriving classes when they wish to respond the accessibility up and down action (i.e., value change of slider control).
/// </summary>
- /// <param name="isIncrease">isIncrease Whether the value should be increased or decreased</param>
- /// <returns>true if the value changed action has been consumed by this control</returns>
+ /// <param name="isIncrease">Whether the value should be increased or decreased.</param>
+ /// <returns>True if the value changed action has been consumed by this control.</returns>
internal virtual bool OnAccessibilityValueChange(bool isIncrease)
{
return false;
/// <summary>
/// This method should be overridden by deriving classes when they wish to respond the accessibility zoom action.
/// </summary>
- /// <returns>true if the zoom action has been consumed by this control</returns>
+ /// <returns>True if the zoom action has been consumed by this control.</returns>
internal virtual bool OnAccessibilityZoom()
{
return false;
}
/// <summary>
- /// Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when focus is gained.
+ /// Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is gained.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnFocusGained()
{
}
/// <summary>
- /// Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when focus is lost.
+ /// Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is lost.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnFocusLost()
{
}
/// <summary>
- /// Gets the next keyboard focusable view in this control towards the given direction.<br>
- /// A control needs to override this function in order to support two dimensional keyboard navigation.<br>
+ /// Gets the next keyboard focusable view in this control towards the given direction.<br />
+ /// A control needs to override this function in order to support two dimensional keyboard navigation.<br />
/// </summary>
- /// <param name="currentFocusedView">The current focused view</param>
- /// <param name="direction">The direction to move the focus towards</param>
- /// <param name="loopEnabled">Whether the focus movement should be looped within the control</param>
- /// <returns>the next keyboard focusable view in this control or an empty handle if no view can be focused</returns>
+ /// <param name="currentFocusedView">The current focused view.</param>
+ /// <param name="direction">The direction to move the focus towards.</param>
+ /// <param name="loopEnabled">Whether the focus movement should be looped within the control.</param>
+ /// <returns>The next keyboard focusable view in this control or an empty handle if no view can be focused.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual View GetNextFocusableView(View currentFocusedView, View.FocusDirection direction, bool loopEnabled)
{
return new View();
}
/// <summary>
- /// Informs this control that its chosen focusable view will be focused.<br>
- /// This allows the application to preform any actions if wishes before the focus is actually moved to the chosen view.<br>
+ /// Informs this control that its chosen focusable view will be focused.<br />
+ /// This allows the application to preform any actions it wishes before the focus is actually moved to the chosen view.<br />
/// </summary>
- /// <param name="commitedFocusableView">The commited focused view</param>
+ /// <param name="commitedFocusableView">The commited focused view.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnFocusChangeCommitted(View commitedFocusableView)
{
}
/// <summary>
- /// This method is called when the control has enter pressed on it.<br>
- /// Derived classes should override this to perform custom actions.<br>
+ /// This method is called when the control has enter pressed on it.<br />
+ /// Derived classes should override this to perform custom actions.<br />
/// </summary>
- /// <returns>true if this control supported this action</returns>
+ /// <returns>True if this control supported this action.</returns>
+ /// <since_tizen> 3 </since_tizen>
public virtual bool OnKeyboardEnter()
{
return false;
}
/// <summary>
- /// Called whenever a pinch gesture is detected on this control.<br>
- /// This can be overridden by deriving classes when pinch detection is enabled. The default behaviour is to scale the control by the pinch scale.<br>
- /// If overridden, then the default behaviour will not occur.<br>
- /// Pinch detection should be enabled via EnableGestureDetection().<br>
+ /// Called whenever a pinch gesture is detected on this control.<br />
+ /// This can be overridden by deriving classes when pinch detection is enabled. The default behavior is to scale the control by the pinch scale.<br />
+ /// If overridden, then the default behavior will not occur.<br />
+ /// Pinch detection should be enabled via EnableGestureDetection().<br />
/// </summary>
- /// <param name="pinch">pinch tap gesture</param>
+ /// <param name="pinch">The pinch tap gesture.</param>
internal virtual void OnPinch(PinchGesture pinch)
{
}
/// <summary>
- /// Called whenever a pan gesture is detected on this control.<br>
- /// This should be overridden by deriving classes when pan detection is enabled.<br>
- /// There is no default behaviour with panning.<br>
- /// Pan detection should be enabled via EnableGestureDetection().<br>
+ /// Called whenever a pan gesture is detected on this control.<br />
+ /// This should be overridden by deriving classes when pan detection is enabled.<br />
+ /// There is no default behavior with panning.<br />
+ /// Pan detection should be enabled via EnableGestureDetection().<br />
/// </summary>
- /// <param name="pan">The pan gesture</param>
+ /// <param name="pan">The pan gesture.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnPan(PanGesture pan)
{
}
/// <summary>
- /// Called whenever a tap gesture is detected on this control.<br>
- /// This should be overridden by deriving classes when tap detection is enabled.<br>
- /// There is no default behaviour with a tap.<br>
- /// Tap detection should be enabled via EnableGestureDetection().<br>
+ /// Called whenever a tap gesture is detected on this control.<br />
+ /// This should be overridden by deriving classes when tap detection is enabled.<br />
+ /// There is no default behavior with a tap.<br />
+ /// Tap detection should be enabled via EnableGestureDetection().<br />
/// </summary>
- /// <param name="tap">The tap gesture</param>
+ /// <param name="tap">The tap gesture.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void OnTap(TapGesture tap)
{
}
/// <summary>
- /// Called whenever a long press gesture is detected on this control.<br>
- /// This should be overridden by deriving classes when long press detection is enabled.<br>
- /// There is no default behaviour associated with a long press.<br>
- /// Long press detection should be enabled via EnableGestureDetection().<br>
+ /// Called whenever a long press gesture is detected on this control.<br />
+ /// This should be overridden by deriving classes when long press detection is enabled.<br />
+ /// There is no default behavior associated with a long press.<br />
+ /// Long press detection should be enabled via EnableGestureDetection().<br />
/// </summary>
- /// <param name="longPress">The long press gesture</param>
+ /// <param name="longPress">The long press gesture.</param>
internal virtual void OnLongPress(LongPressGesture longPress)
{
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.BaseComponents
{
/// <summary>
- /// FlexContainer implements a subset of the flexbox spec (defined by W3C):https://www.w3.org/TR/css3-flexbox/<br>
- /// It aims at providing a more efficient way to lay out, align and distribute space among items in the container, even when their size is unknown or dynamic.<br>
- /// FlexContainer has the ability to alter the width and height of its children (i.e. flex items) to fill the available space in the best possible way on different screen sizes.<br>
- /// FlexContainer can expand items to fill available free space, or shrink them to prevent overflow.<br>
+ /// FlexContainer implements a subset of the flexbox spec (defined by W3C):https://www.w3.org/TR/css3-flexbox/<br />
+ /// It aims at providing a more efficient way to layout, align, and distribute space among items in the container, even when their size is unknown or dynamic.<br />
+ /// FlexContainer has the ability to alter the width and the height of its children (i.e., flex items) to fill the available space in the best possible way on different screen sizes.<br />
+ /// FlexContainer can expand items to fill available free space, or shrink them to prevent overflow.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FlexContainer : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// To make the FlexContainer instance be disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
- internal class Property
+ internal new class Property
{
internal static readonly int CONTENT_DIRECTION = NDalicPINVOKE.FlexContainer_Property_CONTENT_DIRECTION_get();
internal static readonly int FLEX_DIRECTION = NDalicPINVOKE.FlexContainer_Property_FLEX_DIRECTION_get();
/// <summary>
/// Enumeration for the instance of child properties belonging to the FlexContainer class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ChildProperty
{
internal static readonly int FLEX = NDalicPINVOKE.FlexContainer_ChildProperty_FLEX_get();
/// Creates a FlexContainer handle.
/// Calling member functions with an uninitialized handle is not allowed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public FlexContainer() : this(NDalicPINVOKE.FlexContainer_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Enumeration for the direction of the main axis in the flex container. This determines
/// the direction that flex items are laid out in the flex container.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum FlexDirectionType
{
+ /// <summary>
+ /// The flexible items are displayed vertically as a column.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Column,
+ /// <summary>
+ /// The flexible items are displayed vertically as a column, but in reverse order.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
ColumnReverse,
+ /// <summary>
+ /// The flexible items are displayed horizontally as a row.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Row,
+ /// <summary>
+ /// The flexible items are displayed horizontally as a row.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RowReverse
}
/// Enumeration for the primary direction in which content is ordered in the flex container
/// and on which sides the ?�start??and ?�end??are.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ContentDirectionType
{
+ /// <summary>
+ /// Inherits the same direction from the parent.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Inherit,
+ /// <summary>
+ /// From left to right.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LTR,
+ /// <summary>
+ /// From right to left.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RTL
}
/// <summary>
/// Enumeration for the alignment of the flex items when the items do not use all available
- /// space on the main-axis.
+ /// space on the main axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Justification
{
+ /// <summary>
+ /// Items are positioned at the beginning of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
JustifyFlexStart,
+ /// <summary>
+ /// Items are positioned at the center of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
JustifyCenter,
+ /// <summary>
+ /// Items are positioned at the end of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
JustifyFlexEnd,
+ /// <summary>
+ /// Items are positioned with equal space between the lines.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
JustifySpaceBetween,
+ /// <summary>
+ /// Items are positioned with equal space before, between, and after the lines.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
JustifySpaceAround
}
/// <summary>
/// Enumeration for the alignment of the flex items or lines when the items or lines do not
- /// use all the available space on the cross-axis.
+ /// use all the available space on the cross axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Alignment
{
+ /// <summary>
+ /// Inherits the same alignment from the parent (only valid for "alignSelf" property).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
AlignAuto,
+ /// <summary>
+ /// At the beginning of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
AlignFlexStart,
+ /// <summary>
+ /// At the center of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
AlignCenter,
+ /// <summary>
+ /// At the end of the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
AlignFlexEnd,
+ /// <summary>
+ /// Stretch to fit the container.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
AlignStretch
}
/// Enumeration for the wrap type of the flex container when there is no enough room for
/// all the items on one flex line.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WrapType
{
+ /// <summary>
+ /// Flex items laid out in single line (shrunk to fit the flex container along the main axis).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NoWrap,
+ /// <summary>
+ /// Flex items laid out in multiple lines if needed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Wrap
}
/// <summary>
- /// The primary direction in which content is ordered
+ /// The primary direction in which content is ordered.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ContentDirectionType ContentDirection
{
get
}
/// <summary>
- /// The direction of the main-axis which determines the direction that flex items are laid out
+ /// The direction of the main axis which determines the direction that flex items are laid out.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public FlexDirectionType FlexDirection
{
get
}
/// <summary>
- /// Whether the flex items should wrap or not if there is no enough room for them on one flex line
+ /// Whether the flex items should wrap or not if there is no enough room for them on one flex line.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public WrapType FlexWrap
{
get
}
/// <summary>
- /// The alignment of flex items when the items do not use all available space on the main-axis
+ /// The alignment of flex items when the items do not use all available space on the main axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Justification JustifyContent
{
get
}
/// <summary>
- /// The alignment of flex items when the items do not use all available space on the cross-axis
+ /// The alignment of flex items when the items do not use all available space on the cross axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Alignment AlignItems
{
get
}
/// <summary>
- /// Similar to "alignItems", but it aligns flex lines, so only works when there are multiple lines
+ /// Similar to "alignItems", but it aligns flex lines; so only works when there are multiple lines.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Alignment AlignContent
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
- using System;
- using System.Runtime.InteropServices;
/// <summary>
- /// ImageView is a class for displaying an image resource.<br>
- /// An instance of ImageView can be created using a URL or an Image instance.<br>
+ /// ImageView is a class for displaying an image resource.<br />
+ /// An instance of ImageView can be created using a URL or an image instance.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImageView : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// Event arguments of resource ready.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ResourceReadyEventArgs : EventArgs
{
private View _view;
/// <summary>
/// The view whose resource is ready.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
private ResourceReadyEventCallbackType _resourceReadyEventCallback;
/// <summary>
- /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
- /// This signal is emitted after all resources required by a control are loaded and ready.<br>
- /// Most resources are only loaded when the control is placed on stage.<br>
+ /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br />
+ /// This signal is emitted after all resources required by a control are loaded and ready.<br />
+ /// Most resources are only loaded when the control is placed on the stage.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ResourceReadyEventArgs> ResourceReady
{
add
private void OnResourceReady(IntPtr data)
{
ResourceReadyEventArgs e = new ResourceReadyEventArgs();
- if(data != null)
+ if (data != null)
{
e.View = Registry.GetManagedBaseHandleFromNativePtr(data) as View;
}
}
}
- //you can override it to clean-up your own resources.
+ /// <summary>
+ /// you can override it to clean-up your own resources.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
return;
}
- if(type == DisposeTypes.Explicit)
+ if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
base.Dispose(type);
}
- internal class Property
+ internal new class Property
{
internal static readonly int RESOURCE_URL = NDalicPINVOKE.ImageView_Property_RESOURCE_URL_get();
internal static readonly int IMAGE = NDalicPINVOKE.ImageView_Property_IMAGE_get();
/// <summary>
/// Creates an initialized ImageView.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an initialized ImageView from an URL to an image resource.<br>
- /// If the string is empty, ImageView will not display anything.<br>
+ /// Creates an initialized ImageView from a URL to an image resource.<br />
+ /// If the string is empty, ImageView will not display anything.<br />
/// </summary>
- /// <param name="url">The url of the image resource to display</param>
+ /// <param name="url">The URL of the image resource to display.</param>
+ /// <since_tizen> 3 </since_tizen>
public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
{
_url = url;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to imageView handle.
+ /// </summary>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
+ "Like: " +
+ "BaseHandle handle = new ImageView(imagePath); " +
+ "ImageView image = handle as ImageView")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static ImageView DownCast(BaseHandle handle)
{
- ImageView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ImageView;
+ ImageView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ImageView;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+
/// <summary>
- /// Sets this ImageView from the given URL.<br>
- /// If the URL is empty, ImageView will not display anything.<br>
+ /// Sets this ImageView from the given URL.<br />
+ /// If the URL is empty, ImageView will not display anything.<br />
/// </summary>
- /// <param name="url">The URL to the image resource to display</param>
+ /// <param name="url">The URL to the image resource to display.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetImage(string url)
{
_url = url;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- internal ViewResourceReadySignal ResourceReadySignal(View view) {
+ internal ViewResourceReadySignal ResourceReadySignal(View view)
+ {
ViewResourceReadySignal ret = new ViewResourceReadySignal(NDalicPINVOKE.ResourceReadySignal(View.getCPtr(view)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// <summary>
- /// Query if all resources required by a control are loaded and ready.<br>
- /// Most resources are only loaded when the control is placed on stage.<br>
- /// true if the resources are loaded and ready, false otherwise.<br>
+ /// Queries if all resources required by a control are loaded and ready.<br />
+ /// Most resources are only loaded when the control is placed on the stage.<br />
+ /// True if the resources are loaded and ready, false otherwise.<br />
/// </summary>
- public bool IsResourceReady()
+ /// <since_tizen> 3 </since_tizen>
+ public new bool IsResourceReady()
{
bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending)
}
/// <summary>
- /// ImageView ResourceUrl, type string
+ /// ImageView ResourceUrl, type string.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string ResourceUrl
{
get
}
/// <summary>
- /// ImageView PreMultipliedAlpha, type Boolean.<br>
- /// Image must be initialized.<br>
+ /// ImageView PreMultipliedAlpha, type Boolean.<br />
+ /// Image must be initialized.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool PreMultipliedAlpha
{
get
}
/// <summary>
- /// ImageView PixelArea, type Vector4 (Animatable property).<br>
- /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br>
+ /// ImageView PixelArea, type Vector4 (Animatable property).<br />
+ /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4 PixelArea
{
get
}
/// <summary>
- /// The border of the image in the order: left, right, bottom, top.<br>
- /// If set, ImageMap will be ignored.<br>
- /// For N-Patch images only.<br>
+ /// The border of the image in the order: left, right, bottom, top.<br />
+ /// If set, ImageMap will be ignored.<br />
+ /// For N-Patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle Border
{
get
}
/// <summary>
- /// Get or set whether to draws the borders only(If true).<br>
- /// If not specified, the default is false.<br>
- /// For N-Patch images only.<br>
+ /// Gets or sets whether to draw the borders only (if true).<br />
+ /// If not specified, the default is false.<br />
+ /// For N-Patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BorderOnly
{
get
}
}
+ /// <summary>
+ /// Gets or sets whether to synchronos loading the resourceurl of image.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SynchronosLoading
{
get
}
}
+ /// <summary>
+ /// Get the loading state of the visual resource.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public ImageView.LoadingStatusType LoadingStatus
{
get
}
}
+ /// <summary>
+ /// Enumeration for LoadingStatus of image.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public enum LoadingStatusType
{
+ /// <summary>
+ /// Loading preparing status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
Preparing,
+ /// <summary>
+ /// Loading ready status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
Ready,
+ /// <summary>
+ /// Loading failed status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
Failed
}
+
private void UpdateImage()
{
if (_url != null)
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.BaseComponents
{
using System;
using System.Runtime.InteropServices;
+ /// <summary>
+ /// Base class for derived Scrollables that contains actors that can be scrolled manually
+ /// (via touch) or automatically.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Scrollable : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// you can override it to clean-up your own resources.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
swigCPtr = currentCPtr;
}
+ /// <summary>
+ /// The scroll animation started event arguments.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StartedEventArgs : EventArgs
{
private Vector2 _vector2;
+ /// <summary>
+ /// Vector2.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Vector2
{
get
}
}
+ /// <summary>
+ /// The scrollable updated event arguments.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class UpdatedEventArgs : EventArgs
{
private Vector2 _vector2;
+ /// <summary>
+ /// Vector2.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Vector2
{
get
}
}
+ /// <summary>
+ /// The scroll animation completed event arguments.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class CompletedEventArgs : EventArgs
{
private Vector2 _vector2;
+ /// <summary>
+ /// Vector2.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Vector2
{
get
private DaliEventHandler<object, CompletedEventArgs> _scrollableCompletedEventHandler;
private CompletedCallbackDelegate _scrollableCompletedCallbackDelegate;
+ /// <summary>
+ /// The ScrollStarted event emitted when the Scrollable has moved (whether by touch or animation).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event DaliEventHandler<object, StartedEventArgs> ScrollStarted
{
add
}
+ /// <summary>
+ /// The ScrollUpdated event emitted when the Scrollable has moved (whether by touch or animation).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event DaliEventHandler<object, UpdatedEventArgs> ScrollUpdated
{
add
}
+ /// <summary>
+ /// The ScrollCompleted event emitted when the Scrollable has completed movement
+ /// (whether by touch or animation).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event DaliEventHandler<object, CompletedEventArgs> ScrollCompleted
{
add
}
-
- public class Property
+ /// <summary>
+ /// Enumeration for the instance of properties belonging to the Scrollable class.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property
{
+ /// <summary>
+ /// The color of the overshoot effect.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_EFFECT_COLOR = NDalicPINVOKE.Scrollable_Property_OVERSHOOT_EFFECT_COLOR_get();
+ /// <summary>
+ /// The speed of overshoot animation in pixels per second.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_ANIMATION_SPEED = NDalicPINVOKE.Scrollable_Property_OVERSHOOT_ANIMATION_SPEED_get();
+ /// <summary>
+ /// Whether to enables or disable scroll overshoot.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_ENABLED = NDalicPINVOKE.Scrollable_Property_OVERSHOOT_ENABLED_get();
+ /// <summary>
+ /// The size of the overshoot.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_SIZE = NDalicPINVOKE.Scrollable_Property_OVERSHOOT_SIZE_get();
+ /// <summary>
+ /// scrollToAlphaFunction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_TO_ALPHA_FUNCTION = NDalicPINVOKE.Scrollable_Property_SCROLL_TO_ALPHA_FUNCTION_get();
+ /// <summary>
+ /// scrollRelativePosition
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_RELATIVE_POSITION = NDalicPINVOKE.Scrollable_Property_SCROLL_RELATIVE_POSITION_get();
+ /// <summary>
+ /// scrollPositionMin
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MIN = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MIN_get();
+ /// <summary>
+ /// scrollPositionMinX.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MIN_X = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MIN_X_get();
+ /// <summary>
+ /// scrollPositionMinY.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MIN_Y = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MIN_Y_get();
+ /// <summary>
+ /// scrollPositionMax.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MAX = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MAX_get();
+ /// <summary>
+ /// scrollPositionMaxX.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MAX_X = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MAX_X_get();
+ /// <summary>
+ /// scrollPositionMaxY.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_MAX_Y = NDalicPINVOKE.Scrollable_Property_SCROLL_POSITION_MAX_Y_get();
+ /// <summary>
+ /// canScrollVertical
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int CAN_SCROLL_VERTICAL = NDalicPINVOKE.Scrollable_Property_CAN_SCROLL_VERTICAL_get();
+ /// <summary>
+ /// canScrollHorizontal.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int CAN_SCROLL_HORIZONTAL = NDalicPINVOKE.Scrollable_Property_CAN_SCROLL_HORIZONTAL_get();
}
+ /// <summary>
+ /// Create an instance of scrollable.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Scrollable() : this(NDalicPINVOKE.new_Scrollable__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Sets and Gets the color of the overshoot effect.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 OvershootEffectColor
{
get
SetProperty(Scrollable.Property.OVERSHOOT_EFFECT_COLOR, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets the speed of overshoot animation in pixels per second.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float OvershootAnimationSpeed
{
get
SetProperty(Scrollable.Property.OVERSHOOT_ANIMATION_SPEED, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Checks if scroll overshoot has been enabled or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool OvershootEnabled
{
get
SetProperty(Scrollable.Property.OVERSHOOT_ENABLED, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets OvershootSize property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 OvershootSize
{
get
SetProperty(Scrollable.Property.OVERSHOOT_SIZE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets ScrollToAlphaFunction property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int ScrollToAlphaFunction
{
get
SetProperty(Scrollable.Property.SCROLL_TO_ALPHA_FUNCTION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets ScrollRelativePosition property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollRelativePosition
{
get
SetProperty(Scrollable.Property.SCROLL_RELATIVE_POSITION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets ScrollPositionMin property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPositionMin
{
get
SetProperty(Scrollable.Property.SCROLL_POSITION_MIN, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets ScrollPositionMax property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPositionMax
{
get
SetProperty(Scrollable.Property.SCROLL_POSITION_MAX, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets CanScrollVertical property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool CanScrollVertical
{
get
SetProperty(Scrollable.Property.CAN_SCROLL_VERTICAL, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets CanScrollHorizontal property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool CanScrollHorizontal
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
/// <summary>
- /// TableView is a layout container for aligning child actors in a grid like layout.<br>
- /// TableView constrains the x and y position and width and height of the child actors.<br>
- /// z position and depth are left intact so that 3D model actors can also be laid out
- /// in a grid without loosing their depth scaling.<br>
+ /// TableView is a layout container for aligning child actors in a grid like layout.<br />
+ /// TableView constraints the X and the Y position and the width and the height of the child actors.<br />
+ /// The Z position and depth are left intact so that the 3D model actors can also be laid out
+ /// in a grid without loosing their depth scaling.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TableView : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
- internal class Property
+ internal new class Property
{
internal static readonly int ROWS = NDalicPINVOKE.TableView_Property_ROWS_get();
internal static readonly int COLUMNS = NDalicPINVOKE.TableView_Property_COLUMNS_get();
}
/// <summary>
- /// Class to specify layout position for child view.
+ /// Class to specify the layout position for the child view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class CellPosition : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal CellPosition(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~CellPosition()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="rowIndex">The row index initialized</param>
- /// <param name="columnIndex">The column index initialized</param>
- /// <param name="rowSpan">The row span initialized</param>
- /// <param name="columnSpan">The column span initialized</param>
+ /// <param name="rowIndex">The row index initialized.</param>
+ /// <param name="columnIndex">The column index initialized.</param>
+ /// <param name="rowSpan">The row span initialized.</param>
+ /// <param name="columnSpan">The column span initialized.</param>
+ /// <since_tizen> 3 </since_tizen>
public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan, uint columnSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_0(rowIndex, columnIndex, rowSpan, columnSpan), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor to initialise values to defaults for convenience.
+ /// The constructor to initialize values to defaults for convenience.
/// </summary>
- /// <param name="rowIndex">The row index initialized</param>
- /// <param name="columnIndex">The column index initialized</param>
- /// <param name="rowSpan">The row span initialized</param>
+ /// <param name="rowIndex">The row index initialized.</param>
+ /// <param name="columnIndex">The column index initialized.</param>
+ /// <param name="rowSpan">The row span initialized.</param>
+ /// <since_tizen> 3 </since_tizen>
public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_1(rowIndex, columnIndex, rowSpan), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor to initialise values to defaults for convenience.
+ /// The constructor to initialize values to defaults for convenience.
/// </summary>
- /// <param name="rowIndex">The row index initialized</param>
- /// <param name="columnIndex">The column index initialized</param>
+ /// <param name="rowIndex">The row index initialized.</param>
+ /// <param name="columnIndex">The column index initialized.</param>
+ /// <since_tizen> 3 </since_tizen>
public CellPosition(uint rowIndex, uint columnIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_2(rowIndex, columnIndex), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor to initialise values to defaults for convenience.
+ /// The constructor to initialize values to default for convenience.
/// </summary>
- /// <param name="rowIndex">The row index initialized</param>
+ /// <param name="rowIndex">The row index initialized.</param>
+ /// <since_tizen> 3 </since_tizen>
public CellPosition(uint rowIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_3(rowIndex), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Default constructor
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Index of row
+ /// The index of a row.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint rowIndex
{
set
}
/// <summary>
- /// Index of column
+ /// The index of a column.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint columnIndex
{
set
}
/// <summary>
- /// Span of row
+ /// The span of a row.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint rowSpan
{
set
}
/// <summary>
- /// Span of column
+ /// The span of a column.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint columnSpan
{
set
/// <summary>
/// Creates the TableView view.
/// </summary>
- /// <param name="initialRows">initialRows for the table</param>
- /// <param name="initialColumns">initialColumns for the table</param>
+ /// <param name="initialRows">Initial rows for the table.</param>
+ /// <param name="initialColumns">Initial columns for the table.</param>
+ /// <since_tizen> 3 </since_tizen>
public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Copy constructor. Creates another handle that points to the same real object.
+ /// The Copy constructor. Creates another handle that points to the same real object.
/// </summary>
- /// <param name="handle">Handle to copy from</param>
+ /// <param name="handle">Handle to copy from.</param>
+ /// <since_tizen> 3 </since_tizen>
public TableView(TableView handle) : this(NDalicPINVOKE.new_TableView__SWIG_1(TableView.getCPtr(handle)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to TabelView handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static TableView DownCast(BaseHandle handle)
{
TableView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TableView;
}
/// <summary>
- /// Adds a child to the table.<br>
- /// If the row or column index is outside the table, the table gets resized bigger.<br>
+ /// Adds a child to the table.<br />
+ /// If the row or column index is outside the table, the table gets resized bigger.<br />
/// </summary>
- /// <param name="child">The child to add</param>
- /// <param name="position">The position for the child</param>
- /// <returns>Tue if the addition succeeded and false if the cell is already occupied</returns>
+ /// <param name="child">The child to add.</param>
+ /// <param name="position">The position for the child.</param>
+ /// <returns>True if the addition succeeded, and false if the cell is already occupied.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool AddChild(View child, TableView.CellPosition position)
{
bool ret = NDalicPINVOKE.TableView_AddChild(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position));
/// <summary>
/// Returns a child from the given layout position.
/// </summary>
- /// <param name="position">The position in the table</param>
- /// <returns>Child that was in the cell or an uninitialized handle</returns>
+ /// <param name="position">The position in the table.</param>
+ /// <returns>Child that was in the cell or an uninitialized handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetChildAt(TableView.CellPosition position)
{
IntPtr cPtr = NDalicPINVOKE.TableView_GetChildAt(swigCPtr, TableView.CellPosition.getCPtr(position));
/// <summary>
/// Removes a child from the given layout position.
/// </summary>
- /// <param name="position">The position for the child to remove</param>
- /// <returns>Child that was removed or an uninitialized handle</returns>
+ /// <param name="position">The position for the child to remove.</param>
+ /// <returns>Child that was removed or an uninitialized handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View RemoveChildAt(TableView.CellPosition position)
{
IntPtr cPtr = NDalicPINVOKE.TableView_RemoveChildAt(swigCPtr, TableView.CellPosition.getCPtr(position));
/// <summary>
/// Finds the child's layout position.
/// </summary>
- /// <param name="child">The child to search for</param>
- /// <param name="position">The position for the child</param>
- /// <returns>true if the child was included in this TableView</returns>
+ /// <param name="child">The child to search for.</param>
+ /// <param name="position">The position for the child.</param>
+ /// <returns>True if the child was included in this TableView.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool FindChildPosition(View child, TableView.CellPosition position)
{
bool ret = NDalicPINVOKE.TableView_FindChildPosition(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position));
}
/// <summary>
- /// Inserts a new row to given index.
+ /// Inserts a new row to the given index.
/// </summary>
- /// <param name="rowIndex">The rowIndex of the new row</param>
+ /// <param name="rowIndex">The rowIndex of the new row.</param>
+ /// <since_tizen> 3 </since_tizen>
public void InsertRow(uint rowIndex)
{
NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex);
}
/// <summary>
- /// Deletes a row from the given index.<br>
- /// Removed elements are deleted.<br>
+ /// Deletes a row from the given index.<br />
+ /// Removed elements are deleted.<br />
/// </summary>
- /// <param name="rowIndex">The rowIndex of the row to delete</param>
+ /// <param name="rowIndex">The rowIndex of the row to delete.</param>
+ /// <since_tizen> 3 </since_tizen>
public void DeleteRow(uint rowIndex)
{
NDalicPINVOKE.TableView_DeleteRow__SWIG_0(swigCPtr, rowIndex);
/// <summary>
/// Inserts a new column to the given index.
/// </summary>
- /// <param name="columnIndex">The columnIndex of the new column</param>
+ /// <param name="columnIndex">The columnIndex of the new column.</param>
+ /// <since_tizen> 3 </since_tizen>
public void InsertColumn(uint columnIndex)
{
NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex);
}
/// <summary>
- /// Deletes a column from the given index.<br>
- /// Removed elements are deleted.<br>
+ /// Deletes a column from the given index.<br />
+ /// Removed elements are deleted.<br />
/// </summary>
- /// <param name="columnIndex">The columnIndex of the column to delete</param>
+ /// <param name="columnIndex">The columnIndex of the column to delete.</param>
+ /// <since_tizen> 3 </since_tizen>
public void DeleteColumn(uint columnIndex)
{
NDalicPINVOKE.TableView_DeleteColumn__SWIG_0(swigCPtr, columnIndex);
/// <summary>
/// Resizes the TableView.
/// </summary>
- /// <param name="rows">The rows for the table</param>
- /// <param name="columns">The columns for the table</param>
+ /// <param name="rows">The rows for the table.</param>
+ /// <param name="columns">The columns for the table.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Resize(uint rows, uint columns)
{
NDalicPINVOKE.TableView_Resize__SWIG_0(swigCPtr, rows, columns);
}
/// <summary>
- /// Sets horizontal and vertical padding between cells.
+ /// Sets the horizontal and the vertical padding between cells.
/// </summary>
- /// <param name="padding">Width and height</param>
+ /// <param name="padding">Width and height.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetCellPadding(Size2D padding)
{
NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding));
/// <summary>
/// Gets the current padding as width and height.
/// </summary>
- /// <returns>The current padding as width and height</returns>
+ /// <returns>The current padding as width and height.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetCellPadding()
{
Vector2 ret = new Vector2(NDalicPINVOKE.TableView_GetCellPadding(swigCPtr), true);
/// <summary>
/// Specifies this row as fitting its height to its children.
/// </summary>
- /// <param name="rowIndex">The row to set</param>
+ /// <param name="rowIndex">The row to set.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFitHeight(uint rowIndex)
{
NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex);
/// <summary>
/// Checks if the row is a fit row.
/// </summary>
- /// <param name="rowIndex">The row to check</param>
- /// <returns>true if the row is fit</returns>
+ /// <param name="rowIndex">The row to check.</param>
+ /// <returns>True if the row is fit.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsFitHeight(uint rowIndex)
{
bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex);
/// <summary>
/// Specifies this column as fitting its width to its children.
/// </summary>
- /// <param name="columnIndex">The column to set</param>
+ /// <param name="columnIndex">The column to set.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFitWidth(uint columnIndex)
{
NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex);
/// <summary>
/// Checks if the column is a fit column.
/// </summary>
- /// <param name="columnIndex">The column to check</param>
- /// <returns>true if the column is fit</returns>
+ /// <param name="columnIndex">The column to check.</param>
+ /// <returns>True if the column is fit.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsFitWidth(uint columnIndex)
{
bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex);
}
/// <summary>
- /// Sets a row to have fixed height.<br>
- /// Setting a fixed height of 0 has no effect.<br>
+ /// Sets a row to have a fixed height.<br />
+ /// Setting a fixed height of 0 has no effect.<br />
/// </summary>
- /// <param name="rowIndex">The rowIndex for row with fixed height</param>
- /// <param name="height">The height in world coordinate units</param>
+ /// <param name="rowIndex">The rowIndex for row with a fixed height.</param>
+ /// <param name="height">The height in world coordinate units.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFixedHeight(uint rowIndex, float height)
{
NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height);
/// <summary>
/// Gets a row's fixed height.
/// </summary>
- /// <param name="rowIndex">The row index with fixed height</param>
- /// <returns>height The height in world coordinate units</returns>
+ /// <param name="rowIndex">The row index with a fixed height.</param>
+ /// <returns>height The height in world coordinate units.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetFixedHeight(uint rowIndex)
{
float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex);
}
/// <summary>
- /// Sets a row to have relative height. Relative height means percentage of
- /// the remainder of the table height after subtracting Padding and Fixed height rows.<br>
- /// Setting a relative height of 0 has no effect.<br>
+ /// Sets a row to have a relative height. Relative height means percentage of
+ /// the remainder of the table height after subtracting padding and fixed height rows.<br />
+ /// Setting a relative height of 0 has no effect.<br />
/// </summary>
- /// <param name="rowIndex">The rowIndex for row with relative height</param>
- /// <param name="heightPercentage">The height percentage between 0.0f and 1.0f</param>
+ /// <param name="rowIndex">The rowIndex for row with a relative height.</param>
+ /// <param name="heightPercentage">The height percentage between 0.0f and 1.0f.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetRelativeHeight(uint rowIndex, float heightPercentage)
{
NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage);
/// <summary>
/// Gets a row's relative height.
/// </summary>
- /// <param name="rowIndex">The row index with relative height</param>
- /// <returns>Height in percentage units, between 0.0f and 1.0f</returns>
+ /// <param name="rowIndex">The row index with a relative height.</param>
+ /// <returns>Height in percentage units, between 0.0f and 1.0f.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetRelativeHeight(uint rowIndex)
{
float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex);
}
/// <summary>
- /// Sets a column to have fixed width.<br>
- /// Setting a fixed width of 0 has no effect.<br>
+ /// Sets a column to have a fixed width.<br />
+ /// Setting a fixed width of 0 has no effect.<br />
/// </summary>
- /// <param name="columnIndex">The columnIndex for column with fixed width</param>
- /// <param name="width">The width in world coordinate units</param>
+ /// <param name="columnIndex">The columnIndex for column with a fixed width.</param>
+ /// <param name="width">The width in world coordinate units.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFixedWidth(uint columnIndex, float width)
{
NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width);
/// <summary>
/// Gets a column's fixed width.
/// </summary>
- /// <param name="columnIndex">The column index with fixed width</param>
- /// <returns>Width in world coordinate units</returns>
+ /// <param name="columnIndex">The column index with a fixed width.</param>
+ /// <returns>Width in world coordinate units.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetFixedWidth(uint columnIndex)
{
float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex);
}
/// <summary>
- /// Sets a column to have relative width. Relative width means percentage of
- /// the remainder of table width after subtracting Padding and Fixed width columns.<br>
- /// Setting a relative width of 0 has no effect.<br>
+ /// Sets a column to have a relative width. Relative width means percentage of
+ /// the remainder of the table width after subtracting padding and fixed width columns.<br />
+ /// Setting a relative width of 0 has no effect.<br />
/// </summary>
- /// <param name="columnIndex">The columnIndex for column with fixed width</param>
- /// <param name="widthPercentage">The widthPercentage between 0.0f and 1.0f</param>
+ /// <param name="columnIndex">The columnIndex for column with a fixed width.</param>
+ /// <param name="widthPercentage">The widthPercentage between 0.0f and 1.0f.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetRelativeWidth(uint columnIndex, float widthPercentage)
{
NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage);
/// <summary>
/// Gets a column's relative width.
/// </summary>
- /// <param name="columnIndex">The column index with relative width</param>
- /// <returns>Width in percentage units, between 0.0f and 1.0f</returns>
+ /// <param name="columnIndex">The column index with a relative width.</param>
+ /// <returns>Width in percentage units, between 0.0f and 1.0f.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetRelativeWidth(uint columnIndex)
{
float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex);
}
/// <summary>
- /// Sets the alignment on a cell.<br>
- /// Cells without calling this function have the default values of LEFT and TOP respectively.<br>
+ /// Sets the alignment on a cell.<br />
+ /// Cells without calling this function have the default values of left and top respectively.<br />
/// </summary>
- /// <param name="position">The cell to set alignment on</param>
- /// <param name="horizontal">The horizontal alignment</param>
- /// <param name="vertical">The vertical alignment</param>
+ /// <param name="position">The cell to set alignment on.</param>
+ /// <param name="horizontal">The horizontal alignment.</param>
+ /// <param name="vertical">The vertical alignment.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetCellAlignment(TableView.CellPosition position, HorizontalAlignmentType horizontal, VerticalAlignmentType vertical)
{
NDalicPINVOKE.TableView_SetCellAlignment(swigCPtr, TableView.CellPosition.getCPtr(position), (int)horizontal, (int)vertical);
}
/// <summary>
- /// Enumeration for describing how the size of a row / column has been set.
+ /// Enumeration for describing how the size of a row or column has been set.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum LayoutPolicy
{
+ /// <summary>
+ /// Fixed with the given value.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fixed,
+ /// <summary>
+ /// Calculated as percentage of the remainder after subtracting Padding and Fixed height/width.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Relative,
+ /// <summary>
+ /// Default policy, get the remainder of the 100% (after subtracting Fixed, Fit and Relative height/ width) divided evenly between 'fill' rows/columns.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fill,
+ /// <summary>
+ /// Fit around its children.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fit
}
/// <summary>
- /// the amount of rows in the table.
+ /// The amount of rows in the table.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Rows
{
get
}
}
/// <summary>
- /// the amount of columns in the table.
+ /// The amount of columns in the table.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Columns
{
get
}
}
/// <summary>
- /// padding between cells.
+ /// Padding between cells.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 CellPadding
{
get
}
/// <summary>
- /// The number of layout rows
+ /// The number of layout rows.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap LayoutRows
{
get
}
/// <summary>
- /// The number of layout columns
+ /// The number of layout columns.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap LayoutColumns
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
-
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
/// A control which provides a multi-line editable text editor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextEditor : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Event arguments that passed via TextChanged signal.
+ /// Event arguments that passed via the TextChanged signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextChangedEventArgs : EventArgs
{
private TextEditor _textEditor;
/// <summary>
/// TextEditor - is the texteditor control which has the text contents changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextEditor TextEditor
{
get
private TextChangedCallbackDelegate _textEditorTextChangedCallbackDelegate;
/// <summary>
- /// Event for TextChanged signal which can be used to subscribe/unsubscribe the event handler
- /// provided by the user. TextChanged signal is emitted when the text changes.<br>
+ /// An event for the TextChanged signal which can be used to subscribe or unsubscribe the event handler
+ /// provided by the user. The TextChanged signal is emitted when the text changes.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<TextChangedEventArgs> TextChanged
{
add
}
/// <summary>
- /// Event arguments that passed via ScrollStateChanged signal.
+ /// Event arguments that passed via the ScrollStateChanged signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ScrollStateChangedEventArgs : EventArgs
{
private TextEditor _textEditor;
/// <summary>
/// TextEditor - is the texteditor control which has the scroll state changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextEditor TextEditor
{
get
/// <summary>
/// ScrollState - is the texteditor control scroll state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ScrollState ScrollState
{
get
private ScrollStateChangedCallbackDelegate _textEditorScrollStateChangedCallbackDelegate;
/// <summary>
- /// Event for ScrollStateChanged signal which can be used to subscribe/unsubscribe the event handler
- /// provided by the user. ScrollStateChanged signal is emitted when the scroll state changes.<br>
+ /// Event for the ScrollStateChanged signal which can be used to subscribe or unsubscribe the event handler
+ /// provided by the user. The ScrollStateChanged signal is emitted when the scroll state changes.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ScrollStateChangedEventArgs> ScrollStateChanged
{
add
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextEditor_Property_RENDERING_BACKEND_get();
internal static readonly int TEXT = NDalicPINVOKE.TextEditor_Property_TEXT_get();
/// <summary>
/// Creates the TextEditor control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextEditor() : this(NDalicPINVOKE.TextEditor_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to textEditor handle.
+ /// </summary>
+ /// <param name="handle"></param>
+ /// <returns></returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static TextEditor DownCast(BaseHandle handle)
{
TextEditor ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextEditor;
}
/// <summary>
- /// Text property.
+ /// The Text property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Text
{
get
}
/// <summary>
- /// Text color property.
+ /// The TextColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 TextColor
{
get
}
/// <summary>
- /// Font family property.
+ /// The FontFamily property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string FontFamily
{
get
}
/// <summary>
- /// Font style property.
+ /// The FontStyle property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap FontStyle
{
get
}
/// <summary>
- /// Point size property.
+ /// The PointSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PointSize
{
get
}
/// <summary>
- /// Horizontal alignment property.
+ /// The HorizontalAlignment property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public HorizontalAlignment HorizontalAlignment
{
get
}
/// <summary>
- /// Scroll threshold property.
+ /// The ScrollThreshold property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollThreshold
{
get
}
/// <summary>
- /// Scroll speed property.
+ /// The ScrollSpeed property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollSpeed
{
get
}
/// <summary>
- /// Primary cursor color property.
+ /// The PrimaryCursorColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 PrimaryCursorColor
{
get
}
/// <summary>
- /// SecondaryCursorColor property.
+ /// The SecondaryCursorColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 SecondaryCursorColor
{
get
}
/// <summary>
- /// EnableCursorBlink property.
+ /// The EnableCursorBlink property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableCursorBlink
{
get
}
/// <summary>
- /// CursorBlinkInterval property.
+ /// The CursorBlinkInterval property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CursorBlinkInterval
{
get
}
/// <summary>
- /// CursorBlinkDuration property.
+ /// The CursorBlinkDuration property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CursorBlinkDuration
{
get
}
/// <summary>
- /// CursorWidth property.
+ /// The CursorWidth property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int CursorWidth
{
get
}
/// <summary>
- /// GrabHandleImage property.
+ /// The GrabHandleImage property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string GrabHandleImage
{
get
}
/// <summary>
- /// GrabHandlePressedImage property.
+ /// The GrabHandlePressedImage property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string GrabHandlePressedImage
{
get
}
/// <summary>
- /// SelectionHandleImageLeft property.
+ /// The SelectionHandleImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleImageLeft
{
get
}
/// <summary>
- /// SelectionHandleImageRight property.
+ /// The SelectionHandleImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleImageRight
{
get
}
/// <summary>
- /// SelectionHandlePressedImageLeft property.
+ /// The SelectionHandlePressedImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandlePressedImageLeft
{
get
}
/// <summary>
- /// SelectionHandlePressedImageRight property.
+ /// The SelectionHandlePressedImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandlePressedImageRight
{
get
}
/// <summary>
- /// SelectionHandleMarkerImageLeft property.
+ /// The SelectionHandleMarkerImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleMarkerImageLeft
{
get
}
/// <summary>
- /// SelectionHandleMarkerImageRight property.
+ /// The SelectionHandleMarkerImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleMarkerImageRight
{
get
}
/// <summary>
- /// SelectionHighlightColor property.
+ /// The SelectionHighlightColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 SelectionHighlightColor
{
get
}
/// <summary>
- /// DecorationBoundingBox property.
+ /// The DecorationBoundingBox property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle DecorationBoundingBox
{
get
}
/// <summary>
- /// EnableMarkup property.
+ /// The EnableMarkup property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableMarkup
{
get
}
/// <summary>
- /// InputColor property.
+ /// The InputColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 InputColor
{
get
}
/// <summary>
- /// InputFontFamily property.
+ /// The InputFontFamily property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputFontFamily
{
get
}
/// <summary>
- /// InputFontStyle property.
+ /// The InputFontStyle property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap InputFontStyle
{
get
}
/// <summary>
- /// InputPointSize property.
+ /// The InputPointSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float InputPointSize
{
get
}
/// <summary>
- /// LineSpacing property.
+ /// The LineSpacing property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float LineSpacing
{
get
}
/// <summary>
- /// InputLineSpacing property.
+ /// The InputLineSpacing property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float InputLineSpacing
{
get
}
/// <summary>
- /// Underline property.
+ /// The Underline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Underline
{
get
}
/// <summary>
- /// InputUnderline property.
+ /// The InputUnderline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputUnderline
{
get
}
/// <summary>
- /// Shadow property.
+ /// The Shadow property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Shadow
{
get
}
/// <summary>
- /// InputShadow property.
+ /// The InputShadow property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputShadow
{
get
}
/// <summary>
- /// Emboss property.
+ /// The Emboss property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Emboss
{
get
}
/// <summary>
- /// InputEmboss property.
+ /// The InputEmboss property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputEmboss
{
get
}
/// <summary>
- /// Outline property.
+ /// The Outline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Outline
{
get
}
/// <summary>
- /// InputOutline property.
+ /// The InputOutline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputOutline
{
get
}
/// <summary>
- /// SmoothScroll property.
+ /// The SmoothScroll property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SmoothScroll
{
get
}
/// <summary>
- /// SmoothScrollDuration property.
+ /// The SmoothScrollDuration property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SmoothScrollDuration
{
get
}
/// <summary>
- /// EnableScrollBar property.
+ /// The EnableScrollBar property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableScrollBar
{
get
}
/// <summary>
- /// ScrollBarShowDuration property.
+ /// The ScrollBarShowDuration property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollBarShowDuration
{
get
}
/// <summary>
- /// ScrollBarFadeDuration property.
+ /// The ScrollBarFadeDuration property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollBarFadeDuration
{
get
}
/// <summary>
- /// PixelSize property.
+ /// The PixelSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PixelSize
{
get
}
/// <summary>
- /// The line count of text.
+ /// The line count of the text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int LineCount
{
get
/// <summary>
/// The text to display when the TextEditor is empty and inactive.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PlaceholderText
{
get
}
/// <summary>
- /// The placeholder-text color.
+ /// The Placeholder text color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color PlaceholderTextColor
{
get
}
/// <summary>
- /// Enable selection property.
+ /// The EnableSelection property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableSelection
{
get
}
/// <summary>
- /// Placeholder property.
- /// Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size.
+ /// The Placeholder property.
+ /// Gets or sets the placeholder: text, color, font family, font style, point size, and pixel size.
/// </summary>
/// <example>
/// The following example demonstrates how to set the placeholder property.
/// editor.Placeholder = propertyMap;
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Placeholder
{
get
}
/// <summary>
- /// LineWrapMode property.<br>
- /// line wrap mode when the text lines over layout width.<br>
+ /// The LineWrapMode property.<br />
+ /// The line wrap mode when the text lines over the layout width.<br />
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public LineWrapMode LineWrapMode
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
-
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
- /// A control which provides a single-line editable text field.
+ /// A control which provides a single line editable text field.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextField : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
return;
}
- if(type == DisposeTypes.Explicit)
+ if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
}
/// <summary>
- /// Text changed event arguments.
+ /// The TextChanged event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextChangedEventArgs : EventArgs
{
private TextField _textField;
/// <summary>
/// TextField.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextField TextField
{
get
}
/// <summary>
- /// MaxLengthReached event arguments.
+ /// The MaxLengthReached event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class MaxLengthReachedEventArgs : EventArgs
{
private TextField _textField;
/// <summary>
/// TextField.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextField TextField
{
get
private MaxLengthReachedCallbackDelegate _textFieldMaxLengthReachedCallbackDelegate;
/// <summary>
- /// TextChanged event.
+ /// The TextChanged event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<TextChangedEventArgs> TextChanged
{
add
}
/// <summary>
- /// MaxLengthReached event.
+ /// The MaxLengthReached event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<MaxLengthReachedEventArgs> MaxLengthReached
{
add
}
- internal class Property
+ internal new class Property
{
internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextField_Property_RENDERING_BACKEND_get();
internal static readonly int TEXT = NDalicPINVOKE.TextField_Property_TEXT_get();
/// <summary>
/// Creates the TextField control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextField() : this(NDalicPINVOKE.TextField_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to textField handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static TextField DownCast(BaseHandle handle)
{
- TextField ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextField;
+ TextField ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextField;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
/// <summary>
- /// Text property.
+ /// The Text property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Text
{
get
}
/// <summary>
- /// PlaceholderText property.
+ /// The PlaceholderText property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PlaceholderText
{
get
}
/// <summary>
- /// PlaceholderTextFocused property.
+ /// The PlaceholderTextFocused property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PlaceholderTextFocused
{
get
}
/// <summary>
- /// FontFamily property.
+ /// The FontFamily property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string FontFamily
{
get
}
/// <summary>
- /// FontStyle property.
+ /// The FontStyle property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap FontStyle
{
get
}
/// <summary>
- /// PointSize property.
+ /// The PointSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PointSize
{
get
}
/// <summary>
- /// MaxLength property.
+ /// The MaxLength property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int MaxLength
{
get
}
/// <summary>
- /// ExceedPolicy property.
+ /// The ExceedPolicy property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int ExceedPolicy
{
get
}
/// <summary>
- /// HorizontalAlignment property.
+ /// The HorizontalAlignment property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public HorizontalAlignment HorizontalAlignment
{
get
}
/// <summary>
- /// VerticalAlignment property.
+ /// The VerticalAlignment property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VerticalAlignment VerticalAlignment
{
get
}
/// <summary>
- /// TextColor property.
+ /// The TextColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color TextColor
{
get
}
/// <summary>
- /// PlaceholderTextColor property.
+ /// The PlaceholderTextColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 PlaceholderTextColor
{
get
}
/// <summary>
- /// ShadowOffset property.
+ /// The ShadowOffset property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ShadowOffset
{
get
}
/// <summary>
- /// ShadowColor property.
+ /// The ShadowColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 ShadowColor
{
get
}
/// <summary>
- /// PrimaryCursorColor property.
+ /// The PrimaryCursorColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 PrimaryCursorColor
{
get
}
/// <summary>
- /// SecondaryCursorColor property.
+ /// The SecondaryCursorColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 SecondaryCursorColor
{
get
}
/// <summary>
- /// EnableCursorBlink property.
+ /// The EnableCursorBlink property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableCursorBlink
{
get
}
/// <summary>
- /// CursorBlinkInterval property.
+ /// The CursorBlinkInterval property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CursorBlinkInterval
{
get
}
/// <summary>
- /// CursorBlinkDuration property.
+ /// The CursorBlinkDuration property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CursorBlinkDuration
{
get
}
/// <summary>
- /// CursorWidth property.
+ /// The CursorWidth property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int CursorWidth
{
get
}
/// <summary>
- /// GrabHandleImage property.
+ /// The GrabHandleImage property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string GrabHandleImage
{
get
}
/// <summary>
- /// GrabHandlePressedImage property.
+ /// The GrabHandlePressedImage property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string GrabHandlePressedImage
{
get
}
/// <summary>
- /// ScrollThreshold property.
+ /// The ScrollThreshold property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollThreshold
{
get
}
/// <summary>
- /// ScrollSpeed property.
+ /// The ScrollSpeed property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScrollSpeed
{
get
}
/// <summary>
- /// SelectionHandleImageLeft property.
+ /// The SelectionHandleImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleImageLeft
{
get
}
/// <summary>
- /// SelectionHandleImageRight property.
+ /// The SelectionHandleImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleImageRight
{
get
}
/// <summary>
- /// SelectionHandlePressedImageLeft property.
+ /// The SelectionHandlePressedImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandlePressedImageLeft
{
get
}
/// <summary>
- /// SelectionHandlePressedImageRight property.
+ /// The SelectionHandlePressedImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandlePressedImageRight
{
get
}
/// <summary>
- /// SelectionHandleMarkerImageLeft property.
+ /// The SelectionHandleMarkerImageLeft property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleMarkerImageLeft
{
get
}
/// <summary>
- /// SelectionHandleMarkerImageRight property.
+ /// The SelectionHandleMarkerImageRight property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap SelectionHandleMarkerImageRight
{
get
}
/// <summary>
- /// SelectionHighlightColor property.
+ /// The SelectionHighlightColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 SelectionHighlightColor
{
get
}
/// <summary>
- /// DecorationBoundingBox property.
+ /// The DecorationBoundingBox property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle DecorationBoundingBox
{
get
}
/// <summary>
- /// InputMethodSettings property.
+ /// The InputMethodSettings property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap InputMethodSettings
{
get
}
/// <summary>
- /// InputColor property.
+ /// The InputColor property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 InputColor
{
get
}
/// <summary>
- /// EnableMarkup property.
+ /// The EnableMarkup property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableMarkup
{
get
}
/// <summary>
- /// InputFontFamily property.
+ /// The InputFontFamily property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputFontFamily
{
get
}
/// <summary>
- /// InputFontStyle property.
+ /// The InputFontStyle property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap InputFontStyle
{
get
}
/// <summary>
- /// InputPointSize property.
+ /// The InputPointSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float InputPointSize
{
get
}
/// <summary>
- /// Underline property.
+ /// The Underline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Underline
{
get
}
/// <summary>
- /// InputUnderline property.
+ /// The InputUnderline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputUnderline
{
get
}
/// <summary>
- /// Shadow property.
+ /// The Shadow property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Shadow
{
get
}
/// <summary>
- /// InputShadow property.
+ /// The InputShadow property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputShadow
{
get
}
/// <summary>
- /// Emboss property.
+ /// The Emboss property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Emboss
{
get
}
/// <summary>
- /// InputEmboss property.
+ /// The InputEmboss property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputEmboss
{
get
}
/// <summary>
- /// Outline property.
+ /// The Outline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Outline
{
get
}
/// <summary>
- /// InputOutline property.
+ /// The InputOutline property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string InputOutline
{
get
}
/// <summary>
- /// HiddenInputSettings property.
+ /// The HiddenInputSettings property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap HiddenInputSettings
{
get
}
/// <summary>
- /// PixelSize property.
+ /// The PixelSize property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PixelSize
{
get
}
/// <summary>
- /// Enable selection property.
+ /// The Enable selection property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableSelection
{
get
}
/// <summary>
- /// Placeholder property.
- /// Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size.
+ /// The Placeholder property.
+ /// Gets or sets the placeholder: text, color, font family, font style, point size, and pixel size.
/// </summary>
/// <example>
- /// The following example demonstrates how to set the placeholder property.
+ /// The following example demonstrates how to set the Placeholder property.
/// <code>
/// PropertyMap propertyMap = new PropertyMap();
/// propertyMap.Add("text", new PropertyValue("Setting Placeholder Text"));
/// field.Placeholder = propertyMap;
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Placeholder
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
-
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
/// <summary>
- /// A control which renders a short text string.<br>
- /// Text labels are lightweight, non-editable and do not respond to user input.<br>
+ /// A control which renders a short text string.<br />
+ /// Text labels are lightweight, non-editable, and do not respond to the user input.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextLabel : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
- internal class Property
+ internal new class Property
{
internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
internal static readonly int AUTO_SCROLL_LOOP_DELAY = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_DELAY_get();
internal static readonly int LINE_COUNT = NDalicManualPINVOKE.TextLabel_Property_LINE_COUNT_get();
internal static readonly int LINE_WRAP_MODE = NDalicManualPINVOKE.TextLabel_Property_LINE_WRAP_MODE_get();
+
}
/// <summary>
/// Creates the TextLabel control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Creates the TextLabel control.
/// </summary>
/// <param name="text">The text to display</param>
+ /// <since_tizen> 3 </since_tizen>
public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to textLabel handle
+ /// </summary>
+ /// <param name="handle"></param>
+ /// <returns></returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
+ "Like: " +
+ "BaseHandle handle = new TextLabel(\"Hello World!\"); " +
+ "TextLabel label = handle as TextLabel")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static TextLabel DownCast(BaseHandle handle)
{
TextLabel ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextLabel;
+
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// <summary>
- /// Text property.<br>
- /// The text to display in UTF-8 format.<br>
+ /// The Text property.<br />
+ /// The text to display in the UTF-8 format.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Text
{
get
}
/// <summary>
- /// FontFamily property.<br>
- /// The requested font family to use.<br>
+ /// The FontFamily property.<br />
+ /// The requested font family to use.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string FontFamily
{
get
}
/// <summary>
- /// FontStyle property.<br>
- /// The requested font style to use.<br>
+ /// The FontStyle property.<br />
+ /// The requested font style to use.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap FontStyle
{
get
}
/// <summary>
- /// PointSize property.<br>
- /// The size of font in points.<br>
+ /// The PointSize property.<br />
+ /// The size of font in points.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PointSize
{
get
}
/// <summary>
- /// MultiLine property.<br>
- /// The single-line or multi-line layout option.<br>
+ /// The MultiLine property.<br />
+ /// The single-line or multi-line layout option.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool MultiLine
{
get
}
/// <summary>
- /// HorizontalAlignment property.<br>
- /// The line horizontal alignment.<br>
+ /// The HorizontalAlignment property.<br />
+ /// The line horizontal alignment.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public HorizontalAlignment HorizontalAlignment
{
get
}
/// <summary>
- /// VerticalAlignment property.<br>
- /// The line vertical alignment.<br>
+ /// The VerticalAlignment property.<br />
+ /// The line vertical alignment.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VerticalAlignment VerticalAlignment
{
get
}
/// <summary>
- /// TextColor property.<br>
- /// The color of the text.<br>
- /// Animation framework can be used to change the color of the text when not using mark up.<br>
- /// Cannot animate the color when text is auto scrolling.<br>
+ /// The TextColor property.<br />
+ /// The color of the text.<br />
+ /// Animation framework can be used to change the color of the text when not using mark up.<br />
+ /// Cannot animate the color when text is auto scrolling.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color TextColor
{
get
}
/// <summary>
- /// ShadowOffset property.<br>
- /// The drop shadow offset 0 indicates no shadow.<br>
+ /// The ShadowOffset property.<br />
+ /// The drop shadow offset 0 indicates no shadow.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ShadowOffset
{
get
}
/// <summary>
- /// ShadowColor property.<br>
- /// The color of a drop shadow.<br>
+ /// The ShadowColor property.<br />
+ /// The color of a drop shadow.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 ShadowColor
{
get
}
/// <summary>
- /// UnderlineEnabled property.<br>
- /// The underline enabled flag.<br>
+ /// The UnderlineEnabled property.<br />
+ /// The underline enabled flag.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool UnderlineEnabled
{
get
}
/// <summary>
- /// UnderlineColor property.<br>
- /// Overrides the underline height from font metrics.<br>
+ /// The UnderlineColor property.<br />
+ /// Overrides the underline height from font metrics.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 UnderlineColor
{
get
}
/// <summary>
- /// UnderlineHeight property.<br>
- /// Overrides the underline height from font metrics.<br>
+ /// The UnderlineHeight property.<br />
+ /// Overrides the underline height from font metrics.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float UnderlineHeight
{
get
}
/// <summary>
- /// EnableMarkup property.<br>
- /// Whether the mark-up processing is enabled.<br>
+ /// The EnableMarkup property.<br />
+ /// Whether the mark-up processing is enabled.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableMarkup
{
get
}
/// <summary>
- /// EnableAutoScroll property.<br>
- /// Starts or stops auto scrolling.<br>
+ /// The EnableAutoScroll property.<br />
+ /// Starts or stops auto scrolling.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableAutoScroll
{
get
}
/// <summary>
- /// AutoScrollSpeed property.<br>
- /// Sets the speed of scrolling in pixels per second.<br>
+ /// The AutoScrollSpeed property.<br />
+ /// Sets the speed of scrolling in pixels per second.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int AutoScrollSpeed
{
get
}
/// <summary>
- /// AutoScrollLoopCount property.<br>
- /// Number of complete loops when scrolling enabled.<br>
+ /// The AutoScrollLoopCount property.<br />
+ /// Number of complete loops when scrolling enabled.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int AutoScrollLoopCount
{
get
}
/// <summary>
- /// AutoScrollGap property.<br>
- /// Gap before scrolling wraps.<br>
+ /// The AutoScrollGap property.<br />
+ /// Gap before scrolling wraps.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float AutoScrollGap
{
get
}
/// <summary>
- /// LineSpacing property.<br>
- /// The default extra space between lines in points.<br>
+ /// The LineSpacing property.<br />
+ /// The default extra space between lines in points.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float LineSpacing
{
get
}
/// <summary>
- /// Underline property.<br>
- /// The default underline parameters.<br>
+ /// The Underline property.<br />
+ /// The default underline parameters.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Underline
{
get
}
/// <summary>
- /// Shadow property.<br>
- /// The default shadow parameters.<br>
+ /// The Shadow property.<br />
+ /// The default shadow parameters.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Shadow
{
get
}
/// <summary>
- /// Emboss property.<br>
- /// The default emboss parameters.<br>
+ /// The Emboss property.<br />
+ /// The default emboss parameters.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Emboss
{
get
}
/// <summary>
- /// Outline property.<br>
- /// The default outline parameters.<br>
+ /// The Outline property.<br />
+ /// The default outline parameters.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Outline
{
get
}
/// <summary>
- /// PixelSize property.<br>
- /// The size of font in pixels.<br>
+ /// The PixelSize property.<br />
+ /// The size of font in pixels.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PixelSize
{
get
}
/// <summary>
- /// Ellipsis property.<br>
- /// Enable or disable the ellipsis.<br>
+ /// The Ellipsis property.<br />
+ /// Enable or disable the ellipsis.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Ellipsis
{
get
}
/// <summary>
- /// AutoScrollLoopDelay property.<br>
- /// do something.<br>
+ /// The AutoScrollLoopDelay property.<br />
+ /// Do something.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float AutoScrollLoopDelay
{
get
}
/// <summary>
- /// AutoScrollStopMode property.<br>
- /// do something.<br>
+ /// The AutoScrollStopMode property.<br />
+ /// Do something.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AutoScrollStopMode AutoScrollStopMode
{
get
}
/// <summary>
- /// The line count of text.
+ /// The line count of the text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int LineCount
{
get
}
/// <summary>
- /// LineWrapMode property.<br>
- /// line wrap mode when the text lines over layout width.<br>
+ /// The LineWrapMode property.<br />
+ /// line wrap mode when the text lines over layout width.<br />
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public LineWrapMode LineWrapMode
{
get
SetProperty(TextLabel.Property.LINE_WRAP_MODE, new Tizen.NUI.PropertyValue(temp));
}
}
-
}
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.ComponentModel;
+using System.Runtime.InteropServices;
namespace Tizen.NUI.BaseComponents
{
-
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
/// VideoView is a control for video playback and display.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VideoView : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// Event arguments that passed via Finished signal
+ /// Event arguments that passed via the finished signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FinishedEventArgs : EventArgs
{
private VideoView _videoView;
/// <summary>
/// The view for video playback and display.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VideoView VideoView
{
get
/// <summary>
- /// Event for Finished signal which can be used to subscribe/unsubscribe the event handler
- /// (in the type of FinishedEventHandler-DaliEventHandler<object,FinishedEventArgs>) provided by the user.<br>
- /// Finished signal is emitted when a video playback have finished.<br>
+ /// Event for the finished signal which can be used to subscribe or unsubscribe the event handler
+ /// The finished signal is emitted when a video playback has finished.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<FinishedEventArgs> Finished
{
add
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int VIDEO = NDalicPINVOKE.VideoView_Property_VIDEO_get();
internal static readonly int LOOPING = NDalicPINVOKE.VideoView_Property_LOOPING_get();
/// <summary>
/// Creates an initialized VideoView.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VideoView() : this(NDalicPINVOKE.VideoView_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an initialized VideoView.<br>
- /// If the string is empty, VideoView will not display anything.<br>
+ /// Creates an initialized VideoView.<br />
+ /// If the string is empty, VideoView will not display anything.<br />
/// </summary>
- /// <param name="url">The url of the video resource to display</param>
+ /// <param name="url">The URL of the video resource to display.</param>
+ /// <since_tizen> 3 </since_tizen>
public VideoView(string url) : this(NDalicPINVOKE.VideoView_New__SWIG_1(url), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to videoView handle.
+ /// </summary>
+ /// <param name="handle"></param>
+ /// <returns></returns>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static VideoView DownCast(BaseHandle handle)
{
VideoView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as VideoView;
/// <summary>
/// Starts the video playback.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Play()
{
NDalicPINVOKE.VideoView_Play(swigCPtr);
/// <summary>
/// Pauses the video playback.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Pause()
{
NDalicPINVOKE.VideoView_Pause(swigCPtr);
/// <summary>
/// Stops the video playback.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Stop()
{
NDalicPINVOKE.VideoView_Stop(swigCPtr);
/// <summary>
/// Seeks forward by the specified number of milliseconds.
/// </summary>
- /// <param name="millisecond">The position for forward playback</param>
+ /// <param name="millisecond">The position for forward playback.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Forward(int millisecond)
{
NDalicPINVOKE.VideoView_Forward(swigCPtr, millisecond);
/// <summary>
/// Seeks backward by the specified number of milliseconds.
/// </summary>
- /// <param name="millisecond">The position for backward playback</param>
+ /// <param name="millisecond">The position for backward playback.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Backward(int millisecond)
{
NDalicPINVOKE.VideoView_Backward(swigCPtr, millisecond);
}
/// <summary>
- /// video file url as string type or PropertyMap.
+ /// Video file setting type of PropertyMap.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Video
{
get
}
/// <summary>
- /// looping status, true or false.
+ /// The looping status, true or false.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Looping
{
get
}
/// <summary>
- /// mute status, true or false.
+ /// The mute status, true or false.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Muted
{
get
}
/// <summary>
- /// left and right volume scalar as float type, PropertyMap with two values ( "left" and "right" ).
+ /// The left and the right volume scalar as float type, PropertyMap with two values ( "left" and "right" ).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Volume
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.ComponentModel;
+using System.Runtime.InteropServices;
namespace Tizen.NUI.BaseComponents
{
-
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
/// View is the base class for all views.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class View : Container
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
// From Container Base class
/// <summary>
- /// Adds a child view to this View.
+ /// Adds a child view to this view.
/// </summary>
- /// <seealso cref="Container::Add()">
- /// </seealso>
+ /// <seealso cref="Container.Add" />
+ /// <since_tizen> 4 </since_tizen>
public override void Add(View child)
{
NDalicPINVOKE.Actor_Add(swigCPtr, View.getCPtr(child));
}
/// <summary>
- /// Removes a child View from this View. If the view was not a child of this view, this is a no-op.
+ /// Removes a child view from this View. If the view was not a child of this view, this is a no-op.
/// </summary>
- /// <seealso cref="Container::Remove()">
- /// </seealso>
+ /// <seealso cref="Container.Remove" />
+ /// <since_tizen> 4 </since_tizen>
public override void Remove(View child)
{
NDalicPINVOKE.Actor_Remove(swigCPtr, View.getCPtr(child));
}
/// <summary>
- /// Retrieves child view by index.
+ /// Retrieves a child view by index.
/// </summary>
- /// <seealso cref="Container::GetChildAt()">
- /// </seealso>
+ /// <seealso cref="Container.GetChildAt" />
+ /// <since_tizen> 4 </since_tizen>
public override View GetChildAt(uint index)
{
if (index < Children.Count)
/// <summary>
/// Retrieves the number of children held by the view.
/// </summary>
- /// <seealso cref="Container::GetChildCount()">
- /// </seealso>
+ /// <seealso cref="Container.GetChildCount" />
+ /// <since_tizen> 4 </since_tizen>
protected override uint GetChildCount()
{
return Convert.ToUInt32(Children.Count);
}
/// <summary>
- /// Get the Views parent
+ /// Gets the views parent.
/// </summary>
- /// <seealso cref="Container::GetParent()">
-
+ /// <seealso cref="Container.GetParent()" />
+ /// <since_tizen> 4 </since_tizen>
protected override Container GetParent()
{
IntPtr cPtr = NDalicPINVOKE.Actor_GetParent(swigCPtr);
return basehandle as Container;
}
- ///
-
- // you can override it to clean-up your own resources.
+ /// <summary>
+ /// you can override it to clean-up your own resources.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
private KeyInputFocusGainedCallbackType _keyInputFocusGainedCallback;
/// <summary>
- /// Event for KeyInputFocusGained signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// KeyInputFocusGained signal is emitted when the control gets Key Input Focus.<br>
+ /// An event for the KeyInputFocusGained signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The KeyInputFocusGained signal is emitted when the control gets the key input focus.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler FocusGained
{
add
private KeyInputFocusLostCallbackType _keyInputFocusLostCallback;
/// <summary>
- /// Event for KeyInputFocusLost signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// KeyInputFocusLost signal is emitted when the control loses Key Input Focus.<br>
+ /// An event for the KeyInputFocusLost signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The KeyInputFocusLost signal is emitted when the control loses the key input focus.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler FocusLost
{
add
}
/// <summary>
- /// Event arguments that passed via KeyEvent signal.
+ /// Event arguments that passed via the KeyEvent signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class KeyEventArgs : EventArgs
{
private Key _key;
/// <summary>
- /// Key - is the key sent to the View.
+ /// Key - is the key sent to the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Key Key
{
get
private KeyCallbackType _keyCallback;
/// <summary>
- /// Event for KeyPressed signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// KeyPressed signal is emitted when key event is received.<br>
+ /// An event for the KeyPressed signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The KeyPressed signal is emitted when the key event is received.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, KeyEventArgs, bool> KeyEvent
{
add
private OnRelayoutEventCallbackType _onRelayoutEventCallback;
/// <summary>
- /// Event for OnRelayout signal which can be used to subscribe/unsubscribe the event handler.<br>
- /// OnRelayout signal is emitted after the size has been set on the view during relayout.<br>
+ /// An event for the OnRelayout signal which can be used to subscribe or unsubscribe the event handler.<br />
+ /// The OnRelayout signal is emitted after the size has been set on the view during relayout.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Relayout
{
add
}
/// <summary>
- /// Event arguments that passed via Touch signal.
+ /// Event arguments that passed via the touch signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TouchEventArgs : EventArgs
{
private Touch _touch;
/// <summary>
- /// Touch - contains the information of touch points
+ /// Touch - contains the information of touch points.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Touch Touch
{
get
private TouchDataCallbackType _touchDataCallback;
/// <summary>
- /// Event for Touched signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// Touched signal is emitted when touch input is received.<br>
+ /// An event for the touched signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The touched signal is emitted when the touch input is received.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, TouchEventArgs, bool> TouchEvent
{
add
/// <summary>
- /// Event arguments that passed via Hover signal.
+ /// Event arguments that passed via the hover signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class HoverEventArgs : EventArgs
{
private Hover _hover;
/// <summary>
/// Hover - contains touch points that represent the points that are currently being hovered or the points where a hover has stopped.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Hover Hover
{
get
private HoverEventCallbackType _hoverEventCallback;
/// <summary>
- /// Event for Hovered signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// Hovered signal is emitted when hover input is received.<br>
+ /// An event for the hovered signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The hovered signal is emitted when the hover input is received.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, HoverEventArgs, bool> HoverEvent
{
add
/// <summary>
- /// Event arguments that passed via Wheel signal.
+ /// Event arguments that passed via the wheel signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class WheelEventArgs : EventArgs
{
private Wheel _wheel;
/// <summary>
- /// WheelEvent - store a wheel rolling type : MOUSE_WHEEL or CUSTOM_WHEEL
+ /// WheelEvent - store a wheel rolling type: MOUSE_WHEEL or CUSTOM_WHEEL.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel Wheel
{
get
private WheelEventCallbackType _wheelEventCallback;
/// <summary>
- /// Event for WheelMoved signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// WheelMoved signal is emitted when wheel event is received.<br>
+ /// An event for the WheelMoved signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// The WheelMoved signal is emitted when the wheel event is received.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, WheelEventArgs, bool> WheelEvent
{
add
private OnWindowEventCallbackType _onWindowEventCallback;
/// <summary>
- /// Event for OnWindow signal which can be used to subscribe/unsubscribe the event handler.<br>
- /// OnWindow signal is emitted after the view has been connected to the Window.<br>
+ /// An event for the OnWindow signal which can be used to subscribe or unsubscribe the event handler.<br />
+ /// The OnWindow signal is emitted after the view has been connected to the window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler AddedToWindow
{
add
private OffWindowEventCallbackType _offWindowEventCallback;
/// <summary>
- /// Event for OffWindow signal which can be used to subscribe/unsubscribe the event handler.<br>
- /// OffWindow signal is emitted after the view has been disconnected from the Window.<br>
+ /// An event for the OffWindow signal, which can be used to subscribe or unsubscribe the event handler.<br />
+ /// OffWindow signal is emitted after the view has been disconnected from the window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler RemovedFromWindow
{
add
/// <summary>
/// Event arguments of visibility changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VisibilityChangedEventArgs : EventArgs
{
private View _view;
/// <summary>
/// The view, or child of view, whose visibility has changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
/// <summary>
/// Whether the view is now visible or not.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Visibility
{
get
/// <summary>
/// Whether the view's visible property has changed or a parent's.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisibilityChangeType Type
{
get
private VisibilityChangedEventCallbackType _visibilityChangedEventCallback;
/// <summary>
- /// Event for visibility change which can be used to subscribe/unsubscribe the event handler.<br>
- /// This signal is emitted when the visible property of this or a parent view is changed.<br>
+ /// An event for visibility change which can be used to subscribe or unsubscribe the event handler.<br />
+ /// This signal is emitted when the visible property of this or a parent view is changed.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<VisibilityChangedEventArgs> VisibilityChanged
{
add
private ResourcesLoadedCallbackType _ResourcesLoadedCallback;
/// <summary>
- /// Event for ResourcesLoadedSignal signal which can be used to subscribe/unsubscribe the event handler provided by the user.<br>
- /// This signal is emitted after all resources required by a View are loaded and ready.<br>
+ /// An event for the ResourcesLoadedSignal signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
+ /// This signal is emitted after all resources required by a view are loaded and ready.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler ResourcesLoaded
{
add
/// <summary>
/// Describes the direction to move the focus towards.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum FocusDirection
{
+ /// <summary>
+ /// Move keyboard focus towards the left direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Left,
+ /// <summary>
+ /// Move keyboard focus towards the right direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Right,
+ /// <summary>
+ /// Move keyboard focus towards the up direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Up,
+ /// <summary>
+ /// Move keyboard focus towards the down direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Down,
+ /// <summary>
+ /// Move keyboard focus towards the previous page direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PageUp,
+ /// <summary>
+ /// Move keyboard focus towards the next page direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PageDown
}
/// <summary>
- /// Creates a new instance of a View.
+ /// Creates a new instance of a view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View() : this(NDalicPINVOKE.View_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Downcasts a handle to View handle.<br>
- /// If handle points to a View, the downcast produces valid handle.<br>
- /// If not, the returned handle is left uninitialized.<br>
+ /// Downcasts a handle to view handle.<br />
+ /// If handle points to a view, the downcast produces a valid handle.<br />
+ /// If not, the returned handle is left uninitialized.<br />
/// </summary>
- /// <param name="handle">Handle to an object</param>
- /// <returns>A handle to a View or an uninitialized handle</returns>
- [Obsolete("Please do not use! this will be deprecated, instead please us as keyword.")]
- public new static View DownCast(BaseHandle handle)
+ /// <param name="handle">A handle to an object.</param>
+ /// <returns>A handle to a view or an uninitialized handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static View DownCast(BaseHandle handle)
{
View ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as View;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
- [Obsolete("Please do not use! this will be deprecated, instead please us as keyword.")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated, instead please use as keyword.")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static T DownCast<T>(View view) where T : View
{
T ret = Registry.GetManagedBaseHandleFromNativePtr(view) as T;
}
/// <summary>
- /// Quries whether the view has focus.
+ /// Queries whether the view has a focus.
/// </summary>
- /// <returns>true if this view has focus</returns>
+ /// <returns>True if this view has a focus.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool HasFocus()
{
bool ret = NDalicPINVOKE.View_HasKeyInputFocus(swigCPtr);
/// <summary>
/// Sets the name of the style to be applied to the view.
/// </summary>
- /// <param name="styleName">A string matching a style described in a stylesheet</param>
+ /// <param name="styleName">A string matching a style described in a stylesheet.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetStyleName(string styleName)
{
NDalicPINVOKE.View_SetStyleName(swigCPtr, styleName);
/// <summary>
/// Retrieves the name of the style to be applied to the view (if any).
/// </summary>
- /// <returns>A string matching a style, or an empty string</returns>
+ /// <returns>A string matching a style, or an empty string.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetStyleName()
{
string ret = NDalicPINVOKE.View_GetStyleName(swigCPtr);
/// <summary>
/// Clears the background.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void ClearBackground()
{
NDalicPINVOKE.View_ClearBackground(swigCPtr);
}
/// <summary>
- /// styleName, type string.
+ /// The StyleName, type string.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string StyleName
{
get
}
/// <summary>
- /// mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4.
+ /// The mutually exclusive with BACKGROUND_IMAGE and BACKGROUND type Vector4.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color BackgroundColor
{
get
}
/// <summary>
- /// Create an Animation to animate the background color visual. If there is no
+ /// Creates an animation to animate the background color visual. If there is no
/// background visual, creates one with transparent black as it's mixColor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Animation AnimateBackgroundColor( object destinationValue,
int startTime,
int endTime,
}
/// <summary>
- /// Create an Animation to animate the mixColor of the named visual.
+ /// Creates an animation to animate the mixColor of the named visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Animation AnimateColor( string targetVisual, object destinationColor, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialColor = null )
{
Animation animation = null;
}
/// <summary>
- /// mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map.
+ /// The mutually exclusive with BACKGROUND_COLOR and BACKGROUND type Map.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string BackgroundImage
{
get
}
}
+ /// <summary>
+ /// The background of view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Background
{
get
/// <summary>
/// The current state of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public States State
{
get
/// <summary>
/// The current sub state of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public States SubState
{
get
/// <summary>
/// Displays a tooltip
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Tooltip
{
get
}
/// <summary>
- /// Displays a tooltip as Text
+ /// Displays a tooltip as a text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TooltipText
{
set
}
/// <summary>
- /// Child Property of FlexContainer.<br>
- /// The proportion of the free space in the container the flex item will receive.<br>
- /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br>
+ /// The Child property of FlexContainer.<br />
+ /// The proportion of the free space in the container, the flex item will receive.<br />
+ /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Flex
{
get
}
/// <summary>
- /// Child Property of FlexContainer.<br>
- /// The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container.<br>
+ /// The Child property of FlexContainer.<br />
+ /// The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int AlignSelf
{
get
}
/// <summary>
- /// Child Property of FlexContainer.<br>
- /// The space around the flex item.<br>
+ /// The Child property of FlexContainer.<br />
+ /// The space around the flex item.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 FlexMargin
{
get
}
/// <summary>
- /// The top-left cell this child occupies, if not set, the first available cell is used
+ /// The top-left cell this child occupies, if not set, the first available cell is used.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 CellIndex
{
get
}
/// <summary>
- /// The number of rows this child occupies, if not set, default value is 1
+ /// The number of rows this child occupies, if not set, the default value is 1.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float RowSpan
{
get
}
/// <summary>
- /// The number of columns this child occupies, if not set, default value is 1
+ /// The number of columns this child occupies, if not set, the default value is 1.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ColumnSpan
{
get
}
/// <summary>
- /// The horizontal alignment of this child inside the cells, if not set, default value is 'left'
+ /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
{
get
}
/// <summary>
- /// The vertical alignment of this child inside the cells, if not set, default value is 'top'
+ /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
{
get
}
/// <summary>
- /// The left focusable view.<br>
- /// This will return NULL if not set.<br>
- /// This will also return NULL if the specified left focusable view is not on Window.<br>
+ /// The left focusable view.<br />
+ /// This will return null if not set.<br />
+ /// This will also return null if the specified left focusable view is not on a window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View LeftFocusableView
{
// As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
}
/// <summary>
- /// The right focusable view.<br>
- /// This will return NULL if not set.<br>
- /// This will also return NULL if the specified right focusable view is not on Window.<br>
+ /// The right focusable view.<br />
+ /// This will return null if not set.<br />
+ /// This will also return null if the specified right focusable view is not on a window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View RightFocusableView
{
// As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
}
/// <summary>
- /// The up focusable view.<br>
- /// This will return NULL if not set.<br>
- /// This will also return NULL if the specified up focusable view is not on Window.<br>
+ /// The up focusable view.<br />
+ /// This will return null if not set.<br />
+ /// This will also return null if the specified up focusable view is not on a window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View UpFocusableView
{
// As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
}
/// <summary>
- /// The down focusable view.<br>
- /// This will return NULL if not set.<br>
- /// This will also return NULL if the specified down focusable view is not on Window.<br>
+ /// The down focusable view.<br />
+ /// This will return null if not set.<br />
+ /// This will also return null if the specified down focusable view is not on a window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View DownFocusableView
{
// As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
}
/// <summary>
- /// whether the view should be focusable by keyboard navigation.
+ /// Whether the view should be focusable by keyboard navigation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Focusable
{
set
}
/// <summary>
- /// Enumeration for describing the states of view.
+ /// Enumeration for describing the states of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum States
{
/// <summary>
- /// Normal state
+ /// The normal state.
/// </summary>
Normal,
/// <summary>
- /// Focused state
+ /// The focused state.
/// </summary>
Focused,
/// <summary>
- /// Disabled state
+ /// The disabled state.
/// </summary>
Disabled
}
/// <summary>
- /// Retrieves the position of the View.<br>
- /// The coordinates are relative to the View's parent.<br>
+ /// Retrieves the position of the view.<br />
+ /// The coordinates are relative to the view's parent.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position CurrentPosition
{
get
}
/// <summary>
- /// Sets the size of an view for width and height.<br>
- /// Geometry can be scaled to fit within this area.<br>
- /// This does not interfere with the views scale factor.<br>
- /// The views default depth is the minimum of width & height.<br>
+ /// Sets the size of a view for the width and the height.<br />
+ /// Geometry can be scaled to fit within this area.<br />
+ /// This does not interfere with the view's scale factor.<br />
+ /// The views default depth is the minimum of width and height.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D Size2D
{
get
}
/// <summary>
- /// Retrieves the size of the View.<br>
- /// The coordinates are relative to the View's parent.<br>
+ /// Retrieves the size of the view.<br />
+ /// The coordinates are relative to the view's parent.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D CurrentSize
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated. Please use Visibility instead.")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated. Please use Visibility instead.")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use Visibility instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public bool Visible
{
get
}
/// <summary>
- /// Retrieves and sets the view's opacity.<br>
+ /// Retrieves and sets the view's opacity.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Opacity
{
get
}
/// <summary>
- /// Sets the position of the View for X and Y.<br>
- /// By default, sets the position vector between the parent origin and pivot point(default).<br>
- /// If Position inheritance if disabled, sets the world position.<br>
+ /// Sets the position of the view for X and Y.<br />
+ /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
+ /// If the position inheritance is disabled, sets the world position.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position2D Position2D
{
get
}
/// <summary>
- /// Retrieves screen postion of view's.<br>
+ /// Retrieves the screen postion of the view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenPosition
{
get
/// <remarks>If false, then the top-left of the view is used for the position.
/// Setting this to false will allow scaling or rotation around the anchor-point without affecting the view's position.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public bool PositionUsesPivotPoint
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated.
+ /// </summary>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PositionUsesPivotPoint.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use PositionUsesPivotPoint instead! " +
+ "Like: " +
+ "View view = new View(); " +
+ "view.PivotPoint = PivotPoint.Center; " +
+ "view.PositionUsesPivotPoint = true;")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public bool PositionUsesAnchorPoint
{
get
}
/// <summary>
- /// Queries whether the view is connected to the Stage.<br>
- /// When an view is connected, it will be directly or indirectly parented to the root View.<br>
+ /// Queries whether the view is connected to the stage.<br />
+ /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool IsOnWindow
{
get
}
/// <summary>
- /// Gets depth in the hierarchy for the view.
+ /// Gets the depth in the hierarchy for the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int HierarchyDepth
{
get
}
/// <summary>
- /// Sets the sibling order of the view so depth position can be defined within the same parent.
+ /// Sets the sibling order of the view so the depth position can be defined within the same parent.
/// </summary>
/// <remarks>
- /// Note The initial value is 0.
- /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order.
- /// The values set by this Property will likely change.
+ /// Note the initial value is 0.
+ /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
+ /// The values set by this property will likely change.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public int SiblingOrder
{
get
}
}
- [Obsolete("Please do not use! this will be internal property")]
+ /// <summary>
+ /// Returns the natural size of the view.
+ /// </summary>
+ /// <remarks>
+ /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
+ /// </remarks>
+ /// /// Please do not use! this will be deprecated!
+ /// Instead please use NaturalSize2D.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use NaturalSize2D instead! " +
+ "Like: " +
+ "TextLabel label = new TextLabel(\"Hello World!\"); " +
+ "Size2D size = view.NaturalSize2D;")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public Vector3 NaturalSize
{
get
}
/// <summary>
- /// Shows the View.
+ /// Shows the view.
/// </summary>
/// <remarks>
/// This is an asynchronous method.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Show()
{
SetVisible(true);
}
/// <summary>
- /// Hides the View.
+ /// Hides the view.
/// </summary>
/// <remarks>
/// This is an asynchronous method.
- /// If an view is hidden, then the view and its children will not be rendered.
- /// This is regardless of the individual visibility of the children i.e.an view will only be rendered if all of its parents are shown.
+ /// If the view is hidden, then the view and its children will not be rendered.
+ /// This is regardless of the individual visibility of the children, i.e., the view will only be rendered if all of its parents are shown.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Hide()
{
SetVisible(false);
}
/// <summary>
- /// Raise view above all other views.
+ /// Raises the view above all other views.
/// </summary>
/// <remarks>
/// Sibling order of views within the parent will be updated automatically.
- /// Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.
+ /// Once a raise or lower API is used, that view will then have an exclusive sibling order independent of insertion.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public void RaiseToTop()
{
var parentChildren = Parent?.Children;
}
/// <summary>
- /// Lower view to the bottom of all views.
+ /// Lowers the view to the bottom of all views.
/// </summary>
/// <remarks>
- /// Sibling order of views within the parent will be updated automatically.
+ /// The sibling order of views within the parent will be updated automatically.
/// Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public void LowerToBottom()
{
var parentChildren = Parent?.Children;
}
/// <summary>
- /// Query if all resources required by a View are loaded and ready.
+ /// Queries if all resources required by a view are loaded and ready.
/// </summary>
- /// <remarks>Most resources are only loaded when the control is placed on stage
+ /// <remarks>Most resources are only loaded when the control is placed on the stage.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public bool IsResourceReady()
{
bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
}
/// <summary>
- /// Raise the view to above the target view.
+ /// Raises the view to above the target view.
/// </summary>
- /// <remarks>Sibling order of views within the parent will be updated automatically.
+ /// <remarks>The sibling order of views within the parent will be updated automatically.
/// Views on the level above the target view will still be shown above this view.
/// Raising this view above views with the same sibling order as each other will raise this view above them.
/// Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.
/// </remarks>
- /// <param name="target">Will be raised above this view</param>
+ /// <param name="target">Will be raised above this view.</param>
internal void RaiseAbove(View target)
{
var parentChildren = Parent?.Children;
}
/// <summary>
- /// Lower the view to below the target view.
+ /// Lowers the view to below the target view.
/// </summary>
- /// <remarks>Sibling order of views within the parent will be updated automatically.
+ /// <remarks>The sibling order of views within the parent will be updated automatically.
/// Lowering this view below views with the same sibling order as each other will lower this view above them.
/// Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.
/// </remarks>
- /// <param name="target">Will be lowered below this view</param>
+ /// <param name="target">Will be lowered below this view.</param>
internal void LowerBelow(View target)
{
var parentChildren = Parent?.Children;
}
/// <summary>
- /// Removes a View from its Parent View / Layer. If the View has no parent, this method does nothing.
+ /// Removes a view from its parent view or layer. If a view has no parent, this method does nothing.
/// </summary>
- /// <pre>The (child) View has been initialized. </pre>
+ /// <pre>The (child) view has been initialized. </pre>
+ /// <since_tizen> 4 </since_tizen>
public void Unparent()
{
GetParent()?.Remove(this);
}
/// <summary>
- /// Search through this view's hierarchy for an view with the given name.
+ /// Search through this view's hierarchy for a view with the given name.
/// The view itself is also considered in the search.
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <param name="viewName">The name of the view to find</param>
- /// <returns>A handle to the view if found, or an empty handle if not</returns>
+ /// <pre>The view has been initialized.</pre>
+ /// <param name="viewName">The name of the view to find.</param>
+ /// <returns>A handle to the view if found, or an empty handle if not.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View FindChildByName(string viewName)
{
IntPtr cPtr = NDalicPINVOKE.Actor_FindChildByName(swigCPtr, viewName);
/// <summary>
/// Converts screen coordinates into the view's coordinate system using the default camera.
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <remarks>The view coordinates are relative to the top-left(0.0, 0.0, 0.5)</remarks>
- /// <param name="localX">On return, the X-coordinate relative to the view</param>
- /// <param name="localY">On return, the Y-coordinate relative to the view</param>
- /// <param name="screenX">The screen X-coordinate</param>
- /// <param name="screenY">The screen Y-coordinate</param>
- /// <returns>True if the conversion succeeded</returns>
+ /// <pre>The view has been initialized.</pre>
+ /// <remarks>The view coordinates are relative to the top-left(0.0, 0.0, 0.5).</remarks>
+ /// <param name="localX">On return, the X-coordinate relative to the view.</param>
+ /// <param name="localY">On return, the Y-coordinate relative to the view.</param>
+ /// <param name="screenX">The screen X-coordinate.</param>
+ /// <param name="screenY">The screen Y-coordinate.</param>
+ /// <returns>True if the conversion succeeded.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool ScreenToLocal(out float localX, out float localY, float screenX, float screenY)
{
bool ret = NDalicPINVOKE.Actor_ScreenToLocal(swigCPtr, out localX, out localY, screenX, screenY);
}
/// <summary>
- /// Sets the relative to parent size factor of the view.<br>
+ /// Sets the relative to parent size factor of the view.<br />
/// This factor is only used when ResizePolicy is set to either:
- /// ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.<br>
- /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicy.<br>
+ /// ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.<br />
+ /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicy.<br />
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <param name="factor">A Vector3 representing the relative factor to be applied to each axis</param>
+ /// <pre>The view has been initialized.</pre>
+ /// <param name="factor">A Vector3 representing the relative factor to be applied to each axis.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetSizeModeFactor(Vector3 factor)
{
NDalicPINVOKE.Actor_SetSizeModeFactor(swigCPtr, Vector3.getCPtr(factor));
}
/// <summary>
- /// Calculates the height of the view given a width.<br>
- /// The natural size is used for default calculation. <br>
- /// size 0 is treated as aspect ratio 1:1.<br>
+ /// Calculates the height of the view given a width.<br />
+ /// The natural size is used for default calculation.<br />
+ /// Size 0 is treated as aspect ratio 1:1.<br />
/// </summary>
- /// <param name="width">Width to use</param>
- /// <returns>The height based on the width</returns>
+ /// <param name="width">The width to use.</param>
+ /// <returns>The height based on the width.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetHeightForWidth(float width)
{
float ret = NDalicPINVOKE.Actor_GetHeightForWidth(swigCPtr, width);
}
/// <summary>
- /// Calculates the width of the view given a height.<br>
- /// The natural size is used for default calculation.<br>
- /// size 0 is treated as aspect ratio 1:1.<br>
+ /// Calculates the width of the view given a height.<br />
+ /// The natural size is used for default calculation.<br />
+ /// Size 0 is treated as aspect ratio 1:1.<br />
/// </summary>
- /// <param name="height">Height to use</param>
- /// <returns>The width based on the height</returns>
+ /// <param name="height">The height to use.</param>
+ /// <returns>The width based on the height.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetWidthForHeight(float height)
{
float ret = NDalicPINVOKE.Actor_GetWidthForHeight(swigCPtr, height);
return ret;
}
+ /// <summary>
+ /// Return the amount of size allocated for relayout.
+ /// </summary>
+ /// <param name="dimension">The dimension to retrieve.</param>
+ /// <returns>Return the size.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetRelayoutSize(DimensionType dimension)
{
float ret = NDalicPINVOKE.Actor_GetRelayoutSize(swigCPtr, (int)dimension);
return ret;
}
+ /// <summary>
+ /// Set the padding for the view.
+ /// </summary>
+ /// <param name="padding">Padding for the view.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetPadding(PaddingType padding)
{
NDalicPINVOKE.Actor_SetPadding(swigCPtr, PaddingType.getCPtr(padding));
throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Return the value of padding for the view.
+ /// </summary>
+ /// <param name="paddingOut">the value of padding for the view</param>
+ /// <since_tizen> 3 </since_tizen>
public void GetPadding(PaddingType paddingOut)
{
NDalicPINVOKE.Actor_GetPadding(swigCPtr, PaddingType.getCPtr(paddingOut));
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public uint AddRenderer(Renderer renderer)
{
uint ret = NDalicPINVOKE.Actor_AddRenderer(swigCPtr, Renderer.getCPtr(renderer));
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public Renderer GetRendererAt(uint index)
{
IntPtr cPtr = NDalicPINVOKE.Actor_GetRendererAt(swigCPtr, index);
return ret;
}
+ /// <since_tizen> 3 </since_tizen>
public void RemoveRenderer(Renderer renderer)
{
NDalicPINVOKE.Actor_RemoveRenderer__SWIG_0(swigCPtr, Renderer.getCPtr(renderer));
throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <since_tizen> 3 </since_tizen>
public void RemoveRenderer(uint index)
{
NDalicPINVOKE.Actor_RemoveRenderer__SWIG_1(swigCPtr, index);
}
/// <summary>
- /// Gets/Sets the origin of an view, within its parent's area.<br>
- /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and(1.0, 1.0, 0.5) is the bottom-right corner.<br>
- /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br>
- /// An view's position is the distance between this origin, and the view's anchor-point.<br>
+ /// Gets or sets the origin of a view within its parent's area.<br />
+ /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
+ /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
+ /// A view's position is the distance between this origin and the view's anchor-point.<br />
/// </summary>
- /// <pre>The View has been initialized.</pre>
+ /// <pre>The view has been initialized.</pre>
+ /// <since_tizen> 3 </since_tizen>
public Position ParentOrigin
{
get
}
/// <summary>
- /// Gets/Sets the anchor-point of an view.<br>
- /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the view, and (1.0, 1.0, 0.5) is the bottom-right corner.<br>
- /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br>
- /// An view position is the distance between its parent-origin and this anchor-point.<br>
- /// An view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br>
- /// <pre>The View has been initialized.</pre>
+ /// Gets or sets the anchor-point of a view.<br />
+ /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the view, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
+ /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
+ /// A view position is the distance between its parent-origin and this anchor-point.<br />
+ /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
+ /// <pre>The view has been initialized.</pre>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position PivotPoint
{
get
}
/// <summary>
- /// Gets/Sets the size width of an view.
+ /// Gets or sets the size width of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SizeWidth
{
get
}
/// <summary>
- /// Gets/Sets the size height of an view.
+ /// Gets or sets the size height of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SizeHeight
{
get
}
/// <summary>
- /// Gets/Sets the position of the View.<br>
- /// By default, sets the position vector between the parent origin and pivot point(default).<br>
- /// If Position inheritance if disabled, sets the world position.<br>
+ /// Gets or sets the position of the view.<br />
+ /// By default, sets the position vector between the parent origin and pivot point (default).<br />
+ /// If the position inheritance is disabled, sets the world position.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position Position
{
get
}
/// <summary>
- /// Gets/Sets the position x of the View.
+ /// Gets or sets the position X of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PositionX
{
get
}
/// <summary>
- /// Gets/Sets the position y of the View.
+ /// Gets or sets the position Y of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PositionY
{
get
}
/// <summary>
- /// Gets/Sets the position z of the View.
+ /// Gets or sets the position Z of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PositionZ
{
get
}
/// <summary>
- /// Gets/Sets the world position of the View.
+ /// Gets or sets the world position of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 WorldPosition
{
get
}
/// <summary>
- /// Gets/Sets the orientation of the View.<br>
- /// An view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br>
+ /// Gets or sets the orientation of the view.<br />
+ /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
/// </summary>
/// <remarks>This is an asynchronous method.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public Rotation Orientation
{
get
}
/// <summary>
- /// Gets/Sets the world orientation of the View.<br>
+ /// Gets or sets the world orientation of the view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rotation WorldOrientation
{
get
}
/// <summary>
- /// Gets/Sets the scale factor applied to an view.<br>
+ /// Gets or sets the scale factor applied to the view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 Scale
{
get
}
/// <summary>
- /// Gets/Sets the scale x factor applied to an view.
+ /// Gets or sets the scale X factor applied to the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleX
{
get
}
/// <summary>
- /// Gets/Sets the scale y factor applied to an view.
+ /// Gets or sets the scale Y factor applied to the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleY
{
get
}
/// <summary>
- /// Gets/Sets the scale z factor applied to an view.
+ /// Gets or sets the scale Z factor applied to the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleZ
{
get
}
/// <summary>
- /// Gets the world scale of View.
+ /// Gets the world scale of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 WorldScale
{
get
}
/// <summary>
- /// Retrieves the visibility flag of an view.
+ /// Retrieves the visibility flag of the view.
/// </summary>
/// <remarks>
- /// If an view is not visible, then the view and its children will not be rendered.
- /// This is regardless of the individual visibility values of the children i.e.an view will only be rendered if all of its parents have visibility set to true.
+ /// If the view is not visible, then the view and its children will not be rendered.
+ /// This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public bool Visibility
{
get
/// <summary>
/// Gets the view's world color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 WorldColor
{
get
}
/// <summary>
- /// Gets/Sets the View's name.
+ /// Gets or sets the view's name.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
get
}
/// <summary>
- /// Gets the View's ID.
+ /// Gets the view's ID.
/// Readonly
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint ID
{
get
}
/// <summary>
- /// Gets/Sets the status of whether an view should emit touch or hover signals.
+ /// Gets or sets the status of whether the view should emit touch or hover signals.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Sensitive
{
get
}
/// <summary>
- /// Gets/Sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view.
+ /// Gets or sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool LeaveRequired
{
get
}
/// <summary>
- /// Gets/Sets the status of whether a child view inherits it's parent's orientation.
+ /// Gets or sets the status of whether a child view inherits it's parent's orientation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool InheritOrientation
{
get
}
/// <summary>
- /// Gets/Sets the status of whether a child view inherits it's parent's scale.
+ /// Gets or sets the status of whether a child view inherits it's parent's scale.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool InheritScale
{
get
}
/// <summary>
- /// Gets/Sets the status of how the view and its children should be drawn.<br>
- /// Not all views are renderable, but DrawMode can be inherited from any view.<br>
- /// If an object is in a 3D layer, it will be depth-tested against other objects in the world i.e. it may be obscured if other objects are in front.<br>
- /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br>
- /// Overlay views are drawn in a separate pass, after all non-overlay views within the Layer.<br>
- /// For overlay views, the drawing order is with respect to tree levels of Views, and depth-testing will not be used.<br>
+ /// Gets or sets the status of how the view and its children should be drawn.<br />
+ /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
+ /// If an object is in a 3D layer, it will be depth-tested against other objects in the world, i.e., it may be obscured if other objects are in front.<br />
+ /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
+ /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
+ /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public DrawModeType DrawMode
{
get
}
/// <summary>
- /// Gets/Sets the relative to parent size factor of the view.<br>
- /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br>
- /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br>
+ /// Gets or sets the relative to parent size factor of the view.<br />
+ /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
+ /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 SizeModeFactor
{
get
}
/// <summary>
- /// Gets/Sets the width resize policy to be used.
+ /// Gets or sets the width resize policy to be used.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ResizePolicyType WidthResizePolicy
{
get
}
/// <summary>
- /// Gets/Sets the height resize policy to be used.
+ /// Gets or sets the height resize policy to be used.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ResizePolicyType HeightResizePolicy
{
get
}
/// <summary>
- /// Gets/Sets the policy to use when setting size with size negotiation.<br>
- /// Defaults to SizeScalePolicyType.UseSizeSet.<br>
+ /// Gets or sets the policy to use when setting size with size negotiation.<br />
+ /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public SizeScalePolicyType SizeScalePolicy
{
get
}
/// <summary>
- /// Gets/Sets the status of whether the width size is dependent on height size.
+ /// Gets or sets the status of whether the width size is dependent on the height size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool WidthForHeight
{
get
}
/// <summary>
- /// Gets/Sets the status of whether the height size is dependent on width size.
+ /// Gets or sets the status of whether the height size is dependent on the width size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool HeightForWidth
{
get
}
/// <summary>
- /// Gets/Sets the padding for use in layout.
+ /// Gets or sets the padding for use in layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 Padding
{
get
}
/// <summary>
- /// Gets/Sets the minimum size an view can be assigned in size negotiation.
+ /// Gets or sets the minimum size the view can be assigned in size negotiation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D MinimumSize
{
get
}
/// <summary>
- /// Gets/Sets the maximum size an view can be assigned in size negotiation.
+ /// Gets or sets the maximum size the view can be assigned in size negotiation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D MaximumSize
{
get
}
/// <summary>
- /// Gets/Sets whether a child view inherits it's parent's position.<br>
- /// Default is to inherit.<br>
- /// Switching this off means that using Position sets the view's world position, i.e. translates from the world origin(0,0,0) to the pivot point of the view.<br>
+ /// Gets or sets whether a child view inherits it's parent's position.<br />
+ /// Default is to inherit.<br />
+ /// Switching this off means that using position sets the view's world position, i.e., translates from the world origin (0,0,0) to the pivot point of the view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool InheritPosition
{
get
}
/// <summary>
- /// Gets/Sets clipping behavior(mode) of it's children.
+ /// Gets or sets the clipping behavior (mode) of it's children.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ClippingModeType ClippingMode
{
get
}
/// <summary>
- /// Get the number of renderers held by the view.
+ /// Gets the number of renderers held by the view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint RendererCount
{
get
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use TouchEvent.
+ [Obsolete("Please do not use! This will be deprecated! Please use TouchEvent instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandlerWithReturnType<object, TouchEventArgs, bool> Touched
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use HoverEvent.
+ [Obsolete("Please do not use! This will be deprecated! Please use HoverEvent instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandlerWithReturnType<object, HoverEventArgs, bool> Hovered
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use WheelEvent.
+ [Obsolete("Please do not use! This will be deprecated! Please use WheelEvent instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandlerWithReturnType<object, WheelEventArgs, bool> WheelMoved
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPoint.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint instead! " +
+ "Like: " +
+ "View view = new View(); " +
+ "view.PivotPoint = PivotPoint.Center; " +
+ "view.PositionUsesPivotPoint = true;")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public Position AnchorPoint
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use Size2D instead! " +
+ "Like: " +
+ "View view = new View(); " +
+ "view.Size2D = new Size2D(100, 100);")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public Size Size
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use AddedToWindow.
+ [Obsolete("Please do not use! This will be deprecated! Please use AddedToWindow instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler OnWindowEvent
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use RemovedFromWindow.
+ [Obsolete("Please do not use! This will be deprecated! Please use RemovedFromWindow instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler OffWindowEvent
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use Relayout.
+ [Obsolete("Please do not use! This will be deprecated! Please use Relayout instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler OnRelayoutEvent
{
add
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// The visibility change type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum VisibilityChangeType
{
+ /// <summary>
+ /// The visibility of the actor itself has changed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
SELF,
+ /// <summary>
+ /// The visibility of a parent has changed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PARENT
}
using System.Linq;
/// <summary>
- /// A visual view control for user add any visual to it.
+ /// A visual view control if a user adds any visual to it.
/// </summary>
/// <example>
/// Example:
/// _visualView.AddVisual("imageVisual1", imageVisualMap1);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public class VisualView : CustomView
{
//private LinkedList<VisualBase> _visualList = null;
CustomViewRegistry.Instance.Register(CreateInstance, typeof(VisualView));
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualView() : base(typeof(VisualView).FullName, CustomViewBehaviour.ViewBehaviourDefault)
{
}
/// <summary>
- /// Override the parent method.
+ /// Overrides the parent method.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public override void OnInitialize()
{
//Initialize empty
}
/// <summary>
- /// Add or update a visual to visual view.
+ /// Adds or updates a visual to visual view.
/// </summary>
- /// <param name="visualName"> The name of visual to add. If add a existed visual name, the visual will be replaced. </param>
- /// <param name="visualMap"> The property map of visual to create. </param>
+ /// <param name="visualName">The name of a visual to add. If a name is added to an existing visual name, the visual will be replaced.</param>
+ /// <param name="visualMap">The property map of a visual to create.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddVisual(string visualName, VisualMap visualMap)
{
VisualBase visual = null;
}
/// <summary>
- /// Remove a visual by name.
+ /// Removes a visual by name.
/// </summary>
- /// <param name="visualName"> The name of visual to remove. </param>
+ /// <param name="visualName">The name of a visual to remove.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveVisual(string visualName)
{
foreach (var item in _visualDictionary)
}
/// <summary>
- /// Get the total number of Visuals which are added by users
+ /// Gets the total number of visuals which are added by users.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int NumberOfVisuals
{
get
}
/// <summary>
- /// Remove all visuals of visual view.
+ /// Removes all visuals of the visual view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveAll()
{
foreach (var item in _visualDictionary)
}
/// <summary>
- /// Override method of OnRelayout() for CustomView class.<br>
- /// Called after the size negotiation has been finished for this control.<br>
- /// The control is expected to assign this given size to itself/its children.<br>
- /// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties.<br>
+ /// Overrides the method of OnRelayout() for CustomView class.<br />
+ /// Called after the size negotiation has been finished for this control.<br />
+ /// The control is expected to assign this given size to itself or its children.<br />
+ /// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize, or after changing specific properties.<br />
/// </summary>
- /// <remarks>As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored)</remarks>
- /// <param name="size">The allocated size</param>
+ /// <remarks>As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).</remarks>
+ /// <param name="size">The allocated size.</param>
/// <param name="container">The control should add actors to this container that it is not able to allocate a size for.</param>
+ /// <since_tizen> 3 </since_tizen>
public override void OnRelayout(Vector2 size, RelayoutContainer container)
{
foreach (var item in _visualDictionary)
}
/// <summary>
- /// Create visual animation (transition) with the input parameters.
+ /// Creates a visual animation (transition) with the input parameters.
/// </summary>
- /// <param name="target"> The visual map to animation.</param>
- /// <param name="property"> The property of visual to animation.</param>
- /// <param name="destinationValue"> The destination value of property after animation.</param>
- /// <param name="startTime"> The start time of visual animation.</param>
- /// <param name="endTime"> The end time of visual animation.</param>
- /// <param name="alphaFunction"> The alpha function of visual animation</param>
- /// <param name="initialValue"> The initial property value of visual animation </param>
+ /// <param name="target">The visual map to animation.</param>
+ /// <param name="property">The property of visual to animation.</param>
+ /// <param name="destinationValue">The destination value of property after animation.</param>
+ /// <param name="startTime">The start time of visual animation.</param>
+ /// <param name="endTime">The end time of visual animation.</param>
+ /// <param name="alphaFunction">The alpha function of visual animation.</param>
+ /// <param name="initialValue">The initial property value of visual animation.</param>
/// <returns>Animation instance</returns>
+ /// <since_tizen> 3 </since_tizen>
public Animation AnimateVisual(VisualMap target, string property, object destinationValue, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialValue = null)
{
string _alphaFunction = null;
}
/// <summary>
- /// Add group visual animation (transition) map with the input parameters.
+ /// Adds a group visual animation (transition) map with the input parameters.
/// </summary>
- /// <param name="target"> The visual map to animation.</param>
- /// <param name="property"> The property of visual to animation.</param>
- /// <param name="destinationValue"> The destination value of property after animation.</param>
- /// <param name="startTime"> The start time of visual animation.</param>
- /// <param name="endTime"> The end time of visual animation.</param>
- /// <param name="alphaFunction"> The alpha function of visual animation</param>
- /// <param name="initialValue"> The initial property value of visual animation </param>
+ /// <param name="target">The visual map to animation.</param>
+ /// <param name="property">The property of visual to animation.</param>
+ /// <param name="destinationValue">The destination value of property after animation.</param>
+ /// <param name="startTime">The start time of visual animation.</param>
+ /// <param name="endTime">The end time of visual animation.</param>
+ /// <param name="alphaFunction">The alpha function of visual animation.</param>
+ /// <param name="initialValue">The initial property value of visual animation.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AnimateVisualAdd(VisualMap target, string property, object destinationValue, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialValue = null)
{
string _alphaFunction = null;
}
/// <summary>
- /// Finish to add Visual animation (transition) map and create transition animation.
+ /// Finishes to add a visual animation (transition) map and creates a transition animation.
/// </summary>
- /// <returns>Animation instance</returns>
+ /// <returns>Animation instance.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Animation AnimateVisualAddFinish()
{
if ( _animateArray == null || _animateArray.Empty())
return this.CreateTransition(_transitionData);
}
-
- //temporary fix to pass TCT
+ /// <summary>
+ /// temporary fix to pass TCT.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Animation VisualAnimate(Tizen.NUI.VisualAnimator visualMap)
{
foreach (var item in _visualDictionary.ToList())
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// BaseHandle is a handle to an internal Dali resource.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class BaseHandle : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
private bool _registerMe;
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~BaseHandle()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
-
-
- // Returns the bool value true to indicate that an operand is true and returns false otherwise.
+ /// <summary>
+ /// Returns the bool value true to indicate that an operand is true and returns false otherwise.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator true(BaseHandle handle)
{
// if the C# object is null, return false
return handle.HasBody();
}
- // Returns the bool false to indicate that an operand is false and returns true otherwise.
+ /// <summary>
+ /// Returns the bool false to indicate that an operand is false and returns true otherwise.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator false(BaseHandle handle)
{
// if the C# object is null, return true
return !handle.HasBody();
}
- // Explicit conversion from Handle to bool.
+ /// <summary>
+ /// Explicit conversion from Handle to bool.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static explicit operator bool(BaseHandle handle)
{
// if the C# object is null, return false
return handle.HasBody();
}
- // Equality operator
+ /// <summary>
+ /// Equality operator
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator ==(BaseHandle x, BaseHandle y)
{
// if the C# objects are the same return true
return false;
}
- // Inequality operator. Returns Null if either operand is Null
+ /// <summary>
+ /// Inequality operator. Returns Null if either operand is Null
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator !=(BaseHandle x, BaseHandle y)
{
return !(x == y);
}
- // Logical AND operator for &&
- // It's possible when doing a && this function (opBitwiseAnd) is never called due
- // to short circuiting. E.g.
- // If you perform x && y What actually is called is
- // BaseHandle.op_False( x ) ? BaseHandle.op_True( x ) : BaseHandle.opTrue( BaseHandle.opBitwiseAnd(x,y) )
- //
+ /// <summary>
+ /// Logical AND operator.<br />
+ /// It's possible when doing a operator this function (opBitwiseAnd) is never called due to short circuiting.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static BaseHandle operator &(BaseHandle x, BaseHandle y)
{
if (x == y)
return null;
}
- // Logical OR operator for ||
- // It's possible when doing a || this function (opBitwiseOr) is never called due
- // to short circuiting. E.g.
- // If you perform x || y What actually is called is
- // BaseHandle.op_True( x ) ? BaseHandle.op_True( x ) : BaseHandle.opTrue( BaseHandle.opBitwiseOr(x,y) )
+ /// <summary>
+ /// Logical OR operator for ||.<br />
+ /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static BaseHandle operator |(BaseHandle x, BaseHandle y)
{
if (!BaseHandle.ReferenceEquals(x, null) || !BaseHandle.ReferenceEquals(y, null))
return null;
}
- // Logical ! operator
+ /// <summary>
+ /// Logical ! operator
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator !(BaseHandle x)
{
// if the C# object is null, return true
}
+ /// <summary>
+ /// Create an instance of BaseHandle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public BaseHandle() : this(NDalicPINVOKE.new_BaseHandle__SWIG_1())
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Create an instance of BaseHandle.
+ /// </summary>
+ /// <param name="handle">The BaseHandle instance.</param>
+ /// <since_tizen> 3 </since_tizen>
public BaseHandle(BaseHandle handle) : this(NDalicPINVOKE.new_BaseHandle__SWIG_2(BaseHandle.getCPtr(handle)))
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Performs an action on this object with the given action name and attributes.
+ /// </summary>
+ /// <param name="actionName">The command for the action.</param>
+ /// <param name="attributes">The list of attributes for the action.</param>
+ /// <returns>The action is performed by the object or not.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool DoAction(string actionName, PropertyMap attributes)
{
bool ret = NDalicPINVOKE.BaseHandle_DoAction(swigCPtr, actionName, PropertyMap.getCPtr(attributes));
return ret;
}
+ /// <summary>
+ /// Returns the type name for the Handle.<br />
+ /// Will return an empty string if the typename does not exist. This will happen for types that
+ /// have not registered with type-registry.
+ /// </summary>
+ /// <returns>The type name. Empty string if the typename does not exist.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetTypeName()
{
string ret = NDalicPINVOKE.BaseHandle_GetTypeName(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Returns the type info for the Handle.<br />
+ /// </summary>
+ /// <param name="info">The type information.</param>
+ /// <returns>True If get the type info.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GetTypeInfo(TypeInfo info)
{
bool ret = NDalicPINVOKE.BaseHandle_GetTypeInfo(swigCPtr, TypeInfo.getCPtr(info));
return ret;
}
-
+ /// <summary>
+ /// Resets the handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Reset()
{
NDalicPINVOKE.BaseHandle_Reset(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// To check the BaseHandle instance is equal or not.
+ /// </summary>
+ /// <param name="rhs">The baseHandle instance.</param>
+ /// <returns>True If equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(BaseHandle rhs)
{
bool ret = NDalicPINVOKE.BaseHandle_EqualTo(swigCPtr, BaseHandle.getCPtr(rhs));
return ret;
}
+ /// <summary>
+ /// To check the BaseHandle instance is equal or not.
+ /// </summary>
+ /// <param name="rhs">The baseHandle instance.</param>
+ /// <returns>True If not equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(BaseHandle rhs)
{
bool ret = NDalicPINVOKE.BaseHandle_NotEqualTo(swigCPtr, BaseHandle.getCPtr(rhs));
return ret;
}
+ /// <summary>
+ /// To check the BaseHandle instance has body or not.
+ /// </summary>
+ /// <returns>True If the baseHandle instance has body.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool HasBody()
{
if (disposed == true)
return ret;
}
+ /// <summary>
+ /// To check the BaseHandle instance is equal or not.
+ /// </summary>
+ /// <param name="rhs">The baseHandle instance.</param>
+ /// <returns>True If equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsEqual(BaseHandle rhs)
{
if (disposed == true)
}
}
-
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using System;
/// <summary>
- /// Color class.
+ /// The Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Color : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Color(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Color()
{
if(!isDisposeQueued)
}
/// <summary>
- /// To make Color instance be disposed.
+ /// To make a color instance be disposed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A Color containing the result of the addition</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator +(Color arg1, Color arg2)
{
Color result = arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A Color containing the result of the subtraction</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator -(Color arg1, Color arg2)
{
Color result = arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Target Value</param>
- /// <returns>A Color containg the negation</returns>
+ /// <param name="arg1">The target value.</param>
+ /// <returns>The color containg the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator -(Color arg1)
{
Color result = arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A Color containing the result of the multiplication</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator *(Color arg1, Color arg2)
{
Color result = arg1.Multiply(arg2);
return result;
}
+ /// <summary>
+ /// The multiplication operator.
+ /// </summary>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator*(Color arg1, float arg2)
{
Color result = arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A Color containing the result of the division</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator /(Color arg1, Color arg2)
{
Color result = arg1.Divide(arg2);
return result;
}
+ /// <summary>
+ /// The division operator.
+ /// </summary>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The color containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Color operator/(Color arg1, float arg2)
{
Color result = arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator overload.
+ /// The array subscript operator overload.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
/// <summary>
/// Default constructor
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color() : this(NDalicPINVOKE.new_Vector4__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="r">red component</param>
- /// <param name="g">green component</param>
- /// <param name="b">blue component</param>
- /// <param name="a">alpha component</param>
- public Color(float r, float g, float b, float a) : this(NDalicPINVOKE.new_Vector4__SWIG_1(r, g, b, a), true)
+ /// <param name="r">The red component.</param>
+ /// <param name="g">The green component.</param>
+ /// <param name="b">The blue component.</param>
+ /// <param name="a">The alpha component.</param>
+ /// <since_tizen> 3 </since_tizen>
+ public Color(float r, float g, float b, float a) : this(NDalicPINVOKE.new_Vector4__SWIG_1(r, g, b, a), true)
{
ValueCheck(ref r);
ValueCheck(ref g);
}
/// <summary>
- /// Conversion constructor from an array of four floats.
+ /// The conversion constructor from an array of four floats.
/// </summary>
- /// <param name="array">array Array of R,G,B,A</param>
+ /// <param name="array">array Array of R,G,B,A.</param>
+ /// <since_tizen> 3 </since_tizen>
public Color(float[] array) : this(NDalicPINVOKE.new_Vector4__SWIG_2(array), true)
{
ValueCheck(ref array[0]);
}
/// <summary>
- /// Check if two Color classes are same.
+ /// Checks if two color classes are same.
/// </summary>
- /// <param name="rhs">A Color to be compared</param>
- /// <returns>If two Colors are are same, then true.</returns>
+ /// <param name="rhs">A color to be compared.</param>
+ /// <returns>If two colors are are same, then true.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Color rhs)
{
bool ret = NDalicPINVOKE.Vector4_EqualTo(swigCPtr, Color.getCPtr(rhs));
}
/// <summary>
- /// Check if two Color classes are different.
+ /// Checks if two color classes are different.
/// </summary>
- /// <param name="rhs">A Color to be compared</param>
- /// <returns>If two Colors are are different, then true.</returns>
+ /// <param name="rhs">A color to be compared.</param>
+ /// <returns>If two colors are are different, then true.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Color rhs)
{
bool ret = NDalicPINVOKE.Vector4_NotEqualTo(swigCPtr, Color.getCPtr(rhs));
}
/// <summary>
- /// red component.
+ /// The red component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float R
{
set
}
/// <summary>
- /// green component.
+ /// The green component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float G
{
set
}
/// <summary>
- /// blue component.
+ /// The blue component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float B
{
set
}
/// <summary>
- /// alpha component.
+ /// The alpha component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float A
{
set
}
/// <summary>
- /// Get black colored Color class.
+ /// Gets the black colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Black = new Color(0.0f, 0.0f, 0.0f, 1.0f);
/// <summary>
- /// Get white colored Color class.
+ /// Gets the white colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color White = new Color(1.0f, 1.0f, 1.0f, 1.0f);
/// <summary>
- /// Get red colored Color class.
+ /// Gets the red colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Red = new Color(1.0f, 0.0f, 0.0f, 1.0f);
/// <summary>
- /// Get green colored Color class.
+ /// Gets the green colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Green = new Color(0.0f, 1.0f, 0.0f, 1.0f);
/// <summary>
- /// Get blue colored Color class.
+ /// Gets the blue colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Blue = new Color(0.0f, 0.0f, 1.0f, 1.0f);
/// <summary>
- /// Get yellow colored Color class.
+ /// Gets the yellow colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Yellow = new Color(1.0f, 1.0f, 0.0f, 1.0f);
/// <summary>
- /// Get magenta colored Color class.
+ /// Gets the magenta colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Magenta = new Color(1.0f, 0.0f, 1.0f, 1.0f);
/// <summary>
- /// Get cyan colored Color class.
+ /// Gets the cyan colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Cyan = new Color(0.0f, 1.0f, 1.0f, 1.0f);
/// <summary>
- /// Get transparent colored Color class.
+ /// Gets the transparent colored Color class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly Color Transparent = new Color(0.0f, 0.0f, 0.0f, 0.0f);
/// <summary>
- /// convert Color class to Vector4 class implicitly.
+ /// Converts the Color class to Vector4 class implicitly.
/// </summary>
- /// <param name="color">A Color to be converted to Vector4</param>
+ /// <param name="color">A color to be converted to Vector4</param>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector4(Color color)
{
return new Vector4(color.R, color.G, color.B, color.A);
}
/// <summary>
- /// convert Vector4 class to Color class implicitly.
+ /// Converts Vector4 class to Color class implicitly.
/// </summary>
- /// <param name="vec">A Vector4 to be converted to Color</param></param>
+ /// <param name="vec">A Vector4 to be converted to color.</param>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Color(Vector4 vec)
{
return new Color(vec.R, vec.G, vec.B, vec.A);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
using System.Collections.Generic;
namespace Tizen.NUI
{
/// <summary>
- ///
- /// Container is an abstract class to be inherited from by classes that desire to have Views
+ /// The Container is an abstract class to be inherited from by classes that desire to have views
/// added to them.
- ///
/// </summary>
-
+ /// <since_tizen> 4 </since_tizen>
public abstract class Container : Animatable
{
private List<View> _childViews = new List<View>();
+ /// <summary>
+ /// List of children of Container.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public List<View> Children
{
get
// No un-managed data hence no need to store a native ptr
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// Adds a child view to this Container.
/// </summary>
- /// <pre>This Container(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
+ /// <pre>This Container (the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
/// <post>The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.</post>
- /// <remarks>If the child already has a parent, it will be removed from old parent and reparented to this view. This may change child's position, color, scale etc as it now inherits them from this view.</remarks>
- /// <param name="view">The child view to add</param>
+ /// <remarks>If the child already has a parent, it will be removed from the old parent and reparented to this view. This may change child's position, color, scale, etc. as it now inherits them from this view.</remarks>
+ /// <param name="view">The child view to add.</param>
+ /// <since_tizen> 4 </since_tizen>
public abstract void Add( View view );
/// <summary>
- /// Removes a child View from this View. If the view was not a child of this view, this is a no-op.
+ /// Removes a child view from this view. If the view was not a child of this view, this is a no-op.
/// </summary>
/// <pre>This View(the parent) has been initialized. The child view is not the same as the parent view.</pre>
- /// <param name="child">The child</param>
+ /// <param name="view">The view to remove</param>
+ /// <since_tizen> 4 </since_tizen>
public abstract void Remove( View view );
/// <summary>
- /// Retrieves child view by index.
+ /// Retrieves the child view by the index.
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <param name="index">The index of the child to retrieve</param>
- /// <returns>The view for the given index or empty handle if children not initialized</returns>
+ /// <pre>The view has been initialized.</pre>
+ /// <param name="index">The index of the child to retrieve.</param>
+ /// <returns>The view for the given index or empty handle if children are not initialized.</returns>
+ /// <since_tizen> 4 </since_tizen>
public abstract View GetChildAt( uint index );
/// <summary>
- /// Get the parent of this container
+ /// Gets the parent of this container.
/// </summary>
/// <pre>The child container has been initialized.</pre>
- /// <returns>The parent container</returns>
+ /// <returns>The parent container.</returns>
+ /// <since_tizen> 4 </since_tizen>
protected abstract Container GetParent();
/// <summary>
- /// Get the number of children for this container
+ /// Gets the number of children for this container.
/// </summary>
/// <pre>The container has been initialized.</pre>
- /// <returns>number of children</returns>
+ /// <returns>The number of children.</returns>
+ /// <since_tizen> 4 </since_tizen>
protected abstract UInt32 GetChildCount();
/// <summary>
- /// Get the parent Container
+ /// Gets the parent container.
/// Read only
/// </summary>
/// <pre>The child container has been initialized.</pre>
- /// <returns>The parent container</returns>
+ /// <returns>The parent container.</returns>
+ /// <since_tizen> 4 </since_tizen>
public Container Parent
{
get
}
/// <summary>
- /// Get the number of children for this container
+ /// Gets the number of children for this container.
/// Read only
/// </summary>
/// <pre>The container has been initialized.</pre>
- /// <returns>number of children</returns>
+ /// <returns>The number of children.</returns>
+ /// <since_tizen> 4 </since_tizen>
public uint ChildCount
{
get
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
using System.Runtime.InteropServices;
namespace Tizen.NUI
{
///<summary>
- ///Spin CustomView class
+ ///Spins the CustomView class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Spin : CustomView
{
private VisualBase _arrowVisual;
}
/// <summary>
- /// Creates an initialized Spin.
+ /// Creates an initialized spin.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Spin() : base(typeof(Spin).FullName, CustomViewBehaviour.RequiresKeyboardNavigationSupport)
{
}
/// <summary>
- /// Override method of OnInitialize() for CustomView class.<br>
- /// This method is called after the Control has been initialized.<br>
- /// Derived classes should do any second phase initialization by overriding this method.<br>
+ /// Overrides the method of OnInitialize() for the CustomView class.<br />
+ /// This method is called after the control has been initialized.<br />
+ /// Derived classes should do any second phase initialization by overriding this method.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public override void OnInitialize()
{
// Initialize the propertiesControl
}
/// <summary>
- /// Override method of GetNaturalSize() for CustomView class.<br>
- /// Return the natural size of the actor.<br>
+ /// Overrides the method of GetNaturalSize() for the CustomView class.<br />
+ /// Returns the natural size of the actor.<br />
/// </summary>
- /// <returns> Natural size of this Spin itself</returns>
+ /// <returns> Natural size of this spin itself.</returns>
+ /// <since_tizen> 3 </since_tizen>
public override Size2D GetNaturalSize()
{
return new Size2D(150, 150);
}
/// <summary>
- /// Event handler when the TextField in Spin gets the Key focus.<br>
- /// Make sure when the current spin that takes input focus also takes the keyboard focus.<br>
- /// For example, when you tap the spin directly.<br>
+ /// An event handler is used when the TextField in the spin gets the key focus.<br />
+ /// Make sure when the current spin that takes input focus, also takes the keyboard focus.<br />
+ /// For example, when you tap the spin directly.<br />
/// </summary>
- /// <param name="source">Sender of this event</param>
- /// <param name="e">Event arguments</param>
+ /// <param name="source">Sender of this event.</param>
+ /// <param name="e">Event arguments.</param>
+ /// <since_tizen> 3 </since_tizen>
public void TextFieldKeyInputFocusGained(object source, EventArgs e)
{
FocusManager.Instance.SetCurrentFocusView(_textField);
}
/// <summary>
- /// Event handler when the TextField in Spin looses it's Key focus
+ /// An event handler when the TextField in the spin looses it's key focus.
/// </summary>
/// <param name="source"></param>
/// <param name="e"></param>
+ /// <since_tizen> 3 </since_tizen>
public void TextFieldKeyInputFocusLost(object source, EventArgs e)
{
int previousValue = _currentValue;
}
/// <summary>
- /// Override method of GetNextKeyboardFocusableView() for CustomView class.<br>
- /// Gets the next key focusable view in this View towards the given direction.<br>
- /// A View needs to override this function in order to support two dimensional key navigation.<br>
+ /// Overrides the method of GetNextKeyboardFocusableView() for the CustomView class.<br />
+ /// Gets the next key focusable view in this view towards the given direction.<br />
+ /// A view needs to override this function in order to support two-dimensional key navigation.<br />
/// </summary>
- /// <param name="currentFocusedView">The current focused view</param>
- /// <param name="direction">The direction to move the focus towards</param>
- /// <param name="loopEnabled">Whether the focus movement should be looped within the control</param>
- /// <returns>The next keyboard focusable view in this control or an empty handle if no view can be focused</returns>
+ /// <param name="currentFocusedView">The current focused view.</param>
+ /// <param name="direction">The direction to move the focus towards.</param>
+ /// <param name="loopEnabled">Whether the focus movement should be looped within the control.</param>
+ /// <returns>The next keyboard focusable view in this control or an empty handle if no view can be focused.</returns>
+ /// <since_tizen> 3 </since_tizen>
public override View GetNextFocusableView(View currentFocusedView, View.FocusDirection direction, bool loopEnabled)
{
// Respond to Up/Down keys to change the value while keeping the current spin focused
}
/// <summary>
- /// Value to be set in Spin.
+ /// Value to be set in the spin.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int Value
{
set
{
- Tizen.Log.Debug("NUI", "Value set to " + value);
+ NUILog.Debug("Value set to " + value);
_currentValue = value;
// Make sure no invalid value is accepted
}
/// <summary>
- /// Minimum Value of Spin Value.
+ /// Minimum value of the spin value.
/// </summary>
- // MinValue property of type int:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int MinValue
{
}
/// <summary>
- /// Maximum Value of Spin Value.
+ /// Maximum value of the spin value.
/// </summary>
- // MaxValue property of type int:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int MaxValue
{
}
/// <summary>
- /// Increasing, decresing step of Spin Value when Up or Down key is pressed.
+ /// Increasing, decreasing step of the spin value when up or down keys are pressed.
/// </summary>
- // Step property of type int:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int Step
{
/// <summary>
/// Wrapping enabled status.
/// </summary>
- // WrappingEnabled property of type bool:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public bool WrappingEnabled
{
}
/// <summary>
- /// Text point size of Spin Value.
+ /// Text point size of the spin value.
/// </summary>
- // TextPointSize property of type int:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int TextPointSize
{
}
/// <summary>
- /// The color of Spin Value.
+ /// The color of the spin value.
/// </summary>
- // TextColor property of type Color:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public Color TextColor
{
}
set
{
- Tizen.Log.Debug("NUI", "TextColor set to " + value.R + "," + value.G + "," + value.B);
+ NUILog.Debug("TextColor set to " + value.R + "," + value.G + "," + value.B);
_textColor = value;
_textField.TextColor = _textColor;
}
/// <summary>
- /// Maximum text lengh of Spin Value.
+ /// Maximum text lengh of the spin value.
/// </summary>
- // MaxTextLength property of type int:
+ /// <since_tizen> 3 </since_tizen>
[ScriptableProperty()]
public int MaxTextLength
{
}
/// <summary>
- /// Reference of TextField of Spin.
+ /// Reference of TextField of the spin.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextField SpinText
{
get
}
/// <summary>
- /// Show indicator image, for example Up/Down Arrow image.
+ /// Show indicator image, for example, up or down arrow image.
/// </summary>
- // Indicator property of type string:
+ /// <since_tizen> 3 </since_tizen>
public string IndicatorImage
{
get
namespace Tizen.NUI
{
/// <summary>
- /// Add this attribute to any property belonging to a View (control) you want to be scriptable from JSON
+ /// Adds this attribute to any property belonging to a view (control) you want to be scriptable from JSON.
/// </summary>
/// <remarks>
/// Example:
///
/// Internally the following occurs for property registration ( this only occurs once per Type, not per Instance):
///
- /// - The controls static constructor should call ViewRegistry.Register() (only called once for the lifecycle of the app)
- /// - Within Register() the code will introspect the Controls properties, looking for the ScriptableProperty() attribute
+ /// - The controls static constructor should call ViewRegistry.Register() (only called once for the lifecycle of the app).
+ /// - Within Register() the code will introspect the Controls properties, looking for the ScriptableProperty() attribute.
/// - For every property with the ScriptableProperty() attribute, TypeRegistration.RegisterProperty is called.
- /// - TypeRegistration.RegisterProperty calls in to DALi C++ Code Dali::CSharpTypeRegistry::RegisterProperty()
+ /// - TypeRegistration.RegisterProperty calls in to DALi C++ Code Dali::CSharpTypeRegistry::RegisterProperty().
/// - DALi C++ now knows the existance of the property and will try calling SetProperty, if it finds the property in a JSON file (loaded using builder).
///
- /// The DALi C# example
+ /// The DALi C# example:
///
/// class MyView : public CustomView
/// {
/// </remarks>
///
///
+ /// <since_tizen> 3 </since_tizen>
public class ScriptableProperty : System.Attribute
{
+ /// <summary>
+ /// Rhe enum of ScriptableType
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ScriptableType
{
+ /// <summary>
+ /// Read Writable, non-animatable property, event thread only.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Default, // Read Writable, non-animatable property, event thread only
// Animatable // Animatable property, Currently disabled, UK
}
+ /// <since_tizen> 3 </since_tizen>
public readonly ScriptableType type;
+
+ /// <since_tizen> 3 </since_tizen>
public ScriptableProperty(ScriptableType type = ScriptableType.Default)
{
this.type = type;
}
/// <summary>
- /// View Registry singleton.
- /// Used for registering controls and any scriptable properties they have ( see ScriptableProperty )
+ /// View the Registry singleton.
+ /// Used for registering controls and any scriptable properties they have (see ScriptableProperty).
///
/// Internal Design from C# to C++
///
/// Example of running a static constructor:
/// System.Runtime.CompilerServices.RuntimeHelpers.RunClassConstructor (typeof(Spin).TypeHandle);
/// Inside the static constructor the control should register it's type with the ViewRegistry
- /// e.g.
+ /// For example:
///
/// static Spin()
/// {
/// ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) );
/// }
///
- /// The control should also provide a CreateInstance function, which gets passed to the ViewRegistry
- /// // Eventually it will be called if DALi Builderfinds a Spin control in a JSON file
+ /// The control should also provide a CreateInstance function, which gets passed to the ViewRegistry.
+ /// // Eventually it will be called if DALi Builderfinds a Spin control in a JSON file.
/// static CustomView CreateInstance()
/// {
/// return new Spin();
///
///
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public sealed class CustomViewRegistry
{
/// <summary>
- /// ViewRegistry is a singleton
+ /// ViewRegistry is a singleton.
/// </summary>
private static CustomViewRegistry instance = null;
private PropertyRangeManager _propertyRangeManager;
///<summary>
- // Maps the name of a custom view to a create instance function
- /// E.g. given a string "Spin", we can get a function used to create the Spin View.
+ /// Maps the name of a custom view to a create instance function
+ /// For example, given a string "Spin", we can get a function used to create the Spin View.
///</summary>
private Dictionary<String, Func<CustomView>> _constructorMap;
/// <summary>
- /// Lookup table to match C# types to DALi types, used for the automatic property registration
+ /// Lookup table to match C# types to DALi types, used for the automatic property registration.
/// </summary>
private static readonly Dictionary<string, Tizen.NUI.PropertyType> _daliPropertyTypeLookup
= new Dictionary<string, Tizen.NUI.PropertyType>
}
/// <summary>
- /// Called directly from DALi C++ type registry to create a control (View) using no marshalling.
+ /// Called directly from DALi C++ type registry to create a control (view) using no marshalling.
/// </summary>
- /// <returns>Pointer to the Control (Views) handle </returns>
- /// <param name="cPtrControlName"> C pointer to the Control (View) name</param>
+ /// <returns>Pointer to the control (views) handle.</returns>
+ /// <param name="cPtrControlName">C pointer to the control (view) name.</param>
private static IntPtr CreateControl(IntPtr cPtrControlName)
{
string controlName = System.Runtime.InteropServices.Marshal.PtrToStringAnsi(cPtrControlName);
}
+ /// <since_tizen> 3 </since_tizen>
public static CustomViewRegistry Instance
{
get
}
/// <summary>
- /// Function which registers a view and all it's scriptable properties with DALi's type registry.
- /// Means the View can be created / configured from a JSON script.
+ /// The function which registers a view and all it's scriptable properties with DALi's type registry.
+ /// Means the view can be created or configured from a JSON script.
///
- /// The function uses introspection to scan a Views C# properties, then selects the ones with
+ /// The function uses introspection to scan a views C# properties, then selects the ones with
///[ScriptableProperty] attribute to be registered.
- /// Example of a Spin view registering itself
+ /// Example of a Spin view registering itself:
/// static Spin()
/// {
/// ViewRegistry registers control type with DALi type registery
/// }
///
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Register(Func<CustomView> createFunction, System.Type viewType)
{
// add the mapping between the view name and it's create function
}
/// <summary>
- /// Get a property value from a View
- ///
+ /// Gets a property value from a view.
/// </summary>
private IntPtr GetPropertyValue(IntPtr refObjectPtr, string propertyName)
{
}
/// <summary>
- /// Set a property value on a View
- ///
+ /// Sets a property value on a view.
/// </summary>
private void SetPropertyValue(IntPtr refObjectPtr, string propertyName, IntPtr propertyValuePtr)
{
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// An angle in degrees.<br>
- /// This reduces ambiguity when using methods which accept angles in degrees or radians.<br>
+ /// An angle in degrees.<br />
+ /// This reduces ambiguity when using methods which accept angles in degrees or radians.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Degree : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Degree(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Degree()
{
if(!isDisposeQueued)
DisposeQueue.Instance.Add(this);
}
}
+
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Degree() : this(NDalicPINVOKE.new_Degree__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates an angle in degrees.
/// </summary>
- /// <param name="value">The initial value in degrees</param>
+ /// <param name="value">The initial value in degrees.</param>
+ /// <since_tizen> 3 </since_tizen>
public Degree(float value) : this(NDalicPINVOKE.new_Degree__SWIG_1(value), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an angle in degrees from a Radian.
+ /// Creates an angle in degrees from a radian.
/// </summary>
- /// <param name="value">The initial value in Radians</param>
+ /// <param name="value">The initial value in radians.</param>
+ /// <since_tizen> 3 </since_tizen>
public Degree(Radian value) : this(NDalicPINVOKE.new_Degree__SWIG_2(Radian.getCPtr(value)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// The value of degree.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Value
{
set
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// The Direction Bias type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DirectionBias
{
+ /// <summary>
+ /// Bias scroll snap to Left.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
DirectionBiasLeft = -1,
+ /// <summary>
+ /// Don't bias scroll snap.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
DirectionBiasNone = 0,
+ /// <summary>
+ /// Bias scroll snap to Right.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
DirectionBiasRight = 1
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// The filter mode type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum FilterModeType
{
+ /// <summary>
+ /// Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NONE = 0,
+ /// <summary>
+ /// Use Dali defaults (minification LINEAR, magnification LINEAR).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
DEFAULT,
+ /// <summary>
+ /// Filter nearest.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NEAREST,
+ /// <summary>
+ /// Filter linear.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LINEAR,
+ /// <summary>
+ /// Filter nearest mipmap nearest.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NEAREST_MIPMAP_NEAREST,
+ /// <summary>
+ /// Filter linear mipmap nearest.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LINEAR_MIPMAP_NEAREST,
+ /// <summary>
+ /// Filter nearest mipmap linear.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NEAREST_MIPMAP_LINEAR,
+ /// <summary>
+ /// Filter linear mipmap linear.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LINEAR_MIPMAP_LINEAR
}
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
-
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using Tizen.NUI.BaseComponents;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
- using System;
- using System.Runtime.InteropServices;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain.<br>
- /// It provides functionality of setting the focus and moving the focus in four directions(i.e.Left, Right, Up and Down).<br>
- /// It also draws a highlight for the focused View and sends a event when the focus is changed.<br>
+ /// Provides the functionality of handling keyboard navigation and maintaining the two-dimensional keyboard focus chain.<br />
+ /// It provides functionality of setting the focus and moving the focus in four directions( i.e., left, right, up, and down).<br />
+ /// It also draws a highlight for the focused view and sends an event when the focus is changed.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FocusManager : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
///<summary>
- ///Event arguments that passed via PreFocusChange signal
+ /// Event arguments that passed via the PreFocusChange signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PreFocusChangeEventArgs : EventArgs
{
private View _current;
private View _proposed;
private View.FocusDirection _direction;
+ /// <summary>
+ /// The current focus view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View CurrentView
{
get
}
}
+ /// <summary>
+ /// The proposed view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View ProposedView
{
get
}
}
+ /// <summary>
+ /// The focus move direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View.FocusDirection Direction
{
get
private PreFocusChangeEventCallback _preFocusChangeCallback;
/// <summary>
- /// PreFocusChange will be triggered before the focus is going to be changed.<br>
- /// FocusManager makes the best guess for which view to focus towards the given direction, but applications might want to change that.<br>
- /// By connecting with this event, they can check the proposed view to focus and return a different view if they wish.<br>
- /// This event is only triggered when the navigation key is pressed and KeyboardFocusManager tries to move the focus automatically.<br>
- /// It won't be emitted for focus movement by calling SetCurrentFocusView directly.<br>
+ /// PreFocusChange will be triggered before the focus is going to be changed.<br />
+ /// The FocusManager makes the best guess for which view to focus towards the given direction, but applications might want to change that.<br />
+ /// By connecting with this event, they can check the proposed view to focus and return a different view if they wish.<br />
+ /// This event is only triggered when the navigation key is pressed and KeyboardFocusManager tries to move the focus automatically.<br />
+ /// It won't be emitted for focus movement by calling the SetCurrentFocusView directly.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, PreFocusChangeEventArgs, View> PreFocusChange
{
add
}
///<summary>
- ///Event arguments that passed via FocusChanged signal.
+ /// Event arguments that passed via the FocusChanged signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FocusChangedEventArgs : EventArgs
{
private View _current;
private View _next;
+ /// <summary>
+ /// The current focus view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View CurrentView
{
get
_current = value;
}
}
-
+ /// <summary>
+ /// The next focus view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View NextView
{
get
private FocusChangedEventCallback _focusChangedEventCallback;
/// <summary>
- /// FocusGroupChanged will be triggered after the current focused view has been changed.
+ /// The FocusGroupChanged will be triggered after the current focused view has been changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<FocusChangedEventArgs> FocusChanged
{
add
}
///<summary>
- ///Event arguments that passed via FocusGroupChanged signal.
+ /// Event arguments that passed via the FocusGroupChanged signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FocusGroupChangedEventArgs : EventArgs
{
private View _current;
private bool _forwardDirection;
+ /// <summary>
+ /// The current focus view.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View CurrentView
{
get
}
}
+ /// <summary>
+ /// The forward direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool ForwardDirection
{
get
private FocusGroupChangedEventCallback _focusGroupChangedEventCallback;
/// <summary>
- /// FocusGroupChanged will be triggered when the focus group has been changed.<br>
- /// If the current focus group has a parent layout control, FocusManager will make the best guess for the next focus group to move the focus to in the given direction (forward or backward).<br>
- /// If not, the application has to set the new focus.<br>
+ /// The FocusGroupChanged will be triggered when the focus group has been changed.<br />
+ /// If the current focus group has a parent layout control, the FocusManager will make the best guess for the next focus group to move the focus to in the given direction (forward or backward).<br />
+ /// If not, the application has to set the new focus.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<FocusGroupChangedEventArgs> FocusGroupChanged
{
add
}
///<summary>
- ///Event arguments that passed via FocusedViewEnterKey signal
+ /// Event arguments that passed via the FocusedViewEnterKey signal.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FocusedViewActivatedEventArgs : EventArgs
{
private View _view;
+ /// <summary>
+ /// View.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
private FocusedViewEnterKeyEventCallback _focusedViewEnterKeyEventCallback;
/// <summary>
- /// FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it.
+ /// The FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<FocusedViewActivatedEventArgs> FocusedViewActivated
{
add
}
/// <summary>
- /// Moves the keyboard focus to the given View.<br>
- /// Only one View can be focused at the same time.<br>
- /// The View must be in the stage already and keyboard focusable.<br>
+ /// Moves the keyboard focus to the given view.<br />
+ /// Only one view can be focused at the same time.<br />
+ /// The view must be in the stage already and keyboard focusable.<br />
/// </summary>
- /// <param name="view">The View to be focused</param>
- /// <returns>Whether the focus is successful or not</returns>
+ /// <param name="view">The view to be focused.</param>
+ /// <returns>Whether the focus is successful or not.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool SetCurrentFocusView(View view)
{
bool ret = NDalicManualPINVOKE.FocusManager_SetCurrentFocusActor(swigCPtr, View.getCPtr(view));
/// <summary>
/// Gets the current focused view.
/// </summary>
- /// <returns>A handle to the current focused View or an empty handle if no View is focused</returns>
+ /// <returns>A handle to the current focused view or an empty handle if no view is focused.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetCurrentFocusView()
{
IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetCurrentFocusActor(swigCPtr);
}
/// <summary>
- /// Moves the focus to the next focusable View in the focus chain in the given direction(according to the focus traversal order).
+ /// Moves the focus to the next focusable view in the focus chain in the given direction (according to the focus traversal order).
/// </summary>
- /// <param name="direction">The direction of focus movement</param>
- /// <returns>true if the movement was successful</returns>
+ /// <param name="direction">The direction of the focus movement.</param>
+ /// <returns>True if the movement was successful.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool MoveFocus(View.FocusDirection direction)
{
bool ret = NDalicManualPINVOKE.FocusManager_MoveFocus(swigCPtr, (int)direction);
}
/// <summary>
- /// Clears the focus from the current focused view if any, so that no view is focused in the focus chain.<br>
- /// It will emit FocusChanged event without current focused View.<br>
+ /// Clears the focus from the current focused view if any, so that no view is focused in the focus chain.<br />
+ /// It will emit the FocusChanged event without the current focused view.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void ClearFocus()
{
NDalicManualPINVOKE.FocusManager_ClearFocus(swigCPtr);
}
/// <summary>
- /// Move the focus to prev focused view.
+ /// Move the focus to previous focused view.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void MoveFocusBackward()
{
NDalicManualPINVOKE.FocusManager_MoveFocusBackward(swigCPtr);
}
/// <summary>
- /// Sets/Gets the status of whether the focus movement should be looped within the same focus group.<br>
- /// The focus movement is not looped by default.<br>
+ /// Gets or sets the status of whether the focus movement should be looped within the same focus group.<br />
+ /// The focus movement is not looped by default.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGroupLoop
{
set
}
/// <summary>
- /// Sets whether an View is a focus group that can limit the scope of focus movement to its child views in the focus chain.<br>
- /// Layout controls set themselves as focus groups by default.<br>
+ /// Sets whether the view is a focus group that can limit the scope of the focus movement to its child views in the focus chain.<br />
+ /// Layout controls set themselves as focus groups by default.<br />
/// </summary>
- /// <param name="view">The View to be set as a focus group</param>
- /// <param name="isFocusGroup">Whether to set the View as a focus group or not</param>
+ /// <param name="view">The view to be set as a focus group.</param>
+ /// <param name="isFocusGroup">Whether to set the view as a focus group or not.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetAsFocusGroup(View view, bool isFocusGroup)
{
NDalicManualPINVOKE.FocusManager_SetAsFocusGroup(swigCPtr, View.getCPtr(view), isFocusGroup);
/// <summary>
/// Checks whether the view is set as a focus group or not.
/// </summary>
- /// <param name="view">The View to be checked</param>
- /// <returns>Whether the View is set as a focus group</returns>
+ /// <param name="view">The view to be checked.</param>
+ /// <returns>Whether the view is set as a focus group.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsFocusGroup(View view)
{
bool ret = NDalicManualPINVOKE.FocusManager_IsFocusGroup(swigCPtr, View.getCPtr(view));
/// <summary>
/// Returns the closest ancestor of the given view that is a focus group.
/// </summary>
- /// <param name="view">The View to be checked for its focus group</param>
- /// <returns>The focus group the given view belongs to or an empty handle if the given view</returns>
+ /// <param name="view">The view to be checked for its focus group.</param>
+ /// <returns>The focus group the given view belongs to or an empty handle if the given view.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetFocusGroup(View view)
{
IntPtr cPtr = NDalicManualPINVOKE.FocusManager_GetFocusGroup(swigCPtr, View.getCPtr(view));
}
/// <summary>
- /// Sets/Gets the focus indicator View.<br>
- /// This will replace the default focus indicator view in FocusManager and will be added to the focused view as a highlight.<br>
+ /// Gets or sets the focus indicator view.<br />
+ /// This will replace the default focus indicator view in the FocusManager and will be added to the focused view as a highlight.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View FocusIndicator
{
set
}
/// <summary>
- /// Provide the implementation of custom Focus algorithm interface to allow the app define the focus logic.<br>
+ /// Provides the implementation of a custom focus algorithm interface to allow the application to define the focus logic.<br />
/// </summary>
- /// <param name="arg0">The user's implementation of ICustomFocusAlgorithm</param>
+ /// <param name="arg0">The user's implementation of ICustomFocusAlgorithm.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetCustomAlgorithm(ICustomFocusAlgorithm arg0)
{
_customAlgorithmInterfaceWrapper = new CustomAlgorithmInterfaceWrapper();
private static readonly FocusManager instance = FocusManager.Get();
/// <summary>
- /// Gets the singleton of FocusManager object.
+ /// Gets the singleton of the FocusManager object.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static FocusManager Instance
{
get
}
/// <summary>
- /// ICustomFocusAlgorithm is used to provide custom keyboard focus algorithm for retrieving the next focusable view.<br>
- /// The application can implement the interface and override the keyboard focus behaviour.<br>
- /// If focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.<br>
- /// If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine next focusable actor.<br>
- /// If focusable properties are not set, then the Keyboard FocusManager calls the GetNextFocusableView() method of this interface.<br>
+ /// ICustomFocusAlgorithm is used to provide the custom keyboard focus algorithm for retrieving the next focusable view.<br />
+ /// The application can implement the interface and override the keyboard focus behavior.<br />
+ /// If the focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.<br />
+ /// If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine the next focusable actor.<br />
+ /// If focusable properties are not set, then the keyboard FocusManager calls the GetNextFocusableView() method of this interface.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public interface ICustomFocusAlgorithm
{
+ /// <summary>
+ /// Get the next focus actor.
+ /// </summary>
+ /// <param name="current">The current focus view.</param>
+ /// <param name="proposed">The proposed focus view</param>
+ /// <param name="direction">The focus move direction</param>
+ /// <returns>The next focus actor.</returns>
+ /// <since_tizen> 3 </since_tizen>
View GetNextFocusableView(View current, View proposed, View.FocusDirection direction);
}
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated.
+ /// Instead please use FocusedViewActivatedEventArgs.
+ [Obsolete("Please do not use! This will be deprecated! Please use FocusedViewActivatedEventArgs instead! " +
+ "Like: " +
+ "FocusManager.Instance.FocusedViewActivated = OnFocusedViewActivated; " +
+ "private void OnFocusedViewActivated(object source, FocusManager.FocusedViewActivatedEventArgs arg)" +
+ "{...}")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class FocusedViewEnterKeyEventArgs : EventArgs
{
private View _view;
+ /// <summary>
+ /// View.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
private delegate void FocusedViewEnterKeyEventCallback2(IntPtr view);
private FocusedViewEnterKeyEventCallback2 _focusedViewEnterKeyEventCallback2;
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use FocusedViewActivated.
+ [Obsolete("Please do not use! This will be deprecated! Please use FocusManager.FocusedViewActivated instead! " +
+ "Like: " +
+ "FocusManager.Instance.FocusedViewActivated = OnFocusedViewActivated; " +
+ "private void OnFocusedViewActivated(object source, FocusManager.FocusedViewActivatedEventArgs args) {...}")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler<FocusedViewEnterKeyEventArgs> FocusedViewEnterKeyPressed
{
add
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated!
+ /// </summary>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use OnFocusedViewEnterKey.
+ [Obsolete("Please do not use! This will be deprecated! Please use FocusManager.OnFocusedViewEnterKey instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
private void OnFocusedViewEnterKey2(IntPtr view)
{
FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// Geometry is handle to an object that can be used to define a geometric elements.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Geometry : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
+ /// <summary>
+ /// Create an instance of Geometry.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Geometry() : this(NDalicPINVOKE.Geometry_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Adds a PropertyBuffer to be used as source of geometry vertices.
+ /// </summary>
+ /// <param name="vertexBuffer">PropertyBuffer to be used as source of geometry vertices.</param>
+ /// <returns>Index of the newly added buffer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint AddVertexBuffer(PropertyBuffer vertexBuffer)
{
uint ret = NDalicPINVOKE.Geometry_AddVertexBuffer(swigCPtr, PropertyBuffer.getCPtr(vertexBuffer));
return ret;
}
+ /// <summary>
+ /// Retrieves the number of vertex buffers that have been added to this geometry.
+ /// </summary>
+ /// <returns>Number of vertex buffers that have been added to this geometry.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetNumberOfVertexBuffers()
{
uint ret = NDalicPINVOKE.Geometry_GetNumberOfVertexBuffers(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Removes a vertex buffer.
+ /// </summary>
+ /// <param name="index">Index to the vertex buffer to remove.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveVertexBuffer(uint index)
{
NDalicPINVOKE.Geometry_RemoveVertexBuffer(swigCPtr, index);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets a the index data to be used as a source of indices for the geometry
+ /// Setting this buffer will cause the geometry to be rendered using indices.
+ /// </summary>
+ /// <param name="indices">Array of indices.</param>
+ /// <param name="count">Number of indices in the array.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetIndexBuffer(ushort[] indices, uint count)
{
NDalicPINVOKE.Geometry_SetIndexBuffer(swigCPtr, indices, count);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the type of primitives this geometry contains.
+ /// </summary>
+ /// <param name="geometryType">Array of indices.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetType(Geometry.Type geometryType)
{
NDalicPINVOKE.Geometry_SetType(swigCPtr, (int)geometryType);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public Geometry.Type GetType()
+ /// <summary>
+ /// Gets the type of primitives this geometry contains.
+ /// </summary>
+ /// <returns>Type of primitives this geometry contains.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ public new Geometry.Type GetType()
{
Geometry.Type ret = (Geometry.Type)NDalicPINVOKE.Geometry_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Enumeration for the description of the type of geometry,
+ /// used to determine how the coordinates will be used.
+ /// </summary>
+ /// <returns>Type of primitives this geometry contains.</returns>
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
+ /// <summary>
+ /// Individual points.
+ /// </summary>
POINTS,
+
+ /// <summary>
+ /// Individual lines (made of 2 points each).
+ /// </summary>
LINES,
+
+ /// <summary>
+ /// A strip of lines (made of 1 point each) which also joins the first and last point.
+ /// </summary>
LINE_LOOP,
+
+ /// <summary>
+ /// A strip of lines (made of 1 point each).
+ /// </summary>
LINE_STRIP,
+
+ /// <summary>
+ /// Individual triangles (made of 3 points each).
+ /// </summary>
TRIANGLES,
+
+ /// <summary>
+ /// A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point).
+ /// </summary>
TRIANGLE_FAN,
+
+ /// <summary>
+ /// A strip of triangles (after the first triangle, following triangles need only 1 point).
+ /// </summary>
TRIANGLE_STRIP
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// Base structure for different gestures that an application can receive.<br>
- /// A gesture is an event that is produced from a combination of several touch events
- /// in a particular order or within a certain time frame (e.g pinch).<br>
+ /// Base structure for different gestures that an application can receive.<br />
+ /// A Gesture is an event that is produced from a combination of several touch events
+ /// in a particular order or within a certain time frame (for example, pinch).<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Gesture : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Gesture(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Gesture()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// The gesture type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Gesture.GestureType Type
{
get
/// <summary>
/// The gesture state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Gesture.StateType State
{
get
/// <summary>
/// The time the gesture took place.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Time
{
get
}
/// <summary>
- /// Copy constructor.
+ /// The Copy constructor.
/// </summary>
/// <param name="rhs">A reference to the copied handle</param>
+ /// <since_tizen> 3 </since_tizen>
public Gesture(Gesture rhs) : this(NDalicPINVOKE.new_Gesture(Gesture.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Enumeration for type of gesture
+ /// Enumeration for type of gesture.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum GestureType
{
+ /// <summary>
+ /// When two touch points move away or towards each other.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Pinch = 1 << 0,
+ /// <summary>
+ /// When the user drags their finger(s) in a particular direction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Pan = 1 << 1,
+ /// <summary>
+ /// When the user taps the screen.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Tap = 1 << 2,
+ /// <summary>
+ /// When the user continues to touch the same area on the screen for the device configured time.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LongPress = 1 << 3
}
/// <summary>
/// Enumeration for state of the gesture.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum StateType
{
+ /// <summary>
+ /// There is no state associated with this gesture.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Clear,
+ /// <summary>
+ /// The touched points on the screen have moved enough to be considered a gesture.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Started,
+ /// <summary>
+ /// The gesture is continuing.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Continuing,
+ /// <summary>
+ /// The user has lifted a finger or touched an additional point on the screen.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Finished,
+ /// <summary>
+ /// The gesture has been cancelled.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Cancelled,
+ /// <summary>
+ /// A gesture is possible.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Possible
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Hover events are a collection of points at a specific moment in time.<br>
- /// When a multi event occurs, each point represents the points that are currently being
- /// hovered or the points where a hover has stopped.<br>
+ /// Hover events are a collection of points at a specific moment in time.<br />
+ /// When a multi-event occurs, each point represents the points that are currently being
+ /// hovered or the points where a hover has stopped.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Hover : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Hover(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Hover()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// The time (in ms) that the hover event occurred.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Time
{
get
}
/// <summary>
- /// Returns the ID of the device used for the Point specified.<br>
+ /// Returns the ID of the device used for the point specified.<br />
/// Each point has a unique device ID which specifies the device used for that
- /// point. This is returned by this method.<br>
+ /// point. This is returned by this method.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The Device ID of this poin</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The device ID of this point.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetDeviceId(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the State of the point specified.
+ /// Retrieves the state of the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The state of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The state of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PointStateType GetState(uint point)
{
if (point < points.Count)
/// <summary>
/// Retrieves the view that was underneath the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The view that was underneath the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The view that was underneath the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetHitView(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the hit-view at the point specified.
+ /// Retrieves the coordinates relative to the top-left of the hit-view at the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the hit-view of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the hit-view of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetLocalPosition(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
+ /// Retrieves the coordinates relative to the top-left of the screen of the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the screen of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the screen of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetScreenPosition(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Hover() : this(NDalicPINVOKE.new_Hover__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="time">The time the event occurred</param>
+ /// <param name="time">The time the event occurred.</param>
internal Hover(uint time) : this(NDalicPINVOKE.new_Hover__SWIG_1(time), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Returns the total number of points.
/// </summary>
- /// <returns>Total number of Points</returns>
+ /// <returns>Total number of points.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetPointCount()
{
uint ret = NDalicPINVOKE.Hover_GetPointCount(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
using System;
using System.Runtime.InteropServices;
namespace Tizen.NUI
{
/// <summary>
- /// Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
+ /// Specifically manages the input method framework which enables the virtual or hardware keyboards.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImfManager : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// This structure is used to pass on data from the IMF regarding predictive text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImfEventData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal ImfEventData(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~ImfEventData()
{
if (!isDisposeQueued)
}
/// <summary>
- /// Dispose pattern
+ /// The dispose pattern.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Default Constructor
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImfEventData() : this(NDalicManualPINVOKE.new_ImfManager_ImfEventData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
/// <param name="aEventName">The name of the event from the IMF.</param>
- /// <param name="aPredictiveString">The pre-edit or commit string.</param>
- /// <param name="aCursorOffset">Start position from the current cursor position to start deleting characters.</param>
+ /// <param name="aPredictiveString">The pre-edit or the commit string.</param>
+ /// <param name="aCursorOffset">Start the position from the current cursor position to start deleting characters.</param>
/// <param name="aNumberOfChars">The number of characters to delete from the cursorOffset.</param>
+ /// <since_tizen> 3 </since_tizen>
public ImfEventData(ImfManager.ImfEvent aEventName, string aPredictiveString, int aCursorOffset, int aNumberOfChars) : this(NDalicManualPINVOKE.new_ImfManager_ImfEventData__SWIG_1((int)aEventName, aPredictiveString, aCursorOffset, aNumberOfChars), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// The pre-edit or commit string.
+ /// The pre-edit or the commit string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string PredictiveString
{
set
/// <summary>
/// The name of the event from the IMF.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public ImfManager.ImfEvent EventName
{
set
}
/// <summary>
- /// Start position from the current cursor position to start deleting characters.
+ /// The start position from the current cursor position to start deleting characters.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CursorOffset
{
set
}
/// <summary>
- /// Number of characters to delete from the cursorOffset.
+ /// The number of characters to delete from the cursorOffset.
/// </summary>
public int NumberOfChars
{
}
/// <summary>
- /// Data required by IMF from the callback.
+ /// Data required by the IMF from the callback.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImfCallbackData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal ImfCallbackData(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~ImfCallbackData()
{
if (!isDisposeQueued)
}
/// <summary>
- /// Dispose pattern
+ /// The dispose pattern.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Default Constructor
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImfCallbackData() : this(NDalicManualPINVOKE.new_ImfManager_ImfCallbackData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="aUpdate">True if cursor position needs to be updated.</param>
- /// <param name="aCursorPosition">New position of cursor.</param>
- /// <param name="aCurrentText">Current text string.</param>
+ /// <param name="aUpdate">True if the cursor position needs to be updated.</param>
+ /// <param name="aCursorPosition">The new position of the cursor.</param>
+ /// <param name="aCurrentText">The current text string.</param>
/// <param name="aPreeditResetRequired">Flag if preedit reset is required.</param>
+ /// <since_tizen> 3 </since_tizen>
public ImfCallbackData(bool aUpdate, int aCursorPosition, string aCurrentText, bool aPreeditResetRequired) : this(NDalicManualPINVOKE.new_ImfManager_ImfCallbackData__SWIG_1(aUpdate, aCursorPosition, aCurrentText, aPreeditResetRequired), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Current text string.
+ /// The current text string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string CurrentText
{
set
}
/// <summary>
- /// Current text string.
+ /// The current text string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CursorPosition
{
set
}
/// <summary>
- /// If cursor position needs to be updated.
+ /// If the cursor position needs to be updated.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool Update
{
set
}
/// <summary>
- /// Flag if preedit reset is required.
+ /// Flags if preedit reset is required.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool PreeditResetRequired
{
set
/// Retrieve a handle to the instance of ImfManager.
/// </summary>
/// <returns>A handle to the ImfManager.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static ImfManager Get()
{
ImfManager ret = new ImfManager(NDalicManualPINVOKE.ImfManager_Get(), true);
}
/// <summary>
- /// Activate the IMF.<br/>
- /// It means that the text editing is started at somewhere.<br/>
- /// If the H/W keyboard isn't connected then it will show the virtual keyboard.
+ /// Activates the IMF.<br/>
+ /// It means that the text editing is started somewhere.<br/>
+ /// If the hardware keyboard isn't connected, then it will show the virtual keyboard.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Activate()
{
NDalicManualPINVOKE.ImfManager_Activate(swigCPtr);
}
/// <summary>
- /// Deactivate the IMF.<br/>
- /// It means that the text editing is finished at somewhere.
+ /// Deactivates the IMF.<br/>
+ /// It means that the text editing is finished somewhere.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Deactivate()
{
NDalicManualPINVOKE.ImfManager_Deactivate(swigCPtr);
}
/// <summary>
- /// Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.<br/>
- /// If true then keyboard will be restored (activated) after focus is regained.
+ /// Gets the restoration status which controls if the keyboard is restored after the focus is lost and then regained.<br/>
+ /// If true, then the keyboard will be restored (activated) after focus is regained.
/// </summary>
- /// <returns>Restoration status.</returns>
+ /// <returns>The restoration status.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool RestoreAfterFocusLost()
{
bool ret = NDalicManualPINVOKE.ImfManager_RestoreAfterFocusLost(swigCPtr);
}
/// <summary>
- /// Set status whether the IMF has to restore the keyboard after losing focus.
+ /// Sets the status whether the IMF has to restore the keyboard after losing focus.
/// </summary>
- /// <param name="toggle">True means that keyboard should be restored after focus lost and regained.</param>
+ /// <param name="toggle">True means that keyboard should be restored after the focus is lost and regained.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetRestoreAfterFocusLost(bool toggle)
{
NDalicManualPINVOKE.ImfManager_SetRestoreAfterFocusLost(swigCPtr, toggle);
}
/// <summary>
- /// Send message reset the pred-edit state / imf module.
+ /// Sends a message reset to the preedit state or the IMF module.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public new void Reset()
{
NDalicManualPINVOKE.ImfManager_Reset(swigCPtr);
}
/// <summary>
- /// Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
+ /// Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void NotifyCursorPosition()
{
NDalicManualPINVOKE.ImfManager_NotifyCursorPosition(swigCPtr);
}
/// <summary>
- /// Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ /// Sets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
/// </summary>
- /// <param name="cursorPosition">Position of cursor.</param>
+ /// <param name="cursorPosition">The position of the cursor.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetCursorPosition(uint cursorPosition)
{
NDalicManualPINVOKE.ImfManager_SetCursorPosition(swigCPtr, cursorPosition);
}
/// <summary>
- /// Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ /// Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
/// </summary>
- /// <returns>Current position of cursor</returns>
+ /// <returns>The current position of the cursor.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetCursorPosition()
{
uint ret = NDalicManualPINVOKE.ImfManager_GetCursorPosition(swigCPtr);
}
/// <summary>
- /// Method to store the string required by the IMF, this is used to provide predictive word suggestions.
+ /// A method to store the string required by the IMF, this is used to provide predictive word suggestions.
/// </summary>
/// <param name="text">The text string surrounding the current cursor point.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetSurroundingText(string text)
{
NDalicManualPINVOKE.ImfManager_SetSurroundingText(swigCPtr, text);
}
/// <summary>
- /// Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
+ /// Gets the current text string set within the IMF manager, this is used to offer predictive suggestions.
/// </summary>
- /// <returns>Surrounding text.</returns>
+ /// <returns>The surrounding text.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetSurroundingText()
{
string ret = NDalicManualPINVOKE.ImfManager_GetSurroundingText(swigCPtr);
}
/// <summary>
- /// Notifies IMF context that text input is set to multi line or not.
+ /// Notifies the IMF context that text input is set to multiline or not.
/// </summary>
/// <param name="multiLine">True if multiline text input is used.</param>
+ /// <since_tizen> 3 </since_tizen>
public void NotifyTextInputMultiLine(bool multiLine)
{
NDalicManualPINVOKE.ImfManager_NotifyTextInputMultiLine(swigCPtr, multiLine);
}
/// <summary>
- /// Returns text direction of the keyboard's current input language.
+ /// Returns the text direction of the keyboard's current input language.
/// </summary>
/// <returns>The direction of the text.</returns>
+ /// <since_tizen> 3 </since_tizen>
public ImfManager.TextDirection GetTextDirection()
{
ImfManager.TextDirection ret = (ImfManager.TextDirection)NDalicManualPINVOKE.ImfManager_GetTextDirection(swigCPtr);
}
/// <summary>
- /// Provides size and position of keyboard.<br/>
- /// Position is relative to whether keyboard is visible or not.<br/>
- /// If keyboard is not visible then position will be off the screen.<br/>
- /// If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get<br/>
- /// the values then taken down. So ideally GetInputMethodArea() should be called after Show().
+ /// Provides the size and the position of the keyboard.<br/>
+ /// The position is relative to whether the keyboard is visible or not.<br/>
+ /// If the keyboard is not visible, then the position will be off the screen.<br/>
+ /// If the keyboard is not being shown when this method is called, the keyboard is partially setup (IMFContext) to get/>
+ /// the values then taken down. So ideally, GetInputMethodArea() should be called after Show().
/// </summary>
- /// <returns>Rectangle which is keyboard panel x, y, width, height</returns>
+ /// <returns>Rectangle which is keyboard panel x, y, width, height.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle GetInputMethodArea()
{
Rectangle ret = new Rectangle(NDalicManualPINVOKE.ImfManager_GetInputMethodArea(swigCPtr), true);
/// Sets up the input-panel specific data.
/// </summary>
/// <param name="text">The specific data to be set to the input panel.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetInputPanelUserData(string text)
{
NDalicManualPINVOKE.ImfManager_SetInputPanelUserData(swigCPtr, text);
/// <summary>
/// Gets the specific data of the current active input panel.
/// </summary>
- /// <param name="text">The specific data to be got from the input panel.</param>
+ /// <param name="text">The specific data to be received from the input panel.</param>
+ /// <since_tizen> 4 </since_tizen>
public void GetInputPanelUserData(out string text)
{
NDalicManualPINVOKE.ImfManager_GetInputPanelUserData(swigCPtr, out text);
/// Gets the state of the current active input panel.
/// </summary>
/// <returns>The state of the input panel.</returns>
+ /// <since_tizen> 3 </since_tizen>
public ImfManager.State GetInputPanelState()
{
ImfManager.State ret = (ImfManager.State)NDalicManualPINVOKE.ImfManager_GetInputPanelState(swigCPtr);
/// Sets the return key on the input panel to be visible or invisible.<br/>
/// The default is true.
/// </summary>
- /// <param name="visible">True if the return key is visible(enabled), false otherwise.</param>
+ /// <param name="visible">True if the return key is visible (enabled), false otherwise.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetReturnKeyState(bool visible)
{
NDalicManualPINVOKE.ImfManager_SetReturnKeyState(swigCPtr, visible);
}
/// <summary>
- /// Enable to show the input panel automatically when focused.
+ /// Enables to show the input panel automatically when focused.
/// </summary>
/// <param name="enabled">If true, the input panel will be shown when focused.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AutoEnableInputPanel(bool enabled)
{
NDalicManualPINVOKE.ImfManager_AutoEnableInputPanel(swigCPtr, enabled);
/// <summary>
/// Shows the input panel.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void ShowInputPanel()
{
NDalicManualPINVOKE.ImfManager_ShowInputPanel(swigCPtr);
/// <summary>
/// Hides the input panel.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void HideInputPanel()
{
NDalicManualPINVOKE.ImfManager_HideInputPanel(swigCPtr);
/// Gets the keyboard type.<br/>
/// The default keyboard type is SoftwareKeyboard.
/// </summary>
- /// <returns>The keyboard type</returns>
+ /// <returns>The keyboard type.</returns>
+ /// <since_tizen> 4 </since_tizen>
public ImfManager.KeyboardType GetKeyboardType()
{
ImfManager.KeyboardType ret = (ImfManager.KeyboardType)NDalicManualPINVOKE.ImfManager_GetKeyboardType(swigCPtr);
/// <summary>
/// Gets the current language locale of the input panel.<br/>
- /// Ex) en_US, en_GB, en_PH, fr_FR, ...
+ /// For example, en_US, en_GB, en_PH, fr_FR, ...
/// </summary>
/// <returns>The current language locale of the input panel.</returns>
+ /// <since_tizen> 4 </since_tizen>
public string GetInputPanelLocale()
{
string ret = NDalicManualPINVOKE.ImfManager_GetInputPanelLocale(swigCPtr);
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImfManager() : this(NDalicManualPINVOKE.new_ImfManager(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// The direction of text.
+ /// The direction of the text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TextDirection
{
/// <summary>
/// <summary>
/// Events that are generated by the IMF.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ImfEvent
{
/// <summary>
/// No event.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Void,
/// <summary>
/// Pre-Edit changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Preedit,
/// <summary>
- /// Commit recieved.
+ /// Commit received.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Commit,
/// <summary>
- /// Event to delete a range of characters from the string.
+ /// An event to delete a range of characters from the string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
DeleteSurrounding,
/// <summary>
- /// Event to query string and cursor position.
+ /// An event to query string and the cursor position.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
GetSurrounding,
/// <summary>
/// Private command sent from the input panel.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
PrivateCommand
}
/// <summary>
- /// Enumeration for state of the input panel.
+ /// Enumeration for the state of the input panel.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum State
{
/// <summary>
/// Unknown state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Default = 0,
/// <summary>
/// Input panel is shown.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Show,
/// <summary>
/// Input panel is hidden.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Hide,
/// <summary>
/// Input panel in process of being shown.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
WillShow
}
/// <summary>
- /// Enumeration for the type of Keyboard.
+ /// Enumeration for the types of keyboard.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum KeyboardType
{
/// <summary>
- /// Software keyboard (Virtual keyboard) is default.
+ /// Software keyboard (virtual keyboard) is default.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
SoftwareKeyboard,
/// <summary>
/// Hardware keyboard.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
HardwareKeyboard
}
}
/// <summary>
/// A class encapsulating the input method map.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class InputMethod
{
private PanelLayoutType? _panelLayout = null;
private int? _variation = null;
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public InputMethod()
{
}
/// <summary>
- /// Get or set panel layout.
+ /// Gets or sets the panel layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PanelLayoutType PanelLayout
{
get
}
/// <summary>
- /// Get or set action button.
+ /// Gets or sets the action button.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ActionButtonTitleType ActionButton
{
get
}
/// <summary>
- /// Get or set auto capital.
+ /// Gets or sets the auto capital.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AutoCapitalType AutoCapital
{
get
}
/// <summary>
- /// Get or set variation.
+ /// Gets or sets the variation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Variation
{
get
}
/// <summary>
- /// Get or set variation for normal layout.
+ /// Gets or sets the variation for normal layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public NormalLayoutType NormalVariation
{
get
}
/// <summary>
- /// Get or set variation for number only layout.
+ /// Gets or sets the variation for the number only layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public NumberOnlyLayoutType NumberOnlyVariation
{
get
}
/// <summary>
- /// Get or set variation for password layout.
+ /// Gets or sets the variation for the password layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PasswordLayoutType PasswordVariation
{
get
}
/// <summary>
- /// Get the input method map.
+ /// Gets the input method map.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap OutputMap
{
get
}
/// <summary>
- /// SetType that can be changed in the system Input Method.
+ /// SetType that can be changed in the system input method.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum CategoryType
{
/// <summary>
- /// Set Keyboard layout.
+ /// Set the keyboard layout.
/// </summary>
PanelLayout,
/// <summary>
- /// Set Action button title.
+ /// Set the action button title.
/// </summary>
ActionButtonTitle,
/// <summary>
- /// Set Auto capitalise of input.
+ /// Set the auto capitalise of input.
/// </summary>
AutoCapitalise,
/// <summary>
- /// Set variation.
+ /// Set the variation.
/// </summary>
Variation
}
/// <summary>
/// Autocapitalization Types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum AutoCapitalType
{
/// <summary>
/// <summary>
/// Input panel (virtual keyboard) layout types..
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PanelLayoutType
{
/// <summary>
/// </summary>
HEX,
/// <summary>
- /// Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization).
+ /// Command-line terminal layout including Esc, Alt, Ctrl key, and so on (no auto-correct, no auto-capitalization).
/// </summary>
Terminal,
/// <summary>
/// <summary>
/// Specifies what the Input Method "action" button functionality is set to.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ActionButtonTitleType
{
/// <summary>
}
/// <summary>
- /// Available variation for Normal layout.
+ /// Available variation for the normal layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum NormalLayoutType
{
/// <summary>
}
/// <summary>
- /// Available variation for Number only layout.
+ /// Available variation for the number only layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum NumberOnlyLayoutType
{
/// <summary>
}
/// <summary>
- /// Available variation for Password layout.
+ /// Available variation for the password layout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PasswordLayoutType
{
/// <summary>
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
/// The key structure is used to store a key press.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Key : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Key(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Key()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type.</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
return ret;
}
+ /// <summary>
+ /// Device name
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string DeviceName
{
get
}
/// <summary>
- /// Name given to the key pressed
+ /// Name given to the key pressed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string KeyPressedName
{
get
/// <summary>
/// Keycode for the key pressed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int KeyCode
{
get
}
/// <summary>
- /// Special keys like shift, alt and control which modify the next key pressed.
+ /// Special keys like Shift, Alt, and Ctrl which modify the next key pressed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int KeyModifier
{
get
/// <summary>
/// The time (in ms) that the key event occurred.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Time
{
get
/// <summary>
/// State of the key event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Key.StateType State
{
get
}
}
+ /// <summary>
+ /// Get the device class the key event originated from.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public DeviceClassType DeviceClass
{
get
/// <summary>
- /// Default Constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Key() : this(NDalicPINVOKE.new_Key__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="keyName">The name of the key pressed or command from the IMF, if later then the some following parameters will be needed</param>
- /// <param name="keyString">A string of input characters or key pressed</param>
- /// <param name="keyCode">The unique key code for the key pressed</param>
- /// <param name="keyModifier">The key modifier for special keys like shift and alt</param>
- /// <param name="timeStamp">The time (in ms) that the key event occurred</param>
- /// <param name="keyState">The state of the key event</param>
+ /// <param name="keyName">The name of the key pressed or command from the IMF, if later, then the following parameters will be needed.</param>
+ /// <param name="keyString">A string of input characters or key pressed.</param>
+ /// <param name="keyCode">The unique key code for the key pressed.</param>
+ /// <param name="keyModifier">The key modifier for special keys like Shift and Alt.</param>
+ /// <param name="timeStamp">The time (in ms) that the key event occurred.</param>
+ /// <param name="keyState">The state of the key event.</param>
internal Key(string keyName, string keyString, int keyCode, int keyModifier, uint timeStamp, Key.StateType keyState) : this(NDalicPINVOKE.new_Key__SWIG_1(keyName, keyString, keyCode, keyModifier, timeStamp, (int)keyState), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Checks to see if Shift key modifier has been supplied.
+ /// Checks to see if the Shift key modifier has been supplied.
/// </summary>
- /// <returns>True if shift modifier</returns>
+ /// <returns>True if Shift modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsShiftModifier()
{
bool ret = NDalicPINVOKE.Key_IsShiftModifier(swigCPtr);
/// <summary>
/// Checks to see if Ctrl (control) key modifier has been supplied.
/// </summary>
- /// <returns>True if ctrl modifier</returns>
+ /// <returns>True if Ctrl modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsCtrlModifier()
{
bool ret = NDalicPINVOKE.Key_IsCtrlModifier(swigCPtr);
/// <summary>
/// Checks to see if Alt key modifier has been supplied.
/// </summary>
- /// <returns>True if alt modifier</returns>
+ /// <returns>True if Alt modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsAltModifier()
{
bool ret = NDalicPINVOKE.Key_IsAltModifier(swigCPtr);
/// <summary>
/// Enumeration for specifying the state of the key event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum StateType
{
+ /// <summary>
+ /// Key Down.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Down,
+ /// <summary>
+ /// Key Up.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Up,
+ /// <summary>
+ /// Key Last.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Last
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
/// <summary>
- /// A set of key frames for a property that can be animated using Dali Animation.<br>
- /// This allows the generation of key frame objects from individual Property::Values.<br>
+ /// A set of key frames for a property that can be animated using DALi animation.<br />
+ /// This allows the generation of key frame objects from individual Property::Values.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class KeyFrames : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
/// <summary>
/// Adds a key frame.
/// </summary>
- /// <param name="progress">A progress value between 0.0 and 1.0</param>
- /// <param name="value">A value</param>
+ /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+ /// <param name="value">A value.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(float progress, object value)
{
PropertyValue val = PropertyValue.CreateFromObject(value);
/// <summary>
/// Adds a key frame.
/// </summary>
- /// <param name="progress">A progress value between 0.0 and 1.0</param>
+ /// <param name="progress">A progress value between 0.0 and 1.0.</param>
/// <param name="value">A value</param>
- /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
+ /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(float progress, object value, AlphaFunction alpha)
{
PropertyValue val = PropertyValue.CreateFromObject(value);
/// <summary>
/// Creates an initialized KeyFrames handle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public KeyFrames() : this(NDalicPINVOKE.KeyFrames_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to keyFrame handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static KeyFrames DownCast(BaseHandle handle)
{
KeyFrames ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as KeyFrames;
/// Gets the type of the key frame.
/// </summary>
/// <returns>The key frame property type</returns>
- public PropertyType GetType()
+ /// <since_tizen> 3 </since_tizen>
+ public new PropertyType GetType()
{
PropertyType ret = (PropertyType)NDalicPINVOKE.KeyFrames_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Adds a key frame.
/// </summary>
- /// <param name="progress">A progress value between 0.0 and 1.0</param>
- /// <param name="value">A value</param>
+ /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+ /// <param name="value">A value.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(float progress, PropertyValue value)
{
NDalicPINVOKE.KeyFrames_Add__SWIG_0(swigCPtr, progress, PropertyValue.getCPtr(value));
/// <summary>
/// Adds a key frame.
/// </summary>
- /// <param name="progress">A progress value between 0.0 and 1.0</param>
- /// <param name="value">A value</param>
- /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
+ /// <param name="progress">A progress value between 0.0 and 1.0.</param>
+ /// <param name="value">A value.</param>
+ /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(float progress, PropertyValue value, AlphaFunction alpha)
{
NDalicPINVOKE.KeyFrames_Add__SWIG_1(swigCPtr, progress, PropertyValue.getCPtr(value), AlphaFunction.getCPtr(alpha));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using Tizen.NUI.BaseComponents;
+using System.ComponentModel;
namespace Tizen.NUI
{
- using System;
- using Tizen.NUI.BaseComponents;
/// <summary>
/// Layers provide a mechanism for overlaying groups of actors on top of each other.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Layer : Container
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
- /// from Container base class
+ /// From the Container base class.
/// <summary>
/// Adds a child view to this layer.
/// </summary>
- /// <seealso cref="Container::Add()">
+ /// <seealso cref="Container.Add">
/// </seealso>
+ /// <since_tizen> 4 </since_tizen>
public override void Add(View child)
{
NDalicPINVOKE.Actor_Add(swigCPtr, View.getCPtr(child));
}
/// <summary>
- /// Removes a child View from this layer. If the view was not a child of this layer, this is a no-op.
+ /// Removes a child view from this layer. If the view was not a child of this layer, this is a no-op.
/// </summary>
- /// <seealso cref="Container::Add()">
+ /// <seealso cref="Container.Remove">
/// </seealso>
+ /// <since_tizen> 4 </since_tizen>
public override void Remove(View child)
{
NDalicPINVOKE.Actor_Remove(swigCPtr, View.getCPtr(child));
}
/// <summary>
- /// Retrieves child view by index.
+ /// Retrieves a child view by the index.
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <param name="index">The index of the child to retrieve</param>
- /// <returns>The view for the given index or empty handle if children not initialized</returns>
+ /// <pre>The view has been initialized.</pre>
+ /// <param name="index">The index of the child to retrieve.</param>
+ /// <returns>The view for the given index or empty handle if children not initialized.</returns>
+ /// <since_tizen> 4 </since_tizen>
public override View GetChildAt(uint index)
{
if (index < Children.Count)
return Convert.ToUInt32(Children.Count);
}
- ///
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
/// <summary>
/// Creates a Layer object.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Layer() : this(NDalicPINVOKE.Layer_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
- [Obsolete("Please do not use! this will be deprecated")]
- public new static Layer DownCast(BaseHandle handle)
+ /// <summary>
+ /// Downcasts a handle to layer handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Layer DownCast(BaseHandle handle)
{
Layer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Layer;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Search through this layer's hierarchy for an view with the given unique ID.
+ /// Search through this layer's hierarchy for a view with the given unique ID.
/// </summary>
- /// <pre>This layer(the parent) has been initialized.</pre>
+ /// <pre>This layer (the parent) has been initialized.</pre>
/// <remarks>The actor itself is also considered in the search.</remarks>
- /// <param name="child">The id of the child to find</param>
+ /// <param name="id">The id of the child to find</param>
/// <returns> A handle to the view if found, or an empty handle if not. </returns>
+ /// <since_tizen> 3 </since_tizen>
public View FindChildById(uint id)
{
IntPtr cPtr = NDalicPINVOKE.Actor_FindChildById(swigCPtr, id);
}
/// <summary>
- /// Queries the depth of the layer.<br>
- /// 0 is the bottom most layer, higher number is on top.<br>
+ /// Queries the depth of the layer.<br />
+ /// 0 is the bottommost layer, higher number is on the top.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Depth
{
get
/// <summary>
/// Increments the depth of the layer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Raise()
{
NDalicPINVOKE.Layer_Raise(swigCPtr);
/// <summary>
/// Decrements the depth of the layer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Lower()
{
NDalicPINVOKE.Layer_Lower(swigCPtr);
/// <summary>
/// Raises the layer to the top.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void RaiseToTop()
{
NDalicPINVOKE.Layer_RaiseToTop(swigCPtr);
/// <summary>
/// Lowers the layer to the bottom.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void LowerToBottom()
{
NDalicPINVOKE.Layer_LowerToBottom(swigCPtr);
}
/// <summary>
- /// Moves the layer directly above the given layer.<br>
- /// After the call, this layers depth will be immediately above target.<br>
+ /// Moves the layer directly above the given layer.<br />
+ /// After the call, this layer's depth will be immediately above target.<br />
/// </summary>
- /// <param name="target">Layer to get on top of</param>
+ /// <param name="target">The layer to get on top of.</param>
+ /// <since_tizen> 3 </since_tizen>
public void MoveAbove(Layer target)
{
NDalicPINVOKE.Layer_MoveAbove(swigCPtr, Layer.getCPtr(target));
}
/// <summary>
- /// Moves the layer directly below the given layer.<br>
- /// After the call, this layers depth will be immediately below target.<br>
+ /// Moves the layer directly below the given layer.<br />
+ /// After the call, this layer's depth will be immediately below target.<br />
/// </summary>
- /// <param name="target">Layer to get below of</param>
+ /// <param name="target">The layer to get below of.</param>
+ /// <since_tizen> 3 </since_tizen>
public void MoveBelow(Layer target)
{
NDalicPINVOKE.Layer_MoveBelow(swigCPtr, Layer.getCPtr(target));
/// <summary>
/// Enumeration for the behavior of the layer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum LayerBehavior
{
+ /// <summary>
+ /// UI control rendering mode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Layer2D,
+ /// <summary>
+ /// UI control rendering mode (default mode).
+ /// This mode is designed for UI controls that can overlap. In this
+ /// mode renderer order will be respective to the tree hierarchy of
+ /// Actors.<br />
+ /// The rendering order is depth first, so for the following actor tree,
+ /// A will be drawn first, then B, D, E, then C, F. This ensures that
+ /// overlapping actors are drawn as expected (whereas, with breadth first
+ /// traversal, the actors would interleave).<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LayerUI = Layer2D,
+ /// <summary>
+ /// Layer will use depth test.
+ /// This mode is designed for a 3 dimensional scene where actors in front
+ /// of other actors will obscure them, i.e. the actors are sorted by the
+ /// distance from the camera.<br />
+ /// When using this mode, a depth test will be used. A depth clear will
+ /// happen for each layer, which means actors in a layer "above" other
+ /// layers will be rendered in front of actors in those layers regardless
+ /// of their Z positions (see Layer::Raise() and Layer::Lower()).<br />
+ /// Opaque renderers are drawn first and write to the depth buffer. Then
+ /// transparent renderers are drawn with depth test enabled but depth
+ /// write switched off. Transparent renderers are drawn based on their
+ /// distance from the camera. A renderer's DEPTH_INDEX property is used to
+ /// offset the distance to the camera when ordering transparent renderers.
+ /// This is useful if you want to define the draw order of two or more
+ /// transparent renderers that are equal distance from the camera. Unlike
+ /// LAYER_UI, parent-child relationship does not affect rendering order at
+ /// all.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Layer3D
}
}
/// <summary>
- /// Layer Behavior, type String(Layer.LayerBehavior)
+ /// Layer behavior, type String (Layer.LayerBehavior).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Layer.LayerBehavior Behavior
{
get
}
/// <summary>
- /// Internal only property to Enable/Disable Clipping, type Boolean.
- /// By default this is false, i.e. the viewport of the Layer is the entire window.
+ /// Internal only property to enable or disable clipping, type boolean.
+ /// By default, this is false, i.e., the viewport of the layer is the entire window.
/// </summary>
internal bool ClippingEnabled
{
}
/// <summary>
- /// Sets the Viewport (in window coordinates), type Rectangle.
+ /// Sets the viewport (in window coordinates), type rectangle.
/// The contents of the layer will not be visible outside this box, when ViewportEnabled is true.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Rectangle Viewport
{
get
}
/// <summary>
- /// Retrieves and sets the Layer's opacity.<br>
+ /// Retrieves and sets the layer's opacity.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Opacity
{
get
}
/// <summary>
- /// Retrieves and sets the Layer's visibility.
+ /// Retrieves and sets the layer's visibility.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Visibility
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A LongPressGesture is emitted when the user holds the screen with the stated number of fingers.<br>
- /// Long press gesture finishes when all touches have been released.<br>
+ /// A long press gesture is emitted when the user holds the screen with the stated number of fingers.<br />
+ /// A long press gesture finishes when all touches have been released.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class LongPressGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// The number of touch points in this long press gesture, i.e. the number of fingers the user had
- /// on the screen to generate the long press gesture.<br>
+ /// The number of touch points in this long press gesture, i.e., the number of fingers the user had
+ /// on the screen to generate the long press gesture.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint NumberOfTouches
{
get
}
/// <summary>
- /// This is the point, in screen coordinates, where the long press occurred.<br>
- /// If a multi-touch long press, then this is the centroid of all the touch points.<br>
+ /// This is the point, in screen coordinates, where the long press occurred.<br />
+ /// If a multi-touch long press, then this is the centroid of all the touch points.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenPoint
{
get
}
/// <summary>
- /// This is the point, in local actor coordinates, where the long press occurred.<br>
- /// If a multi-touch long press, then this is the centroid of all the touch points.<br>
+ /// This is the point, in local actor coordinates, where the long press occurred.<br />
+ /// If a multi-touch long press, then this is the centroid of all the touch points.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 LocalPoint
{
get
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
/// <param name="state">The state of the gesture</param>
+ /// <since_tizen> 3 </since_tizen>
public LongPressGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_LongPressGesture__SWIG_0((int)state), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
*/
using System;
+using System.ComponentModel;
using Tizen.Applications;
using Tizen.Applications.CoreBackend;
-using Tizen.NUI;
namespace Tizen.NUI
{
/// <summary>
- /// Represents an application that have UI screen. The NUIApplication class has a default stage.
+ /// Represents an application that have a UI screen. The NUIApplication class has a default stage.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class NUIApplication : CoreApplication
{
/// <summary>
/// Occurs whenever the application is resumed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler Resumed;
/// <summary>
/// Occurs whenever the application is paused.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler Paused;
/// <summary>
/// <summary>
/// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public NUIApplication() : base(new NUICoreBackend())
{
}
/// <summary>
- /// The constructor with stylesheet.
+ /// The constructor with a stylesheet.
/// </summary>
- public NUIApplication(string stylesheet) : base(new NUICoreBackend(stylesheet))
+ /// <param name="styleSheet">The styleSheet url.</param>
+ /// <since_tizen> 3 </since_tizen>
+ public NUIApplication(string styleSheet) : base(new NUICoreBackend(styleSheet))
{
}
/// <summary>
- /// The constructor with stylesheet and window mode.
+ /// The constructor with a stylesheet and window mode.
/// </summary>
- public NUIApplication(string stylesheet, WindowMode windowMode) : base(new NUICoreBackend(stylesheet,windowMode))
+ /// <param name="styleSheet">The styleSheet url.</param>
+ /// <param name="windowMode">The windowMode.</param>
+ /// <since_tizen> 3 </since_tizen>
+ public NUIApplication(string styleSheet, WindowMode windowMode) : base(new NUICoreBackend(styleSheet, windowMode))
{
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnLocaleChanged(LocaleChangedEventArgs e)
{
Log.Debug("NUI", "OnLocaleChanged() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnLowBattery(LowBatteryEventArgs e)
{
- Log.Debug("NUI", "OnLowBattery() is called!");
base.OnLowBattery(e);
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnLowMemory(LowMemoryEventArgs e)
{
- Log.Debug("NUI", "OnLowMemory() is called!");
base.OnLowMemory(e);
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e)
{
Log.Debug("NUI", "OnRegionFormatChanged() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnTerminate()
{
- Log.Debug("NUI", "OnTerminate() is called!");
base.OnTerminate();
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected void OnPause()
{
Log.Debug("NUI", "OnPause() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void OnResume()
{
Log.Debug("NUI", "OnResume() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void OnPreCreate()
{
Log.Debug("NUI", "OnPreCreate() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnAppControlReceived(AppControlReceivedEventArgs e)
{
Log.Debug("NUI", "OnAppControlReceived() is called!");
}
/// <summary>
- /// Overrides this method if want to handle behavior.
+ /// Overrides this method if you want to handle behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void OnCreate()
{
// This is also required to create DisposeQueue on main thread.
}
/// <summary>
- /// Run NUIApplication.
+ /// Runs the NUIApplication.
/// </summary>
/// <param name="args">Arguments from commandline.</param>
+ /// <since_tizen> 4 </since_tizen>
public override void Run(string[] args)
{
string[] argsClone = null;
}
/// <summary>
- /// Exit NUIApplication.
+ /// Exits the NUIApplication.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public override void Exit()
{
Backend.Exit();
/// <summary>
/// Enumeration for deciding whether a NUI application window is opaque or transparent.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WindowMode
{
+ /// <summary>
+ /// Opaque
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Opaque = 0,
+ /// <summary>
+ /// Transparent
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Transparent = 1
}
}
namespace Tizen.NUI
{
+ /// <summary>
+ /// This specifies all the scroll mode type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ScrollModeType
{
- XAxisScrollEnabled,
- XAxisSnapToInterval,
- XAxisScrollBoundary,
- YAxisScrollEnabled,
- YAxisSnapToInterval,
- YAxisScrollBoundary
+ /// <summary>
+ /// Whether the content can be scrolled along the X axis or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ XAxisScrollEnabled,
+ /// <summary>
+ /// When set, causes scroll view to snap to multiples of the
+ /// value of the interval while flicking along the X axis.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ XAxisSnapToInterval,
+ /// <summary>
+ /// When set, the scroll view is unable to scroll beyond the
+ /// value of the boundary along the X axis.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ XAxisScrollBoundary,
+ /// <summary>
+ /// Whether the content can be scrolled along the Y axis or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ YAxisScrollEnabled,
+ /// <summary>
+ /// When set, causes scroll view to snap to multiples of the
+ /// value of the interval while flicking along the Y axis.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ YAxisSnapToInterval,
+ /// <summary>
+ /// When set, the scroll view is unable to scroll beyond the
+ /// value of the boundary along the Y axis.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ YAxisScrollBoundary
}
/// <summary>
- /// This specifies whether the Actor uses its own color, or inherits.
+ /// This specifies whether the actor uses its own color or inherits.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ColorMode
{
/// <summary>
/// </summary>
UseOwnMultiplyParentColor,
/// <summary>
- /// Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default.
+ /// Actor will blend its alpha with its parents alpha. This means when the parent fades in or out, the child does as well. This is the default.
/// </summary>
UseOwnMultiplyParentAlpha
}
/// <summary>
- /// This specifies the dimesion of width or heigh for size negotiation.
+ /// This specifies the dimension of the width or the height for size negotiation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DimensionType
{
/// <summary>
- /// Width dimension
+ /// Width dimension.
/// </summary>
Width = 0x1,
/// <summary>
- /// Height dimension
+ /// Height dimension.
/// </summary>
Height = 0x2,
/// <summary>
- /// Mask to cover all flags
+ /// Mask to cover all flags.
/// </summary>
AllDimensions = 0x3
}
/// <summary>
/// Enumeration for the instance of how the actor and it's children will be drawn.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DrawModeType
{
/// <summary>
- /// The default draw-mode
+ /// The default draw-mode.
/// </summary>
Normal = 0,
/// <summary>
- /// Draw the actor and its children as an overlay
+ /// Draw the actor and its children as an overlay.
/// </summary>
Overlay2D = 1,
/// <summary>
- /// Will be replaced by separate ClippingMode enum. Draw the actor and its children into the stencil buffer
+ /// Will be replaced by separate ClippingMode enum. Draw the actor and its children into the stencil buffer.
/// </summary>
Stencil = 3
}
/// <summary>
/// Enumeration for size negotiation resize policies.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ResizePolicyType
{
/// <summary>
- /// Size is fixed as set by SetSize
+ /// Size is fixed as set by SetSize.
/// </summary>
Fixed,
/// <summary>
- /// Size is to use the actor's natural size
+ /// Size is to use the actor's natural size.
/// </summary>
- /// <see cref="View.GetNaturalSize"/>
+ /// <see cref="ViewImpl.GetNaturalSize"/>
UseNaturalSize,
/// <summary>
/// Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained.
/// </summary>
SizeFixedOffsetFromParent,
/// <summary>
- /// Size will adjust to wrap around all children
+ /// The size will adjust to wrap around all children.
/// </summary>
FitToChildren,
/// <summary>
- /// One dimension is dependent on the other
+ /// One dimension is dependent on the other.
/// </summary>
DimensionDependency,
/// <summary>
- /// The size will be assigned to the actor
+ /// The size will be assigned to the actor.
/// </summary>
UseAssignedSize
}
/// <summary>
/// Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum SizeScalePolicyType
{
/// <summary>
- /// Use the size that was set
+ /// Use the size that was set.
/// </summary>
UseSizeSet,
/// <summary>
- /// Fit within the size set maintaining natural size aspect ratio
+ /// Fit within the size set maintaining natural size aspect ratio.
/// </summary>
FitWithAspectRatio,
/// <summary>
- /// Fit within the size set maintaining natural size aspect ratio
+ /// Fit within the size set maintaining natural size aspect ratio.
/// </summary>
FillWithAspectRatio
}
/// <summary>
- /// Enumeration for ClippingMode describing how this Actor's children will be clipped against it.
+ /// Enumeration for the ClippingMode describing how this actor's children will be clipped against it.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ClippingModeType
{
/// <summary>
- /// This Actor will not clip its children.
+ /// This actor will not clip its children.
/// </summary>
Disabled,
/// <summary>
- /// This Actor will clip all children to within its boundaries (the actor will also be visible itself).
+ /// This actor will clip all children to within its boundaries (the actor will also be visible itself).
/// </summary>
ClipChildren,
/// <summary>
/// This Actor will clip all children within a screen-aligned rectangle encompassing its boundaries (the actor will also be visible itself).
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
ClipToBoundingBox
}
/// <summary>
- /// Enumeration for type determination of how camera operates.
+ /// Enumeration for type determination of how the camera operates.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum CameraType
{
/// <summary>
- /// Camera orientation is taken from CameraActor.
+ /// Camera orientation is taken from the CameraActor.
/// </summary>
FreeLook,
/// <summary>
}
/// <summary>
- /// Enumeration for projection modes.
+ /// Enumeration for the projection modes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ProjectionMode
{
/// <summary>
}
/// <summary>
- /// This specifies ccustomView behaviour types.
+ /// This specifies customView behavior types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum CustomViewBehaviour
{
/// <summary>
- /// Use to provide default behaviour (size negotiation is on, event callbacks are not called)
+ /// Use to provide default behavior (size negotiation is on, event callbacks are not called).
/// </summary>
ViewBehaviourDefault = 0,
/// <summary>
- /// True if control does not need size negotiation, i.e. it can be skipped in the algorithm
+ /// True if the control does not need size negotiation, i.e., it can be skipped in the algorithm.
/// </summary>
DisableSizeNegotiation = 1 << 0,
/// <summary>
/// Use to make style change event disabled.
/// </summary>
DisableStyleChangeSignals = 1 << 6,
+ /// <summary>
+ /// Please do not use! This will be deprecated!
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
[EditorBrowsable(EditorBrowsableState.Never)]
LastViewBehaviourFlag
}
+ /// <summary>
+ /// An enum of Device Class types.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DeviceClassType
{
+ /// <summary>
+ /// Not a device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
+ /// <summary>
+ /// The user/seat (the user themselves).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Seat,
+ /// <summary>
+ /// A regular keyboard, numberpad or attached buttons.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Keyboard,
+ /// <summary>
+ /// A mouse, trackball or touchpad relative motion device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Mouse,
+ /// <summary>
+ /// A touchscreen with fingers or stylus.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Touch,
+ /// <summary>
+ /// A special pen device.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Pen,
+ /// <summary>
+ /// A pointing device based on laser, infrared or similar technology.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Pointer,
+ /// <summary>
+ /// A gamepad controller or joystick.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Gamepad
}
/// This specifies all the property types. <br>
/// Enumeration for the property types supported.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PropertyType
{
/// <summary>
- /// No type
+ /// No type.
/// </summary>
None,
/// <summary>
- /// A boolean type
+ /// A boolean type.
/// </summary>
Boolean,
/// <summary>
- /// A float type
+ /// A float type.
/// </summary>
Float,
/// <summary>
- /// An integer type
+ /// An integer type.
/// </summary>
Integer,
/// <summary>
- /// a vector array of size=2 with float precision
+ /// A vector array of size=2 with float precision.
/// </summary>
Vector2,
/// <summary>
- /// a vector array of size=3 with float precision
+ /// A vector array of size=3 with float precision.
/// </summary>
Vector3,
/// <summary>
- /// a vector array of size=4 with float precision
+ /// A vector array of size=4 with float precision.
/// </summary>
Vector4,
/// <summary>
- /// a 3x3 matrix
+ /// A 3x3 matrix.
/// </summary>
Matrix3,
/// <summary>
- /// a 4x4 matrix
+ /// A 4x4 matrix.
/// </summary>
Matrix,
/// <summary>
- /// an integer array of size=4
+ /// An integer array of size=4.
/// </summary>
Rectangle,
/// <summary>
- /// either a quaternion or an axis angle rotation
+ /// Either a quaternion or an axis angle rotation.
/// </summary>
Rotation,
/// <summary>
- /// A string type
+ /// A string type.
/// </summary>
String,
/// <summary>
- /// an array of PropertyValue
+ /// An array of PropertyValue.
/// </summary>
Array,
/// <summary>
- /// a string key to PropertyValue mapping
+ /// A string key to PropertyValue mapping.
/// </summary>
Map
}
/// <summary>
- /// This specifies the property access mode types. <br>
+ /// This specifies the property access mode types.<br />
/// Enumeration for the access mode for custom properties.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PropertyAccessMode
{
/// <summary>
- /// if the property is read-only
+ /// If the property is read-only.
/// </summary>
ReadOnly,
/// <summary>
- /// If the property is read/writeable
+ /// If the property is read or writeable.
/// </summary>
ReadWrite,
/// <summary>
- /// If the property can be animated or constrained
+ /// If the property can be animated or constrained.
/// </summary>
Animatable,
/// <summary>
- /// The number of access modes
+ /// The number of access modes.
/// </summary>
AccessModeCount
}
/// <summary>
- /// Types of style change. Enumeration for StyleChange type.
+ /// Types of style change. Enumeration for the StyleChange type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum StyleChangeType
{
/// <summary>
/// <summary>
/// Enumeration for horizontal alignment types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum HorizontalAlignmentType
{
/// <summary>
- /// Align horizontally left
+ /// Align horizontally left.
/// </summary>
Left,
/// <summary>
- /// Align horizontally center
+ /// Align horizontally center.
/// </summary>
Center,
/// <summary>
- /// Align horizontally right
+ /// Align horizontally right.
/// </summary>
Right
}
/// <summary>
/// Enumeration for vertical alignment types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum VerticalAlignmentType
{
/// <summary>
- /// Align vertically top
+ /// Align vertically top.
/// </summary>
Top,
/// <summary>
- /// Align vertically center
+ /// Align vertically center.
/// </summary>
Center,
/// <summary>
- /// Align vertically bottom
+ /// Align vertically bottom.
/// </summary>
Bottom
}
/// <summary>
/// Enumeration for point state type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PointStateType
{
/// <summary>
- /// Touch or hover started
+ /// Touch or hover started.
/// </summary>
Started,
/// <summary>
- /// Touch or hover finished
+ /// Touch or hover finished.
/// </summary>
Finished,
/// <summary>
- /// Screen touched
+ /// Screen touched.
/// </summary>
Down = Started,
/// <summary>
- /// Touch stopped
+ /// Touch stopped.
/// </summary>
Up = Finished,
/// <summary>
- /// Finger dragged or hovered
+ /// Finger dragged or hovered.
/// </summary>
Motion,
/// <summary>
- /// Leave the boundary of an actor
+ /// Leave the boundary of an actor.
/// </summary>
Leave,
/// <summary>
- /// No change from last event. <br>
- /// Useful when a multi-point event occurs where all points are sent but indicates that this particular point has not changed since the last time.
+ /// No change from last event. <br />
+ /// Useful when a multi-point event occurs where all points are sent, but indicates that this particular point has not changed since the last time.
/// </summary>
Stationary,
/// <summary>
/// <summary>
/// Enumeration for the text horizontal aligning.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum HorizontalAlignment
{
/// <summary>
/// <summary>
/// Enumeration for the text horizontal aligning.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum VerticalAlignment
{
/// <summary>
}
/// <summary>
- /// This specifies wrap mode types <br>
+ /// This specifies wrap mode types.<br />
/// WrapModeU and WrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WrapModeType
{
/// <summary>
- /// Defualt value
+ /// The default value.
/// </summary>
Default = 0,
/// <summary>
- /// Clamp to edge
+ /// Clamp to edge.
/// </summary>
ClampToEdge,
/// <summary>
- /// Repeat
+ /// Repeat.
/// </summary>
Repeat,
/// <summary>
- /// Mirrored repeat
+ /// Mirrored repeat.
/// </summary>
MirroredRepeat
}
/// <summary>
- /// Specifies the Release Policy types <br>
+ /// Specifies the Release Policy types <br />
/// Decides if the image should be cached in different conditions
/// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public enum ReleasePolicyType
{
/// <summary>
}
/// <summary>
- /// Specifies the Load Policy types <br>
+ /// Specifies the Load Policy types <br />
/// Decides when the image texture should be loaded
/// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public enum LoadPolicyType
{
/// <summary>
Attached
}
+
/// <summary>
/// The type of coordinate system for certain attributes of the points in a gradient.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum GradientVisualUnitsType
{
/// <summary>
- /// Uses the normals for the start, end & center points, i.e. top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5).
+ /// Uses the normals for the start, end, and center points, i.e., top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5).
/// </summary>
ObjectBoundingBox,
/// <summary>
- /// Uses the user coordinates for the start, end & center points, i.e. in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200).
+ /// Uses the user coordinates for the start, end, and center points, i.e., in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200).
/// </summary>
UserSpace
}
/// <summary>
- /// This specifies SpreadMethod types.<br>
- /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.<br>
+ /// This specifies SpreadMethod types.<br />
+ /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum GradientVisualSpreadMethodType
{
/// <summary>
/// </summary>
Pad,
/// <summary>
- /// Reflect the gradient pattern start-to-end, end-to-start, start-to-end etc. until the quad is filled.
+ /// Reflects the gradient pattern start-to-end, end-to-start, start-to-end, etc. until the quad is filled.
/// </summary>
Reflect,
/// <summary>
- /// Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled.
+ /// Repeats the gradient pattern start-to-end, start-to-end, start-to-end, etc. until the quad is filled.
/// </summary>
Repeat
}
/// <summary>
- /// The shading mode used by MeshVisual.
+ /// The shading mode used by the mesh visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum MeshVisualShadingModeValue
{
/// <summary>
/// </summary>
TexturedWithSpecularLighting,
/// <summary>
- /// Uses all textures provided including a gloss, normal and texture map along with specular, ambient and diffuse lighting.
+ /// Uses all textures provided including gloss, normal, and texture map along with specular, ambient, and diffuse lighting.
/// </summary>
TexturedWithDetailedSpecularLighting
}
/// <summary>
- /// The primitive shape to render as a PrimitiveVisual.
+ /// The primitive shape to render as a primitive visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PrimitiveVisualShapeType
{
/// <summary>
- /// A perfectly round geometrical object in three-dimensional space.
+ /// A perfectly round geometrical object in the three-dimensional space.
/// </summary>
Sphere,
/// <summary>
- /// The area bound between two circles, i.e. a cone with the tip removed.
+ /// The area bound between two circles, i.e., a cone with the tip removed.
/// </summary>
ConicalFrustrum,
/// <summary>
- /// Equivalent to a conical frustrum with top radius of zero.
- /// </summary>Equivalent to a conical frustrum with top radius of zero.
+ /// Equivalent to a conical frustrum with the top radius of zero.
+ /// </summary>Equivalent to a conical frustrum with the top radius of zero.
Cone,
/// <summary>
- /// Equivalent to a conical frustrum with top radius of zero.
+ /// Equivalent to a conical frustrum with the top radius of zero.
/// </summary>
Cylinder,
/// <summary>
}
/// <summary>
- /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.<br>
- /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.<br>
- /// All fitting modes preserve the aspect ratio of the image contents.<br>
+ /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.<br />
+ /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.<br />
+ /// All fitting modes preserve the aspect ratio of the image contents.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum FittingModeType
{
/// <summary>
- /// Full-screen image display: Limit loaded image resolution to device resolution using ShrinkToFit mode.
+ /// Full-screen image display: Limit loaded image resolution to device resolution using the ShrinkToFit mode.
/// </summary>
ShrinkToFit,
/// <summary>
- /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using ScaleToFill mode.
+ /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
/// </summary>
ScaleToFill,
/// <summary>
- /// Image columns: Limit loaded image resolution to column width using FitWidth mode.
+ /// Image columns: Limit loaded image resolution to column width using the FitWidth mode.
/// </summary>
FitWidth,
/// <summary>
- /// Image rows: Limit loaded image resolution to row height using FitHeight mode.
+ /// Image rows: Limit loaded image resolution to row height using the FitHeight mode.
/// </summary>
FitHeight
}
/// <summary>
- /// This specifies sampling mode types. Filtering options, used when resizing images to sample original pixels.<br>
- /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during a scaling.<br>
- /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and FittingMode,<br>
- /// but all other filter modes do if the desired dimensions are `<=` the raw dimensions of the input image file.<br>
+ /// This specifies sampling mode types. Filtering options are used when resizing images to sample original pixels.<br />
+ /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during scaling.<br />
+ /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and the FittingMode,<br />
+ /// but all other filter modes do if the desired dimensions are not more than the raw dimensions of the input image file.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum SamplingModeType
{
/// <summary>
- /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc width and height and approximately the desired size. <br>
+ /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size. <br />
/// This is the default.
/// </summary>
Box,
/// </summary>
Linear,
/// <summary>
- /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8 etc width and height and approximately the desired size, <br>
- /// then for each output pixel, read one pixel from the last level of box filtering.<br>
+ /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size, <br />
+ /// then for each output pixel, read one pixel from the last level of box filtering.<br />
/// </summary>
BoxThenNearest,
/// <summary>
/// <summary>
/// This specifies policy types that could be used by the transform for the offset or size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum VisualTransformPolicyType
{
/// <summary>
/// <summary>
/// This specifies all the transform property types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum VisualTransformPropertyType
{
/// <summary>
/// </summary>
Origin,
/// <summary>
- /// The anchor-point of the visual
+ /// The anchor-point of the visual.
/// </summary>
AnchorPoint,
/// <summary>
- /// Whether the x or y OFFSET values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// Whether the x or y offset values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
/// </summary>
OffsetPolicy,
/// <summary>
- /// Whether the width or height SIZE values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// Whether the width or the height size values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
/// </summary>
SizePolicy
}
/// <summary>
/// This specifies visual types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct Visual
{
/// <summary>
/// The index for the visual type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
/// <summary>
/// </summary>
Mesh,
/// <summary>
- /// Renders a simple 3D shape, such as a cube or sphere.
+ /// Renders a simple 3D shape, such as a cube or a sphere.
/// </summary>
Primitive,
/// <summary>
/// </summary>
SVG,
/// <summary>
- /// Renders a animated image. (Animated GIF)
+ /// Renders a animated image (animated GIF).
/// </summary>
AnimatedImage
}
/// <summary>
/// This specifies visual properties.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct Property
{
+ /// <summary>
+ /// Type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Type = NDalic.VISUAL_PROPERTY_TYPE;
+ /// <summary>
+ /// Shader.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Shader = NDalic.VISUAL_PROPERTY_SHADER;
+ /// <summary>
+ /// Transform.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Transform = NDalic.VISUAL_PROPERTY_TRANSFORM;
+ /// <summary>
+ /// PremultipliedAlpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PremultipliedAlpha = NDalic.VISUAL_PROPERTY_PREMULTIPLIED_ALPHA;
+ /// <summary>
+ /// MixColor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MixColor = NDalic.VISUAL_PROPERTY_MIX_COLOR;
+ /// <summary>
+ /// Opacity.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Opacity = NDalic.VISUAL_PROPERTY_MIX_COLOR + 1;
}
/// <summary>
/// This specifies shader properties.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct ShaderProperty
{
+ /// <summary>
+ /// Vertex shader code
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int VertexShader = NDalic.VISUAL_SHADER_VERTEX;
+ /// <summary>
+ /// Fragment shader code
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FragmentShader = NDalic.VISUAL_SHADER_FRAGMENT;
+ /// <summary>
+ /// How to subdivide the grid along X
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ShaderSubdivideGridX = NDalic.VISUAL_SHADER_SUBDIVIDE_GRID_X;
+ /// <summary>
+ /// How to subdivide the grid along Y
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ShaderSubdivideGridY = NDalic.VISUAL_SHADER_SUBDIVIDE_GRID_Y;
+ /// <summary>
+ /// Bitmask of hints
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ShaderHints = NDalic.VISUAL_SHADER_HINTS;
}
/// <summary>
- /// This specifies Visaul align types.
+ /// This specifies visaul align types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum AlignType
{
+ /// <summary>
+ /// TopBegin
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TopBegin = 0,
+ /// <summary>
+ /// TopCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TopCenter,
+ /// <summary>
+ /// TopEnd
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TopEnd,
+ /// <summary>
+ /// CenterBegin
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
CenterBegin,
+ /// <summary>
+ /// Center
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Center,
+ /// <summary>
+ /// CenterEnd
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
CenterEnd,
+ /// <summary>
+ /// BottomBegin
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BottomBegin,
+ /// <summary>
+ /// BottomCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BottomCenter,
+ /// <summary>
+ /// BottomEnd
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BottomEnd
}
}
/// <summary>
- /// This specifies properties of BorderVisual.
+ /// This specifies properties of the BorderVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct BorderVisualProperty
{
+ /// <summary>
+ /// The color of the border.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Color = NDalic.BORDER_VISUAL_COLOR;
+ /// <summary>
+ /// The width of the border (in pixels).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Size = NDalic.BORDER_VISUAL_SIZE;
+ /// <summary>
+ /// Whether anti-aliasing of the border is required.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int AntiAliasing = NDalic.BORDER_VISUAL_ANTI_ALIASING;
}
/// <summary>
- /// This specifies properties of ColorVisual.
+ /// This specifies properties of the ColorVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct ColorVisualProperty
{
+ /// <summary>
+ /// The solid color required.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MixColor = NDalic.COLOR_VISUAL_MIX_COLOR;
}
/// <summary>
- /// This specifies properties of GradientVisual.
+ /// This specifies properties of the GradientVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct GradientVisualProperty
{
+ /// <summary>
+ /// The start position of a linear gradient.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int StartPosition = NDalic.GRADIENT_VISUAL_START_POSITION;
+ /// <summary>
+ /// The end position of a linear gradient.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int EndPosition = NDalic.GRADIENT_VISUAL_END_POSITION;
+ /// <summary>
+ /// The center point of a radial gradient.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Center = NDalic.GRADIENT_VISUAL_CENTER;
+ /// <summary>
+ /// The size of the radius of a radial gradient.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Radius = NDalic.GRADIENT_VISUAL_RADIUS;
+ /// <summary>
+ /// All the stop offsets.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int StopOffset = NDalic.GRADIENT_VISUAL_STOP_OFFSET;
+ /// <summary>
+ /// The color at the stop offsets.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int StopColor = NDalic.GRADIENT_VISUAL_STOP_COLOR;
+ /// <summary>
+ /// Defines the coordinate system for certain attributes of the points in a gradient.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Units = NDalic.GRADIENT_VISUAL_UNITS;
+ /// <summary>
+ /// Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SpreadMethod = NDalic.GRADIENT_VISUAL_SPREAD_METHOD;
}
/// <summary>
- /// This specifies properties of ImageVisual.
+ /// This specifies properties of the ImageVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct ImageVisualProperty
{
+ /// <summary>
+ /// The URL of the image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int URL = NDalic.IMAGE_VISUAL_URL;
+ /// <summary>
+ /// The URL of the alpha mask image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int AlphaMaskURL = NDalic.IMAGE_VISUAL_ALPHA_MASK_URL;
+ /// <summary>
+ /// Fitting options, used when resizing images to fit desired dimensions.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FittingMode = NDalic.IMAGE_VISUAL_FITTING_MODE;
+ /// <summary>
+ /// Filtering options, used when resizing images to sample original pixels.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SamplingMode = NDalic.IMAGE_VISUAL_SAMPLING_MODE;
+ /// <summary>
+ /// The desired image width.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DesiredWidth = NDalic.IMAGE_VISUAL_DESIRED_WIDTH;
+ /// <summary>
+ /// The desired image height.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DesiredHeight = NDalic.IMAGE_VISUAL_DESIRED_HEIGHT;
+ /// <summary>
+ /// Whether to load the image synchronously.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SynchronousLoading = NDalic.IMAGE_VISUAL_SYNCHRONOUS_LOADING;
+ /// <summary>
+ /// If true, only draws the borders.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BorderOnly = NDalic.IMAGE_VISUAL_BORDER_ONLY;
+ /// <summary>
+ /// The image area to be displayed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PixelArea = NDalic.IMAGE_VISUAL_PIXEL_AREA;
+ /// <summary>
+ /// The wrap mode for u coordinate.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WrapModeU = NDalic.IMAGE_VISUAL_WRAP_MODE_U;
+ /// <summary>
+ /// The wrap mode for v coordinate.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WrapModeV = NDalic.IMAGE_VISUAL_WRAP_MODE_V;
+ /// <summary>
+ /// The border of the image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Border = NDalic.IMAGE_VISUAL_BORDER;
+ /// <summary>
+ /// The scale factor to apply to the content image before masking.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int MaskContentScale = NDalic.IMAGE_VISUAL_MASK_CONTENT_SCALE;
+ /// <summary>
+ /// Whether to crop image to mask or scale mask to fit image
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int CropToMask = NDalic.IMAGE_VISUAL_CROP_TO_MASK;
+ /// <summary>
+ /// Defines the batch size for pre-loading images in the AnimatedImageVisual
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int BatchSize = NDalic.IMAGE_VISUAL_BATCH_SIZE;
+ /// <summary>
+ /// Defines the cache size for loading images in the AnimatedImageVisual
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int CacheSize = NDalic.IMAGE_VISUAL_CACHE_SIZE;
+ /// <summary>
+ /// The number of milliseconds between each frame in the AnimatedImageVisual
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int FrameDelay = NDalic.IMAGE_VISUAL_FRAME_DELAY;
+ /// <summary>
+ /// The policy to determine when an image should no longer be cached
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static readonly int ReleasePolicy = NDalic.IMAGE_VISUAL_RELEASE_POLICY;
+ /// <summary>
+ /// The policy to determine when an image should be loaded
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static readonly int LoadPolicy = NDalic.IMAGE_VISUAL_LOAD_POLICY;
+ /// <summary>
+ /// Determines if image orientation should be corrected so the image displays as it was intended
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static readonly int OrientationCorrection = NDalic.IMAGE_VISUAL_ORIENTATION_CORRECTION;
}
/// <summary>
- /// This specifies properties of MeshVisual.
+ /// This specifies properties of the MeshVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct MeshVisualProperty
{
+ /// <summary>
+ /// The location of the ".obj" file.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ObjectURL = NDalic.MESH_VISUAL_OBJECT_URL;
+ /// <summary>
+ /// The location of the ".mtl" file.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MaterialtURL = NDalic.MESH_VISUAL_MATERIAL_URL;
+ /// <summary>
+ /// Path to the directory the textures (including gloss and normal) are stored in.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TexturesPath = NDalic.MESH_VISUAL_TEXTURES_PATH;
+ /// <summary>
+ /// Sets the type of shading mode that the mesh will use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ShadingMode = NDalic.MESH_VISUAL_SHADING_MODE;
+ /// <summary>
+ /// Whether to use mipmaps for textures or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int UseMipmapping = NDalic.MESH_VISUAL_USE_MIPMAPPING;
+ /// <summary>
+ /// Whether to average normals at each point to smooth textures or not.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int UseSoftNormals = NDalic.MESH_VISUAL_USE_SOFT_NORMALS;
+ /// <summary>
+ /// The position, in stage space, of the point light that applies lighting to the model.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LightPosition = NDalic.MESH_VISUAL_LIGHT_POSITION;
}
/// <summary>
- /// This specifies properties of PrimitiveVisual.
+ /// This specifies properties of the PrimitiveVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct PrimitiveVisualProperty
{
+ /// <summary>
+ /// The specific shape to render.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Shape = NDalic.PRIMITIVE_VISUAL_SHAPE;
+ /// <summary>
+ /// The color of the shape.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MixColor = NDalic.PRIMITIVE_VISUAL_MIX_COLOR;
+ /// <summary>
+ /// The number of slices as you go around the shape.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Slices = NDalic.PRIMITIVE_VISUAL_SLICES;
+ /// <summary>
+ /// The number of stacks as you go down the shape.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Stacks = NDalic.PRIMITIVE_VISUAL_STACKS;
+ /// <summary>
+ /// The scale of the radius of the top circle of a conical frustrum.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ScaleTopRadius = NDalic.PRIMITIVE_VISUAL_SCALE_TOP_RADIUS;
+ /// <summary>
+ /// The scale of the radius of the bottom circle of a conical frustrum.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ScaleBottomRadius = NDalic.PRIMITIVE_VISUAL_SCALE_BOTTOM_RADIUS;
+ /// <summary>
+ /// The scale of the height of a conic.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ScaleHeight = NDalic.PRIMITIVE_VISUAL_SCALE_HEIGHT;
+ /// <summary>
+ /// The scale of the radius of a cylinder.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ScaleRadius = NDalic.PRIMITIVE_VISUAL_SCALE_RADIUS;
+ /// <summary>
+ /// The dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int ScaleDimensions = NDalic.PRIMITIVE_VISUAL_SCALE_DIMENSIONS;
+ /// <summary>
+ /// Determines how bevelled the cuboid should be, based off the smallest dimension.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BevelPercentage = NDalic.PRIMITIVE_VISUAL_BEVEL_PERCENTAGE;
+ /// <summary>
+ /// Defines how smooth the bevelled edges should be.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BevelSmoothness = NDalic.PRIMITIVE_VISUAL_BEVEL_SMOOTHNESS;
+ /// <summary>
+ /// The position, in stage space, of the point light that applies lighting to the model.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int LightPosition = NDalic.PRIMITIVE_VISUAL_LIGHT_POSITION;
}
/// <summary>
- /// This specifies properties of TextVisual.
+ /// This specifies properties of the TextVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct TextVisualProperty
{
+ /// <summary>
+ /// The text to display in UTF-8 format.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Text = NDalic.TEXT_VISUAL_TEXT;
+ /// <summary>
+ /// The requested font family to use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FontFamily = NDalic.TEXT_VISUAL_FONT_FAMILY;
+ /// <summary>
+ /// The requested font style to use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FontStyle = NDalic.TEXT_VISUAL_FONT_STYLE;
+ /// <summary>
+ /// The size of font in points.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PointSize = NDalic.TEXT_VISUAL_POINT_SIZE;
+ /// <summary>
+ /// The single-line or multi-line layout option.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int MultiLine = NDalic.TEXT_VISUAL_MULTI_LINE;
+ /// <summary>
+ /// The line horizontal alignment.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int HorizontalAlignment = NDalic.TEXT_VISUAL_HORIZONTAL_ALIGNMENT;
+ /// <summary>
+ /// The line vertical alignment.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int VerticalAlignment = NDalic.TEXT_VISUAL_VERTICAL_ALIGNMENT;
+ /// <summary>
+ /// The color of the text.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TextColor = NDalic.TEXT_VISUAL_TEXT_COLOR;
+ /// <summary>
+ /// Whether the mark-up processing is enabled.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int EnableMarkup = NDalic.TEXT_VISUAL_ENABLE_MARKUP;
}
/// <summary>
- /// This specifies properties of NpatchImageVisual.
+ /// This specifies properties of the NpatchImageVisual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct NpatchImageVisualProperty
{
+ /// <summary>
+ /// The URL of the image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int URL = NDalic.IMAGE_VISUAL_URL;
+ /// <summary>
+ /// Fitting options, used when resizing images to fit desired dimensions.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FittingMode = NDalic.IMAGE_VISUAL_FITTING_MODE;
+ /// <summary>
+ /// Filtering options, used when resizing images to sample original pixels.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SamplingMode = NDalic.IMAGE_VISUAL_SAMPLING_MODE;
+ /// <summary>
+ /// The desired image width.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DesiredWidth = NDalic.IMAGE_VISUAL_DESIRED_WIDTH;
+ /// <summary>
+ /// The desired image height.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DesiredHeight = NDalic.IMAGE_VISUAL_DESIRED_HEIGHT;
+ /// <summary>
+ /// Whether to load the image synchronously.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SynchronousLoading = NDalic.IMAGE_VISUAL_SYNCHRONOUS_LOADING;
+ /// <summary>
+ /// If true, only draws the borders.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BorderOnly = NDalic.IMAGE_VISUAL_BORDER_ONLY;
+ /// <summary>
+ /// The image area to be displayed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PixelArea = NDalic.IMAGE_VISUAL_PIXEL_AREA;
+ /// <summary>
+ /// The wrap mode for u coordinate.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WrapModeU = NDalic.IMAGE_VISUAL_WRAP_MODE_U;
+ /// <summary>
+ /// The wrap mode for v coordinate.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WrapModeV = NDalic.IMAGE_VISUAL_WRAP_MODE_V;
+ /// <summary>
+ /// The border of the image.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Border = NDalic.IMAGE_VISUAL_WRAP_MODE_V + 1;
}
/// <summary>
- /// HiddenInput Property.
+ /// The HiddenInput property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct HiddenInputProperty
{
+ /// <summary>
+ /// The mode for input text display.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int Mode = NDalicManualPINVOKE.HIDDENINPUT_PROPERTY_MODE_get();
+ /// <summary>
+ /// All input characters are substituted by this character.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SubstituteCharacter = NDalicManualPINVOKE.HIDDENINPUT_PROPERTY_SUBSTITUTE_CHARACTER_get();
+ /// <summary>
+ /// Length of text to show or hide, available when HIDE_COUNT/SHOW_COUNT mode is used.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SubstituteCount = NDalicManualPINVOKE.HIDDENINPUT_PROPERTY_SUBSTITUTE_COUNT_get();
+ /// <summary>
+ /// Hide last character after this duration, available when SHOW_LAST_CHARACTER mode.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static readonly int ShowLastCharacterDuration = NDalicManualPINVOKE.HIDDENINPUT_PROPERTY_SHOW_LAST_CHARACTER_DURATION_get();
}
/// <summary>
/// The type for HiddenInput mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum HiddenInputModeType
{
/// <summary>
/// <summary>
/// ParentOrigin constants.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct ParentOrigin
{
+ /// <summary>
+ /// Top
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Top
{
get
return ret;
}
}
+
+ /// <summary>
+ /// Bottom
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Bottom
{
get
return ret;
}
}
+
+ /// <summary>
+ /// Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Left
{
get
return ret;
}
}
+
+ /// <summary>
+ /// Right
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Right
{
get
return ret;
}
}
+
+ /// <summary>
+ /// Middle
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Middle
{
get
return ret;
}
}
+
+ /// <summary>
+ /// TopLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopLeft
{
get
return ret;
}
}
+
+ /// <summary>
+ /// TopCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopCenter
{
get
return ret;
}
}
+
+ /// <summary>
+ /// TopRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopRight
{
get
return ret;
}
}
+
+ /// <summary>
+ /// CenterLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterLeft
{
get
return ret;
}
}
+
+ /// <summary>
+ /// Center
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Center
{
get
return ret;
}
}
+
+ /// <summary>
+ /// CenterRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterRight
{
get
return ret;
}
}
+
+ /// <summary>
+ /// BottomLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomLeft
{
get
return ret;
}
}
+
+ /// <summary>
+ /// BottomCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomCenter
{
get
return ret;
}
}
+
+ /// <summary>
+ /// BottomRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomRight
{
get
/// <summary>
/// PivotPoint constants.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct PivotPoint
{
+ /// <summary>
+ /// Top
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Top
{
get
return ret;
}
}
+ /// <summary>
+ /// Bottom
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Bottom
{
get
return ret;
}
}
+ /// <summary>
+ /// Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Left
{
get
return ret;
}
}
+ /// <summary>
+ /// Right
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Right
{
get
return ret;
}
}
+ /// <summary>
+ /// Middle
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Middle
{
get
return ret;
}
}
+ /// <summary>
+ /// TopLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// TopCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopCenter
{
get
return ret;
}
}
+ /// <summary>
+ /// TopRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopRight
{
get
return ret;
}
}
+ /// <summary>
+ /// CenterLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// Center
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Center
{
get
return ret;
}
}
+ /// <summary>
+ /// CenterRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterRight
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomCenter
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomRight
{
get
/// <summary>
/// PositionAxis constants.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct PositionAxis
{
+ /// <summary>
+ /// The X axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position X
{
get
return ret;
}
}
+ /// <summary>
+ /// The Y axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Y
{
get
return ret;
}
}
+ /// <summary>
+ /// The Z axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Z
{
get
return ret;
}
}
+ /// <summary>
+ /// The Negative X axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position NegativeX
{
get
return ret;
}
}
+ /// <summary>
+ /// The Negative Y axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position NegativeY
{
get
return ret;
}
}
+ /// <summary>
+ /// The Negative Z axis
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position NegativeZ
{
get
}
/// <summary>
- /// Auto scrolling stop behaviour.
+ /// Auto scrolling stop behavior.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum AutoScrollStopMode
{
/// <summary>
/// </summary>
FinishLoop,
/// <summary>
- /// Stop animation immediatly and reset position.
+ /// Stop animation immediately and reset position.
/// </summary>
Immediate
}
/// <summary>
/// An enum of screen mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ScreenOffMode {
/// <summary>
/// The mode which turns the screen off after a timeout.
/// <summary>
/// An enum of notification window's priority level.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum NotificationLevel {
/// <summary>
- /// No notification level.<br>
- /// Default level.<br>
+ /// No notification level.<br />
+ /// Default level.<br />
/// This value makes the notification window place in the layer of the normal window.
/// </summary>
None = -1,
/// <summary>
- /// Base nofitication level.
+ /// The base nofitication level.
/// </summary>
Base = 10,
/// <summary>
- /// Medium notification level than base.
+ /// The medium notification level than base.
/// </summary>
Medium = 20,
/// <summary>
- /// Higher notification level than medium.
+ /// The higher notification level than medium.
/// </summary>
High = 30,
/// <summary>
}
/// <summary>
- /// An enum of Window types.
+ /// An enum of window types.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WindowType {
/// <summary>
- /// A default window type.<br>
- /// Indicates a normal, top-level window.
+ /// A default window type.<br />
+ /// Indicates a normal or top-level window.
/// Almost every window will be created with this type.
/// </summary>
Normal,
/// <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 email received.
/// </summary>
Notification,
/// <summary>
- /// A persistent utility window, like a toolbox or palette.
+ /// A persistent utility window, like a toolbox or a palette.
/// </summary>
Utility,
/// <summary>
Dialog
}
+ /// <since_tizen> 3 </since_tizen>
public enum DisposeTypes
{
- Explicit, //Called By User
- Implicit, //Called by DisposeQueue
+ /// <summary>
+ /// Called By User
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ Explicit,
+ /// <summary>
+ /// Called by DisposeQueue
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ Implicit,
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public struct AnchorPoint
{
+ /// <summary>
+ /// Top
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Top
{
get
return ret;
}
}
+ /// <summary>
+ /// Bottom
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Bottom
{
get
return ret;
}
}
+ /// <summary>
+ /// Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Left
{
get
return ret;
}
}
+ /// <summary>
+ /// Right
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Right
{
get
return ret;
}
}
+ /// <summary>
+ /// Middle
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float Middle
{
get
return ret;
}
}
+ /// <summary>
+ /// TopLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// TopCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopCenter
{
get
return ret;
}
}
+ /// <summary>
+ /// TopRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position TopRight
{
get
return ret;
}
}
+ /// <summary>
+ /// CenterLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// Center
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Center
{
get
return ret;
}
}
+ /// <summary>
+ /// CenterRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position CenterRight
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomLeft
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomLeft
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomCenter
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomCenter
{
get
return ret;
}
}
+ /// <summary>
+ /// BottomRight
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position BottomRight
{
get
}
/// <summary>
- /// An enum of scroll state of text eidtor.
+ /// An enum of the scroll state of the text eidtor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ScrollState
{
/// <summary>
}
/// <summary>
- /// An enum of line wrap mode of text controls.
+ /// An enum of the line wrap mode of text controls.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum LineWrapMode
{
/// <summary>
- /// Word mode will move word to next line
+ /// The word mode will move a word to the next line.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Word,
/// <summary>
- /// character will move character by character to next line
+ /// character will move character by character to the next line.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Character
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
using System;
+ using System.ComponentModel;
+ /// <summary>
+ /// The gesture state.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PaddingType : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal PaddingType(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PaddingType()
{
if (!isDisposeQueued)
/// <summary>
/// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <param name="a">First operand</param>
/// <param name="b">Second operand</param>
/// <returns>True if the values are identical</returns>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator ==(PaddingType a, PaddingType b)
{
// If both are null, or both are same instance, return true.
/// <param name="a">First operand</param>
/// <param name="b">Second operand</param>
/// <returns>True if the values are not identical</returns>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator !=(PaddingType a, PaddingType b)
{
return !(a == b);
}
}
- ///< The Start value
+ /// <summary>
+ /// The Start value.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public float Start
{
set
}
}
- ///< The Right value
- [Obsolete("Please do not use! this will be removed. please use End instead")]
+ /// <summary>
+ /// The Right value.
+ /// </summary>
+ /// Please DO NOT use! This will be deprecated!
+ /// instead please use Start property.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use PaddingType.End instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public float Right
{
set
}
}
- ///< The end value
+ /// <summary>
+ /// The End value.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public float End
{
set
}
}
- ///< The Top value
+ /// <summary>
+ /// The Top value.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Top
{
set
}
}
- ///< The Bottom value
+ /// <summary>
+ /// The Bottom value.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Bottom
{
set
/// <summary>
/// Creates an uninitialized PaddingType.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PaddingType() : this(NDalicPINVOKE.new_PaddingType__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <param name="end">End padding or Y coordinate</param>
/// <param name="top">Top padding or Height</param>
/// <param name="bottom">Bottom padding or Width</param>
- public PaddingType(float start, float end, float top, float bottom) : this(NDalicPINVOKE.new_PaddingType__SWIG_1(start, end, bottom, top), true)
+ /// <since_tizen> 3 </since_tizen>
+ public PaddingType(float start, float end, float top, float bottom) : this(NDalicPINVOKE.new_PaddingType__SWIG_1(start, end, top, bottom), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <param name="newEnd">End padding or Y coordinate</param>
/// <param name="newTop">Top padding or Height</param>
/// <param name="newBottom">Bottom padding or Width</param>
+ /// <since_tizen> 3 </since_tizen>
public void Set(float newStart, float newEnd, float newTop, float newBottom)
{
NDalicPINVOKE.PaddingType_Set(swigCPtr, newStart, newEnd, newBottom, newTop);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A PanGesture is emitted when the user moves one or more fingers in a particular direction.<br>
- /// A pan gesture will end in the following ways:<br>
- /// - User releases the primary finger (the first touch).<br>
- /// - User has more fingers on the screen than the maximum specified.<br>
- /// - User has less fingers on the screen than the minimum specified.<br>
- /// - Cancelled by the system.<br>
- /// A pan gesture will continue to be sent to the actor under than initial pan until it ends.<br>
+ /// A PanGesture is emitted when the user moves one or more fingers in a particular direction.<br />
+ /// A pan gesture will end in the following ways:<br />
+ /// - User releases the primary finger (the first touch).<br />
+ /// - User has more fingers on the screen than the maximum specified.<br />
+ /// - User has less fingers on the screen than the minimum specified.<br />
+ /// - Cancelled by the system.<br />
+ /// A pan gesture will continue to be sent to the actor under than initial pan until it ends.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PanGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// The velocity at which the user is moving their fingers.<br>
- /// This is represented as a Vector2 and is the pixel movement per millisecond.<br>
- /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
- /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br>
+ /// The velocity at which the user is moving their fingers.<br />
+ /// This is represented as a Vector2 and is the pixel movement per millisecond.<br />
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+ /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Velocity
{
get
/// <summary>
/// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
- /// if the gesture has just started, then the amount panned since the user touched the screen.<br>
- /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
- /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br>
+ /// if the gesture has just started, then the amount panned since the user touched the screen.<br />
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+ /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Displacement
{
get
}
/// <summary>
- /// This current touch position of the primary touch point in local actor coordinates.
+ /// The current touch position of the primary touch point in local actor coordinates.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Position
{
get
}
/// <summary>
- /// The velocity at which the user is moving their fingers.<br>
- /// This is represented as a Vector2 and is the pixel movement per millisecond.<br>
- /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
- /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br>
- /// This value represents the screen coordinates.<br>
+ /// The velocity at which the user is moving their fingers.<br />
+ /// This is represented as a Vector2 and is the pixel movement per millisecond.<br />
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+ /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br />
+ /// This value represents the screen coordinates.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenVelocity
{
get
/// <summary>
/// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
- /// if the gesture has just started, then the amount panned since the user touched the screen.<br>
- /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
- /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br>
- /// This value is in screen coordinates.<br>
+ /// if the gesture has just started, then the amount panned since the user touched the screen.<br />
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+ /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br />
+ /// This value is in screen coordinates.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenDisplacement
{
get
}
/// <summary>
- /// This current touch position of the primary touch point in screen coordinates.
+ /// The current touch position of the primary touch point in screen coordinates.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenPosition
{
get
/// <summary>
/// The total number of fingers touching the screen in a pan gesture.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint NumberOfTouches
{
get
}
/// <summary>
- /// Default Constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PanGesture() : this(NDalicPINVOKE.new_PanGesture__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
/// <param name="state">The state of the gesture</param>
internal PanGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_PanGesture__SWIG_1((int)state), true)
}
/// <summary>
- /// Returns the speed at which the user is moving their fingers.<br>
- /// This is the pixel movement per millisecond.<br>
+ /// Returns the speed at which the user is moving their fingers.<br />
+ /// This is the pixel movement per millisecond.<br />
/// </summary>
- /// <returns>The speed of the pan (in pixels per millisecond)</returns>
+ /// <returns>The speed of the pan (in pixels per millisecond).</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetSpeed()
{
float ret = NDalicPINVOKE.PanGesture_GetSpeed(swigCPtr);
}
/// <summary>
- /// This returns the distance the user has panned (dragged) since the last pan gesture or,
- /// if the gesture has just started, then the distance moved since the user touched the screen.<br>
- /// This is always a positive value.<br>
+ /// Returns the distance the user has panned (dragged) since the last pan gesture or,
+ /// if the gesture has just started, then the distance moved since the user touched the screen.<br />
+ /// This is always a positive value.<br />
/// </summary>
- /// <returns>The distance, as a float, a user's finger has panned</returns>
+ /// <returns>The distance, as a float, a user's finger has panned.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetDistance()
{
float ret = NDalicPINVOKE.PanGesture_GetDistance(swigCPtr);
}
/// <summary>
- /// Returns the speed at which the user is moving their fingers relative to screen coordinates.<br>
- /// This is the pixel movement per millisecond.<br>
+ /// Returns the speed at which the user is moving their fingers relative to screen coordinates.<br />
+ /// This is the pixel movement per millisecond.<br />
/// </summary>
- /// <returns>The speed of the pan (in pixels per millisecond)</returns>
+ /// <returns>The speed of the pan (in pixels per millisecond).</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetScreenSpeed()
{
float ret = NDalicPINVOKE.PanGesture_GetScreenSpeed(swigCPtr);
}
/// <summary>
- /// This returns the distance the user has panned (dragged) since the last pan gesture in screen
+ /// Returns the distance the user has panned (dragged) since the last pan gesture in screen
/// coordinates or, if the gesture has just started, then the distance in screen coordinates moved
- /// since the user touched the screen.<br>
- /// This is always a positive value.<br>
+ /// since the user touched the screen.<br />
+ /// This is always a positive value.<br />
/// </summary>
- /// <returns>The distance, as a float, a user's finger has panned</returns>
+ /// <returns>The distance, as a float, a user's finger has panned.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetScreenDistance()
{
float ret = NDalicPINVOKE.PanGesture_GetScreenDistance(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
/// <summary>
- /// A 3D parametric curve.<br>
- /// Paths can be used to animate position and orientation of actors.<br>
+ /// A 3D parametric curve.<br />
+ /// Paths can be used to animate the position and orientation of actors.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Path : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">The dispoase type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// Creates an initialized Path handle.
+ /// Creates an initialized path handle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Path() : this(NDalicPINVOKE.Path_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
- [Obsolete("Please do not use! this will be deprecated")]
- public new static Path DownCast(BaseHandle handle)
+ /// <summary>
+ /// Downcasts a handle to Path handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Path DownCast(BaseHandle handle)
{
Path ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Path;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Adds an interpolation point.
/// </summary>
- /// <param name="point">The new interpolation point to be added</param>
+ /// <param name="point">The new interpolation point to be added.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddPoint(Position point)
{
NDalicPINVOKE.Path_AddPoint(swigCPtr, Position.getCPtr(point));
/// <summary>
/// Adds a control point.
/// </summary>
- /// <param name="point">The new control point to be added</param>
+ /// <param name="point">The new control point to be added.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddControlPoint(Vector3 point)
{
NDalicPINVOKE.Path_AddControlPoint(swigCPtr, Vector3.getCPtr(point));
}
/// <summary>
- /// Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.<br>
- /// The generating algorithm is as follows:<br>
- /// For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].<br>
- /// Calculate the tangent vector by taking the normal of this bisector.<br>
- /// The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.<br>
- /// The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.<br>
+ /// Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.<br />
+ /// The generating algorithm is as follows:<br />
+ /// For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].<br />
+ /// Calculate the tangent vector by taking the normal of this bisector.<br />
+ /// The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.<br />
+ /// The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.<br />
/// </summary>
- /// <param name="curvature">The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to 0.5 result in a smooth curve, positive values between 0.5 and 1 result in looped curves where the loops are not distinct (i.e. the curve appears to be non-continuous), positive values higher than 1 result in looped curves</param>
+ /// <param name="curvature">The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to 0.5 result in a smooth curve, positive values between 0.5 and 1 result in looped curves where the loops are not distinct (i.e., the curve appears to be non-continuous), positive values higher than 1 result in looped curves.</param>
+ /// <since_tizen> 3 </since_tizen>
public void GenerateControlPoints(float curvature)
{
NDalicPINVOKE.Path_GenerateControlPoints(swigCPtr, curvature);
}
/// <summary>
- /// Sample path at a given progress. Calculates position and tangent at that point of the curve.
+ /// Sample path at a given progress. Calculates the position and tangent at that point of the curve.
/// </summary>
- /// <param name="progress">A floating point value between 0.0 and 1.0</param>
- /// <param name="position">The interpolated position at that progress</param>
- /// <param name="tangent">The interpolated tangent at that progress</param>
+ /// <param name="progress">A floating point value between 0.0 and 1.0.</param>
+ /// <param name="position">The interpolated position at that progress.</param>
+ /// <param name="tangent">The interpolated tangent at that progress.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Sample(float progress, Vector3 position, Vector3 tangent)
{
NDalicPINVOKE.Path_Sample(swigCPtr, progress, Vector3.getCPtr(position), Vector3.getCPtr(tangent));
}
/// <summary>
- /// Accessor for the interpolation points.
+ /// An accessor for the interpolation points.
/// </summary>
- /// <param name="index">The index of the interpolation point</param>
+ /// <param name="index">The index of the interpolation point.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 GetPoint(uint index)
{
Vector3 ret = new Vector3(NDalicPINVOKE.Path_GetPoint(swigCPtr, index), false);
}
/// <summary>
- /// Accessor for the control points.
+ /// An accessor for the control points.
/// </summary>
- /// <param name="index">The index of the control point</param>
+ /// <param name="index">The index of the control point.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 GetControlPoint(uint index)
{
Vector3 ret = new Vector3(NDalicPINVOKE.Path_GetControlPoint(swigCPtr, index), false);
/// <summary>
/// Gets the number of interpolation points in the path.
/// </summary>
- /// <returns>The number of interpolation points in the path</returns>
+ /// <returns>The number of interpolation points in the path.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetPointCount()
{
uint ret = NDalicPINVOKE.Path_GetPointCount(swigCPtr);
}
/// <summary>
- /// Enumeration for Points
+ /// Enumeration for the Points.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray Points
{
get
}
/// <summary>
- /// Enumeration for ControlPoints
+ /// Enumeration for the ControlPoints.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray ControlPoints
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A PinchGesture is emitted when the user moves two fingers towards or away from each other.<br>
- /// A pinch gesture will continue to be sent to the actor under the center point of the pinch until the pinch ends.<br>
+ /// A PinchGesture is emitted when the user moves two fingers towards or away from each other.<br />
+ /// A pinch gesture will continue to be sent to the actor under the center point of the pinch until the pinch ends.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PinchGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// The scale factor from the start of the pinch gesture till the latest pinch gesture.<br>
+ /// The scale factor from the start of the pinch gesture till the latest pinch gesture.<br />
/// If the user is moving their fingers away from each other, then
- /// this value increases. Conversely, if the user is moving their
- /// fingers towards each other, this value will decrease.<br>
+ /// this value increases. Conversely, if the user is moving their
+ /// fingers towards each other, this value will decrease.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Scale
{
get
}
/// <summary>
- /// The speed at which the user is moving their fingers.<br>
- /// This is the pixel movement per second.<br>
+ /// The speed at which the user is moving their fingers.<br />
+ /// This is the pixel movement per second.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Speed
{
get
/// <summary>
/// The center point of the two points that caused the pinch gesture in screen coordinates.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenCenterPoint
{
get
/// <summary>
/// The center point of the two points that caused the pinch gesture in local actor coordinates.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 LocalCenterPoint
{
get
}
/// <summary>
- /// Default Constructor.
+ /// The default constructor.
/// </summary>
- /// <param name="state">The state of the gesture</param>
+ /// <param name="state">The state of the gesture.</param>
internal PinchGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_PinchGesture__SWIG_0((int)state), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// The PixelData object holds a pixel buffer.<br />
+ /// The PixelData takes over the ownership of the pixel buffer.<br />
+ /// The buffer memory must NOT be released outside of this class, instead,
+ /// the PixelData object will release it automatically when the reference count falls to zero.
+ /// </summary>
+ /// Please DO NOT use! This will be deprecated!
+ /// PixelData class requires externally allocated pixel memory buffer and this buffer loses its ownershop by native DALi.
+ /// And this would make some problem, because dotnet runtime would change the address of memory allocated.
+ /// So this is required to be removed.
+ /// currently no use. will be added later
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class PixelData : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
-
+ /// <summary>
+ /// Creates a PixelData object.
+ /// </summary>
+ /// <param name="buffer">The raw pixel data.</param>
+ /// <param name="bufferSize">The size of the buffer in bytes.</param>
+ /// <param name="width">Buffer width in pixels.</param>
+ /// <param name="height">Buffer height in pixels.</param>
+ /// <param name="pixelFormat">The pixel format.</param>
+ /// <param name="releaseFunction">The function used to release the memory.</param>
+ /// <since_tizen> 3 </since_tizen>
public PixelData(byte[] buffer, uint bufferSize, uint width, uint height, PixelFormat pixelFormat, PixelData.ReleaseFunction releaseFunction) : this(NDalicPINVOKE.PixelData_New(buffer, bufferSize, width, height, (int)pixelFormat, (int)releaseFunction), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
+ /// <summary>
+ /// Gets the width of the buffer in pixels.
+ /// </summary>
+ /// <returns>The width of the buffer in pixels.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetWidth()
{
uint ret = NDalicPINVOKE.PixelData_GetWidth(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Gets the height of the buffer in pixels.
+ /// </summary>
+ /// <returns>The height of the buffer in pixels.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetHeight()
{
uint ret = NDalicPINVOKE.PixelData_GetHeight(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Gets the pixel format.
+ /// </summary>
+ /// <returns>The pixel format.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PixelFormat GetPixelFormat()
{
PixelFormat ret = (PixelFormat)NDalicPINVOKE.PixelData_GetPixelFormat(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Enumeration for Function to release the pixel buffer.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ReleaseFunction
{
+ /// <summary>
+ /// Use free function to release the pixel buffer.
+ /// </summary>
FREE,
+
+ /// <summary>
+ /// Use delete[] operator to release the pixel buffer.
+ /// </summary>
DELETE_ARRAY
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// Enumeration for Pixel formats.<br />
+ /// Pixel format, default color depth is RGBA 32 bit with alpha.
+ /// </summary>
+ /// /// <since_tizen> 3 </since_tizen>
public enum PixelFormat
{
+ /// <summary>
+ /// Used to represent an unsupported format.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
INVALID = 0,
+ /// <summary>
+ /// color depth 8-bit, alpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
A8 = 1,
+ /// <summary>
+ /// color depth 8-bit, luminance
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
L8,
+ /// <summary>
+ /// color depth 16-bit, luminance with 8 bit alpha
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LA88,
+ /// <summary>
+ /// color depth 16 bit, 5-6-5
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGB565,
+ /// <summary>
+ /// color depth 16 bit, 5-6-5
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BGR565,
+ /// <summary>
+ /// color depth 16 bit with alpha, 4-4-4-4
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGBA4444,
+ /// <summary>
+ /// color depth 16 bit with alpha, 4-4-4-4
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BGRA4444,
+ /// <summary>
+ /// color depth 16 bit with alpha, 5-5-5-1
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGBA5551,
+ /// <summary>
+ /// color depth 16 bit with alpha, 5-5-5-1
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BGRA5551,
+ /// <summary>
+ /// color depth 24 bit, 8-8-8
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGB888,
+ /// <summary>
+ /// color depth 32 bit, alpha is reserved but not used, 8-8-8-8#
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGB8888,
+ /// <summary>
+ /// color depth 32 bit, alpha is reserved but not used, 8-8-8-8#
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BGR8888,
+ /// <summary>
+ /// color depth 32 bit with alpha, 8-8-8-8
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
RGBA8888,
+ /// <summary>
+ /// color depth 32 bit with alpha, 8-8-8-8
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
BGRA8888,
+ /// <summary>
+ /// ETC2 / EAC single-channel, unsigned
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_R11_EAC,
+ /// <summary>
+ /// ETC2 / EAC single-channel, signed
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SIGNED_R11_EAC,
+ /// <summary>
+ /// ETC2 / EAC dual-channel, unsigned
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RG11_EAC,
+ /// <summary>
+ /// ETC2 / EAC dual-channel, signed
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SIGNED_RG11_EAC,
+ /// <summary>
+ /// ETC2 / EAC RGB
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGB8_ETC2,
+ /// <summary>
+ /// ETC2 / EAC RGB using sRGB colourspace.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ETC2,
+ /// <summary>
+ /// ETC2 / EAC RGB with single bit per pixel alpha mask.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2,
+ /// <summary>
+ /// ETC2 / EAC RGB using sRGB colourspace, with single bit per pixel alpha mask.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2,
+ /// <summary>
+ /// ETC2 / EAC RGB plus separate alpha channel.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA8_ETC2_EAC,
+ /// <summary>
+ /// ETC2 / EAC RGB using sRGB colourspace, plus separate alpha channel.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ETC2_EAC,
+ /// <summary>
+ /// ETC1 RGB as defined by GLES 2 extension OES_compressed_ETC1_RGB8_texture: http://www.khronos.org/registry/gles/extensions/OES/OES_compressed_ETC1_RGB8_texture.txt
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGB8_ETC1,
+ /// <summary>
+ /// PowerVR 4bpp RGB format (v1) as defined by extension IMG_texture_compression_pvrtc: http://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGB_PVRTC_4BPPV1,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 4x4 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_4x4_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 5x4 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_5x4_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 5x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_5x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 6x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_6x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 6x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_6x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_8x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_8x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x8 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_8x8_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_10x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_10x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x8 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_10x8_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x10 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_10x10_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 12x10 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_12x10_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 12x12 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_RGBA_ASTC_12x12_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 4x4 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 5x4 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 5x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 6x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 6x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 8x8 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x5 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x6 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x8 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 10x10 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 12x10 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR,
+ /// <summary>
+ /// ASTC Non-linear (gamma-corrected) color space with a 12x12 block-size.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR
}
*/
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
/// <summary>
- /// Position is a three dimensional vector.
+ /// Position is a three-dimensional vector.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Position : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Position(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Position()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Addition operator.
+ /// An addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">The vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator +(Position arg1, Position arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator -(Position arg1, Position arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Vector to netate</param>
- /// <returns>A vector containg the negation</returns>
+ /// <param name="arg1">The vector to negate.</param>
+ /// <returns>The vector containg the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator -(Position arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator *(Position arg1, Position arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
/// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator *(Position arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator /(Position arg1, Position arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator /(Position arg1, float arg2)
{
return arg1.Divide(arg2);
/// <summary>
- /// Const array subscript operator overload. Should be 0, 1 or 2.
+ /// The const array subscript operator overload. Should be 0, 1, or 2.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
}
- /// <summary>
- /// </summary>
internal static Position GetPositionFromPtr(global::System.IntPtr cPtr)
{
Position ret = new Position(cPtr, false);
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="x">x component</param>
- /// <param name="y">y component</param>
- /// <param name="z">z component</param>
+ /// <param name="x">The x component.</param>
+ /// <param name="y">The y component.</param>
+ /// <param name="z">The z component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Position(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="position2d">Position2D to create this vector from</param>
+ /// <param name="position2d">Position2D to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Position(Position2D position2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Position2D.getCPtr(position2d)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if rhs is equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Position rhs)
{
bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Position.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Position rhs)
{
bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Position.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
/// <summary>
/// ParentOrigin constants. It's 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginTop
{
get
/// <summary>
/// ParentOrigin constants. It's 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginBottom
{
get
/// <summary>
/// ParentOrigin constants. It's 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginLeft
{
get
/// <summary>
/// ParentOrigin constants. It's 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginRight
{
get
/// <summary>
/// ParentOrigin constants. It's 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginMiddle
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0, 0.0, 0.5
+ /// ParentOrigin constants: 0.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopLeft
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.5, 0.0, 0.5
+ /// ParentOrigin constants: 0.5, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 0.0, 0.5
+ /// ParentOrigin constants: 1.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopRight
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0, 0.5, 0.5
+ /// ParentOrigin constants: 0.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenterLeft
{
get
/// <summary>
/// ParentOrigin constants: 0.0, 0.5, 0.5
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 0.5, 0.5
+ /// ParentOrigin constants: 1.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenterRight
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0f, 1.0f, 0.5f
+ /// ParentOrigin constants: 0.0f, 1.0f, 0.5f.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomLeft
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.5, 1.0, 0.5
+ /// ParentOrigin constants: 0.5, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 1.0, 0.5
+ /// ParentOrigin constants: 1.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float PivotPointTop
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0
+ /// PivotPoint constants: 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float PivotPointBottom
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float PivotPointLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0
+ /// PivotPoint constants: 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float PivotPointRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float PivotPointMiddle
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 0.0, 0.5
+ /// PivotPoint constants: 0.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointTopLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 0.5, 0.0, 0.5
+ /// PivotPoint constants: 0.5, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointTopCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 0.0, 0.5
+ /// PivotPoint constants: 1.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointTopRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 0.5, 0.5
+ /// PivotPoint constants: 0.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointCenterLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 0.5, 0.5, 0.5
+ /// PivotPoint constants: 0.5, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 0.5, 0.5
+ /// PivotPoint constants: 1.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointCenterRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 1.0, 0.5
+ /// PivotPoint constants: 0.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointBottomLeft
{
get
/// <summary>
/// PivotPoint constants: 0.5, 1.0, 0.5
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointBottomCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 1.0, 0.5
+ /// PivotPoint constants: 1.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position PivotPointBottomRight
{
get
}
/// <summary>
- /// Constant ( 1.0f, 1.0f, 1.0f )
+ /// Constant ( 1.0f, 1.0f, 1.0f ).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position One
{
get
}
/// <summary>
- /// Constant ( 0.0f, 0.0f, 0.0f )
+ /// Constant ( 0.0f, 0.0f, 0.0f ).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Zero
{
get
}
/// <summary>
- /// Convert a position instance to a vector3 instance.
+ /// Converts a position instance to a Vector3 instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector3(Position Position)
{
return new Vector3(Position.X, Position.Y, Position.Z);
}
/// <summary>
- /// Convert a vector3 instance to a position instance.
+ /// Converts a Vector3 instance to a position instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Position(Vector3 vec)
{
return new Position(vec.X, vec.Y, vec.Z);
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointTop.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Top instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static float AnchorPointTop
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointBottom.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Bottom instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static float AnchorPointBottom
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointLeft.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Left instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static float AnchorPointLeft
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointRight.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Right instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static float AnchorPointRight
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointMiddle.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Middle instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static float AnchorPointMiddle
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointTopLeft.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.TopLeft instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointTopLeft
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointTopCenter.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.TopCenter instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointTopCenter
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointTopRight.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.TopRight instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointTopRight
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointCenterLeft.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.CenterLeft instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointCenterLeft
{
get
}
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointCenter.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.Center instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointCenter
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointCenterRight.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.CenterRight instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointCenterRight
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointBottomLeft.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.BottomLeft instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointBottomLeft
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointBottomCenter.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.BottomCenter instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointBottomCenter
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// [Obsolete("Please do not use! this will be deprecated")]
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use PivotPointBottomRight.
+ [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint.BottomRight instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Position AnchorPointBottomRight
{
get
{
/// <summary>
- /// Position2D is a two dimensional vector.
+ /// Position2D is a two-dimensional vector.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Position2D : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Position2D(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Position2D()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type.</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">The vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator +(Position2D arg1, Position2D arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator -(Position2D arg1, Position2D arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Vector to netate</param>
- /// <returns>A vector containing the negation</returns>
+ /// <param name="arg1">The vector to negate.</param>
+ /// <returns>The vector containing the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator -(Position2D arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Vector to multiply</param>
- /// <param name="arg2">Vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator *(Position2D arg1, Position2D arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Vector to multiply</param>
- /// <param name="arg2">The int value to scale the vector</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The integer value to scale the vector.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator *(Position2D arg1, int arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Vector to divide</param>
- /// <param name="arg2">Vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator /(Position2D arg1, Position2D arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Vector to divide</param>
- /// <param name="arg2">The int value to scale the vector by</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The integer value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position2D operator /(Position2D arg1, int arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Const array subscript operator overload. Should be 0, or 1.
+ /// The const array subscript operator overload. Should be 0, or 1.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position2D() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
/// <param name="x">x component</param>
/// <param name="y">y component</param>
+ /// <since_tizen> 3 </since_tizen>
public Position2D(int x, int y) : this(NDalicPINVOKE.new_Vector2__SWIG_1((float)x, (float)y), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
/// <param name="position">Position to create this vector from</param>
+ /// <since_tizen> 3 </since_tizen>
public Position2D(Position position) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Position.getCPtr(position)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to.
+ /// Compares if the rhs is equal to.
/// </summary>
/// <param name="rhs">The vector to compare</param>
/// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Position2D rhs)
{
bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, Position2D.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to.
+ /// Compares if the rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Position2D rhs)
{
bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, Position2D.getCPtr(rhs));
}
/// <summary>
- /// x component.
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int X
{
set
}
/// <summary>
- /// y component.
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Y
{
set
}
/// <summary>
- /// Convert a position2D instance to a vector2 instance.
+ /// Converts a Position2D instance to a Vector2 instance.
/// </summary>
+ /// <param name="position2d">An object of the Position2D type.</param>
+ /// <returns>return an object of the Vector2 type</returns>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector2(Position2D position2d)
{
return new Vector2((float)position2d.X, (float)position2d.Y);
}
/// <summary>
- /// Convert a vector2 instance to a position2D instance.
+ /// Converts a Vector2 instance to a Position2D instance.
/// </summary>
+ /// <param name="vec">An object of the Vector2 type.</param>
+ /// <returns>return an object of the Position2D type</returns>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Position2D(Vector2 vec)
{
return new Position2D((int)vec.X, (int)vec.Y);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
internal class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
protected bool disposed = false;
~Property()
}
/// <summary>
- /// Constructor. Create a Property instance.
+ /// This constructor creates a property instance.
/// </summary>
- /// <param name="arg0">A valid handle to the target object</param>
- /// <param name="propertyIndex">The index of a property</param>
+ /// <param name="arg0">A valid handle to the target object.</param>
+ /// <param name="propertyIndex">The index of a property.</param>
+ /// <since_tizen> 3 </since_tizen>
public Property(Animatable arg0, int propertyIndex) : this(NDalicPINVOKE.new_Property__SWIG_0(Animatable.getCPtr(arg0), propertyIndex), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor. Create a Property instance.
+ /// This constructor creates a property instance.
/// </summary>
- /// <param name="arg0">A valid handle to the target object</param>
- /// <param name="propertyIndex">The index of a property</param>
- /// <param name="componentIndex">Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)</param>
+ /// <param name="arg0">A valid handle to the target object.</param>
+ /// <param name="propertyIndex">The index of a property.</param>
+ /// <param name="componentIndex">Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for the main property (default is -1).</param>
+ /// <since_tizen> 3 </since_tizen>
public Property(Animatable arg0, int propertyIndex, int componentIndex) : this(NDalicPINVOKE.new_Property__SWIG_1(Animatable.getCPtr(arg0), propertyIndex, componentIndex), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor. Create a Property instance.<br>
- /// This performs a property index query and is therefore slower than constructing a Property directly with the index.<br>
+ /// This constructor creates a property instance.<br />
+ /// This performs a property index query and is therefore slower than constructing a property directly with the index.<br />
/// </summary>
- /// <param name="arg0">A valid handle to the target object</param>
- /// <param name="propertyName">The property name</param>
+ /// <param name="arg0">A valid handle to the target object.</param>
+ /// <param name="propertyName">The property name.</param>
+ /// <since_tizen> 3 </since_tizen>
public Property(Animatable arg0, string propertyName) : this(NDalicPINVOKE.new_Property__SWIG_2(Animatable.getCPtr(arg0), propertyName), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor. Create a Property instance.<br>
- /// This performs a property index query and is therefore slower than constructing a Property directly with the index.<br>
+ /// This constructor creates a property instance.<br />
+ /// This performs a property index query and is therefore slower than constructing a property directly with the index.<br />
/// </summary>
- /// <param name="arg0">A valid handle to the target object</param>
- /// <param name="propertyName">The property name</param>
- /// <param name="componentIndex">Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)</param>
+ /// <param name="arg0">A valid handle to the target object.</param>
+ /// <param name="propertyName">The property name.</param>
+ /// <param name="componentIndex">Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1).</param>
+ /// <since_tizen> 3 </since_tizen>
public Property(Animatable arg0, string propertyName, int componentIndex) : this(NDalicPINVOKE.new_Property__SWIG_3(Animatable.getCPtr(arg0), propertyName, componentIndex), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Gets/Sets the index of the property.
+ /// Gets or sets the index of the property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int propertyIndex
{
set
}
/// <summary>
- /// Gets/Sets the componentIndex of the property.
+ /// Gets or sets the component index of the property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int componentIndex
{
set
}
/// <summary>
- /// A Array of property values.
+ /// An array of property values.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PropertyArray : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal PropertyArray(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PropertyArray()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Operator to access an element.
+ /// The operator to access an element.
/// </summary>
- /// <param name="index">The element index to access. No bounds checking is performed</param>
- /// <returns>The a reference to the element</returns>
+ /// <param name="index">The element index to access. No bounds checking is performed.</param>
+ /// <returns>The reference to the element.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue this[uint index]
{
get
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray() : this(NDalicPINVOKE.new_Property_Array__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Retrieves the number of elements in the array.
/// </summary>
- /// <returns>The number of elements in the array</returns>
+ /// <returns>The number of elements in the array.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint Size()
{
uint ret = NDalicPINVOKE.Property_Array_Size(swigCPtr);
/// <summary>
/// Retrieves the number of elements in the array.
/// </summary>
- /// <returns>The number of elements in the array</returns>
+ /// <returns>The number of elements in the array.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint Count()
{
uint ret = NDalicPINVOKE.Property_Array_Count(swigCPtr);
/// <summary>
/// Returns whether the array is empty.
/// </summary>
- /// <returns>Return true if empty, false otherwise</returns>
+ /// <returns>Returns true if empty, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Empty()
{
bool ret = NDalicPINVOKE.Property_Array_Empty(swigCPtr);
/// <summary>
/// Clears the array.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Clear()
{
NDalicPINVOKE.Property_Array_Clear(swigCPtr);
/// <summary>
/// Increases the capacity of the array.
/// </summary>
- /// <param name="size">The size to reserve</param>
+ /// <param name="size">The size to reserve.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Reserve(uint size)
{
NDalicPINVOKE.Property_Array_Reserve(swigCPtr, size);
/// Resizes to size.
/// </summary>
/// <param name="size">The size to resize</param>
+ /// <since_tizen> 3 </since_tizen>
public void Resize(uint size)
{
NDalicPINVOKE.Property_Array_Resize(swigCPtr, size);
/// <summary>
/// Retrieves the capacity of the array.
/// </summary>
- /// <returns>The allocated capacity of the array</returns>
+ /// <returns>The allocated capacity of the array.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint Capacity()
{
uint ret = NDalicPINVOKE.Property_Array_Capacity(swigCPtr);
/// <summary>
/// Adds an element to the array.
/// </summary>
- /// <param name="value">The value to add to the end of the array</param>
+ /// <param name="value">The value to add at the end of the array.</param>
+ /// <since_tizen> 3 </since_tizen>
public void PushBack(PropertyValue value)
{
NDalicPINVOKE.Property_Array_PushBack(swigCPtr, PropertyValue.getCPtr(value));
}
/// <summary>
- /// Add an element to the array.
+ /// Adds an element to the array.
/// </summary>
- /// <param name="value">The value to add to the end of the array</param>
+ /// <param name="value">The value to add at the end of the array.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray Add(PropertyValue value)
{
PropertyArray ret = new PropertyArray(NDalicPINVOKE.Property_Array_Add(swigCPtr, PropertyValue.getCPtr(value)), false);
}
/// <summary>
- /// Access an element.
+ /// Accesses an element.
/// </summary>
- /// <param name="index">The element index to access. No bounds checking is performed</param>
- /// <returns>The a reference to the element</returns>
+ /// <param name="index">The element index to access. No bounds checking is performed.</param>
+ /// <returns>The reference to the element.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue GetElementAt(uint index)
{
PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Array_GetElementAt__SWIG_0(swigCPtr, index), false);
/// Retrieves the value of elements in the array.
/// </summary>
/// <param name="index">The element index to retrieve.</param>
- /// <returns>The a reference to the element</returns>
+ /// <returns>The reference to the element.</returns>
private PropertyValue ValueOfIndex(uint index)
{
PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Array_ValueOfIndex__SWIG_0(swigCPtr, index), false);
}
/// <summary>
- /// A key type which can be either a std::string or a Property::Index
+ /// A key type which can be either a std::string or a Property::Index.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PropertyKey : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal PropertyKey(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PropertyKey()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// The type of the key
+ /// The type of the key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyKey.KeyType Type
{
set
/// <summary>
/// The index key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int IndexKey
{
set
/// <summary>
/// The string key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string StringKey
{
set
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="key">The string key</param>
+ /// <param name="key">The string key.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyKey(string key) : this(NDalicPINVOKE.new_Property_Key__SWIG_0(key), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="key">The index key</param>
+ /// <param name="key">The index key.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyKey(int key) : this(NDalicPINVOKE.new_Property_Key__SWIG_1(key), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if rhs is equal to.
/// </summary>
- /// <param name="rhs">A string key to compare against</param>
- /// <returns>Returns true if the key compares, or false if it isn't equal or of the wrong type</returns>
+ /// <param name="rhs">A string key to compare against.</param>
+ /// <returns>Returns true if the key compares, or false if it isn't equal or of the wrong type.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(string rhs)
{
bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_0(swigCPtr, rhs);
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if rhs is equal to.
/// </summary>
- /// <param name="rhs">A index key to compare against</param>
- /// <returns>Returns true if the key compares, or false if it isn't equal or of the wrong type</returns>
+ /// <param name="rhs">The index key to compare against.</param>
+ /// <returns>Returns true if the key compares, or false if it isn't equal or of the wrong type.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(int rhs)
{
bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_1(swigCPtr, rhs);
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if rhs is equal to
/// </summary>
/// <param name="rhs">A key to compare against</param>
- /// <returns>Returns true if the keys are of the same type and have the same value</returns>
+ /// <returns>Returns true if the keys are of the same type and have the same value.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(PropertyKey rhs)
{
bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_2(swigCPtr, PropertyKey.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if rhs is not equal to.
/// </summary>
- /// <param name="rhs">An index key to compare against.</param>
- /// <returns>Returns true if the key is not equal or not a string key</returns>
+ /// <param name="rhs">The index key to compare against.</param>
+ /// <returns>Returns true if the key is not equal or not a string key.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(string rhs)
{
bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_0(swigCPtr, rhs);
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if rhs is not equal to.
/// </summary>
- /// <param name="rhs">An index key to compare against.</param>
- /// <returns>Returns true if the key is not equal, or not an index key</returns>
+ /// <param name="rhs">The index key to compare against.</param>
+ /// <returns>Returns true if the key is not equal, or not the index key.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(int rhs)
{
bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_1(swigCPtr, rhs);
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if rhs is not equal to.
/// </summary>
/// <param name="rhs">A key to compare against.</param>
- /// <returns>Returns true if the keys are not of the same type or are not equal</returns>
+ /// <returns>Returns true if the keys are not of the same type or are not equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(PropertyKey rhs)
{
bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_2(swigCPtr, PropertyKey.getCPtr(rhs));
}
/// <summary>
- /// The type of key
+ /// The type of key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum KeyType
{
+ /// <summary>
+ /// The type of key is index.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Index,
+ /// <summary>
+ /// The type of key is string.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
String
}
}
/// <summary>
- /// A Map of property values, the key type could be String or Property::Index.
+ /// A map of property values, the key type could be string or Property::Index.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PropertyMap : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal PropertyMap(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PropertyMap()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Operator to access the element with the specified string key.<br>
- /// If an element with the key does not exist, then it is created.<br>
+ /// The operator to access the element with the specified string key.<br />
+ /// If an element with the key does not exist, then it is created.<br />
/// </summary>
- /// <param name="key">The key whose value to access</param>
- /// <returns>A value for the element with the specified key</returns>
+ /// <param name="key">The key whose value to access.</param>
+ /// <returns>A value for the element with the specified key.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue this[string key]
{
get
}
/// <summary>
- /// Operator to access the element with the specified index key.<br>
- /// If an element with the key does not exist, then it is created.<br>
+ /// The operator to access the element with the specified index key.<br />
+ /// If an element with the key does not exist, then it is created.<br />
/// </summary>
- /// <param name="key">The key whose value to access</param>
- /// <returns>A value for the element with the specified key</returns>
+ /// <param name="key">The key whose value to access.</param>
+ /// <returns>A value for the element with the specified key.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue this[int key]
{
get
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap() : this(NDalicPINVOKE.new_Property_Map__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Copy Constructor
+ /// The copy constructor.
/// </summary>
- /// <param name="other">The Map to copy from</param>
+ /// <param name="other">The map to copy from.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap(PropertyMap other) : this(NDalicPINVOKE.new_Property_Map__SWIG_1(PropertyMap.getCPtr(other)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Retrieves the number of elements in the map.
/// </summary>
- /// <returns>The number of elements in the map</returns>
+ /// <returns>The number of elements in the map.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint Count()
{
uint ret = NDalicPINVOKE.Property_Map_Count(swigCPtr);
/// <summary>
/// Returns whether the map is empty.
/// </summary>
- /// <returns>Returns true if empty, false otherwise</returns>
+ /// <returns>Returns true if empty, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Empty()
{
bool ret = NDalicPINVOKE.Property_Map_Empty(swigCPtr);
}
/// <summary>
- /// Inserts the key-value pair in the Map, with the key type as string.<br>
- /// Does not check for duplicates.<br>
+ /// Inserts the key-value pair in the map, with the key type as string.<br />
+ /// Does not check for duplicates.<br />
/// </summary>
- /// <param name="key">The key to insert</param>
- /// <param name="value">The value to insert</param>
+ /// <param name="key">The key to insert.</param>
+ /// <param name="value">The value to insert.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Insert(string key, PropertyValue value)
{
NDalicPINVOKE.Property_Map_Insert__SWIG_0(swigCPtr, key, PropertyValue.getCPtr(value));
}
/// <summary>
- /// Inserts the key-value pair in the Map, with the key type as index.<br>
- /// Does not check for duplicates.<br>
+ /// Inserts the key-value pair in the map, with the key type as index.<br />
+ /// Does not check for duplicates.<br />
/// </summary>
- /// <param name="key">The key to insert</param>
- /// <param name="value">The value to insert</param>
+ /// <param name="key">The key to insert.</param>
+ /// <param name="value">The value to insert.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Insert(int key, PropertyValue value)
{
NDalicPINVOKE.Property_Map_Insert__SWIG_2(swigCPtr, key, PropertyValue.getCPtr(value));
}
/// <summary>
- /// Inserts the key-value pair in the Map, with the key type as string.<br>
- /// Does not check for duplicates.<br>
+ /// Inserts the key-value pair in the map, with the key type as string.<br />
+ /// Does not check for duplicates.<br />
/// </summary>
- /// <param name="key">The key to insert</param>
- /// <param name="value">The value to insert</param>
- /// <returns>Returns a reference to this object</returns>
+ /// <param name="key">The key to insert.</param>
+ /// <param name="value">The value to insert.</param>
+ /// <returns>Returns a reference to this object.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Add(string key, PropertyValue value)
{
PropertyMap ret = new PropertyMap(NDalicPINVOKE.Property_Map_Add__SWIG_0(swigCPtr, key, PropertyValue.getCPtr(value)), false);
}
/// <summary>
- /// Inserts the key-value pair in the Map, with the key type as string.<br>
- /// Does not check for duplicates.<br>
+ /// Inserts the key-value pair in the map, with the key type as string.<br />
+ /// Does not check for duplicates.<br />
/// </summary>
- /// <param name="key">The key to insert</param>
- /// <param name="value">The value to insert</param>
- /// <returns>Returns a reference to this object</returns>
+ /// <param name="key">The key to insert.</param>
+ /// <param name="value">The value to insert.</param>
+ /// <returns>Returns a reference to this object.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Add(int key, PropertyValue value)
{
PropertyMap ret = new PropertyMap(NDalicPINVOKE.Property_Map_Add__SWIG_2(swigCPtr, key, PropertyValue.getCPtr(value)), false);
/// <summary>
/// Retrieves the value at the specified position.
/// </summary>
- /// <param name="position">The specified position</param>
- /// <returns>A reference to the value at the specified position</returns>
+ /// <param name="position">The specified position.</param>
+ /// <returns>A reference to the value at the specified position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue GetValue(uint position)
{
PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_GetValue(swigCPtr, position), false);
return ret;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public string GetKey(uint position)
{
string ret = NDalicPINVOKE.Property_Map_GetKey(swigCPtr, position);
}
/// <summary>
- /// Retrieve the key at the specified position.
+ /// Retrieves the key at the specified position.
/// </summary>
- /// <param name="position">The specified position</param>
- /// <returns>A copy of the key at the specified position</returns>
+ /// <param name="position">The specified position.</param>
+ /// <returns>A copy of the key at the specified position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyKey GetKeyAt(uint position)
{
PropertyKey ret = new PropertyKey(NDalicPINVOKE.Property_Map_GetKeyAt(swigCPtr, position), true);
return ret;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public PropertyValue Find(string key)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_0(swigCPtr, key);
/// <summary>
/// Finds the value for the specified key if it exists.
/// </summary>
- /// <param name="key">The key to find</param>
- /// <returns>The value if it exists, an empty object otherwise</returns>
+ /// <param name="key">The key to find.</param>
+ /// <returns>The value if it exists, an empty object otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue Find(int key)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_2(swigCPtr, key);
/// <summary>
/// Finds the value for the specified keys if either exist.
/// </summary>
- /// <param name="indexKey">The index key to find</param>
- /// <param name="stringKey">The string key to find</param>
- /// <returns>The value if it exists, an empty object otherwise</returns>
+ /// <param name="indexKey">The index key to find.</param>
+ /// <param name="stringKey">The string key to find.</param>
+ /// <returns>The value if it exists, an empty object otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue Find(int indexKey, string stringKey)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_3(swigCPtr, indexKey, stringKey);
return ret;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public PropertyValue Find(string key, PropertyType type)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_4(swigCPtr, key, (int)type);
return ret;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public PropertyValue Find(int key, PropertyType type)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_5(swigCPtr, key, (int)type);
/// <summary>
/// Clears the map.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Clear()
{
NDalicPINVOKE.Property_Map_Clear(swigCPtr);
}
/// <summary>
- /// Merges values from the map 'from' to the current.<br>
- /// Any values in 'from' will overwrite the values in the current map.<br>
+ /// Merges values from the map 'from' to the current.<br />
+ /// Any values in 'from' will overwrite the values in the current map.<br />
/// </summary>
- /// <param name="from">The map to merge from</param>
+ /// <param name="from">The map to merge from.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Merge(PropertyMap from)
{
NDalicPINVOKE.Property_Map_Merge(swigCPtr, PropertyMap.getCPtr(from));
/// <summary>
/// Retrieves the element with the specified string key.
/// </summary>
- /// <param name="key">The key whose value to retrieve</param>
- /// <returns>The value for the element with the specified key</returns>
+ /// <param name="key">The key whose value to retrieve.</param>
+ /// <returns>The value for the element with the specified key.</returns>
internal PropertyValue ValueOfIndex(string key)
{
PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_ValueOfIndex__SWIG_0(swigCPtr, key), false);
/// <summary>
/// Retrieves the element with the specified index key.
/// </summary>
- /// <param name="key">The key whose value to retrieve</param>
- /// <returns>The value for the element with the specified key</returns>
+ /// <param name="key">The key whose value to retrieve.</param>
+ /// <returns>The value for the element with the specified key.</returns>
internal PropertyValue ValueOfIndex(int key)
{
PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_ValueOfIndex__SWIG_2(swigCPtr, key), false);
/// <summary>
/// A value-type representing a property value.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PropertyValue : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal PropertyValue(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PropertyValue()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Extension to property value class that allows us to create a
- /// PropertyValue from a C# object, e.g. int, float, string.<br>
+ /// An extension to the property value class that allows us to create a
+ /// Property value from a C# object, for example, integer, float, or string.<br />
/// </summary>
- /// <param name="obj">An object to create</param>
- /// <returns>The created value</returns>
+ /// <param name="obj">An object to create.</param>
+ /// <returns>The created value.</returns>
+ /// <since_tizen> 3 </since_tizen>
static public PropertyValue CreateFromObject(System.Object obj)
{
System.Type type = obj.GetType();
/// <summary>
/// Creates a Size2D property value.
/// </summary>
- /// <param name="vectorValue">A Size2D values</param>
+ /// <param name="vectorValue">Size2D values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Size2D vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Size2D.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Position2D property value.
/// </summary>
- /// <param name="vectorValue">A Position2D values</param>
+ /// <param name="vectorValue">Position2D values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Position2D vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Position2D.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Size property value.
/// </summary>
- /// <param name="vectorValue">A Size values</param>
+ /// <param name="vectorValue">Size values.</param>
internal PropertyValue(Size vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Size.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Position property value.
/// </summary>
- /// <param name="vectorValue">A Position values</param>
+ /// <param name="vectorValue">Position values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Position vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Position.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Color property value.
/// </summary>
- /// <param name="vectorValue">A Color values</param>
+ /// <param name="vectorValue">Color values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Color vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_6(Color.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Retrieves a Size2D value.
/// </summary>
- /// <param name="vectorValue"> On return, a Size2D value</param>
+ /// <param name="vectorValue"> On return, a Size2D value.</param>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Size2D vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Size2D.getCPtr(vectorValue));
/// <summary>
/// Retrieves a Position2D value.
/// </summary>
- /// <param name="vectorValue"> On return, a Position2D value</param>
+ /// <param name="vectorValue"> On return, a Position2D value.</param>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Position2D vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Position2D.getCPtr(vectorValue));
/// <summary>
/// Retrieves a Size value.
/// </summary>
- /// <param name="vectorValue"> On return, a Size value</param>
+ /// <param name="vectorValue"> On return, a size value.</param>
internal bool Get(Size vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Size.getCPtr(vectorValue));
/// <summary>
/// Retrieves a Position value.
/// </summary>
- /// <param name="vectorValue"> On return, a Position value</param>
+ /// <param name="vectorValue"> On return, a position value.</param>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Position vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Position.getCPtr(vectorValue));
/// <summary>
/// Retrieves a Color value.
/// </summary>
- /// <param name="vectorValue"> On return, a Color value</param>
+ /// <param name="vectorValue"> On return, a color value.</param>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Color vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_7(swigCPtr, Color.getCPtr(vectorValue));
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue() : this(NDalicPINVOKE.new_Property_Value__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a boolean property value.
/// </summary>
- /// <param name="boolValue">A boolean value</param>
+ /// <param name="boolValue">A boolean value.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(bool boolValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_1(boolValue), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates an integer property value.
/// </summary>
- /// <param name="integerValue">An integer value</param>
+ /// <param name="integerValue">An integer value.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(int integerValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_2(integerValue), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a float property value.
/// </summary>
- /// <param name="floatValue">A floating-point value</param>
+ /// <param name="floatValue">A floating-point value.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(float floatValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_3(floatValue), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Vector2 property value.
/// </summary>
- /// <param name="vectorValue">A vector of 2 floating-point values</param>
+ /// <param name="vectorValue">A vector of 2 floating-point values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Vector2 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Vector2.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Vector3 property value.
/// </summary>
- /// <param name="vectorValue">A vector of 3 floating-point values</param>
+ /// <param name="vectorValue">A vector of 3 floating-point values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Vector3 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Vector3.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Vector4 property value.
/// </summary>
- /// <param name="vectorValue">A vector of 4 floating-point values</param>
+ /// <param name="vectorValue">A vector of 4 floating-point values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Vector4 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_6(Vector4.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Rectangle property value.
/// </summary>
- /// <param name="vectorValue">A Rectangle values</param>
+ /// <param name="vectorValue">Rectangle values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Rectangle vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_9(Rectangle.getCPtr(vectorValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a Rotation property value.
/// </summary>
- /// <param name="quaternion">A Rotation values</param>
+ /// <param name="quaternion">Rotation values.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(Rotation quaternion) : this(NDalicPINVOKE.new_Property_Value__SWIG_11(Rotation.getCPtr(quaternion)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a string property value.
/// </summary>
- /// <param name="stringValue">A string</param>
+ /// <param name="stringValue">A string.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(string stringValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_12(stringValue), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates an array property value.
/// </summary>
- /// <param name="arrayValue">An array</param>
+ /// <param name="arrayValue">An array.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(PropertyArray arrayValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_14(PropertyArray.getCPtr(arrayValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates a map property value.
/// </summary>
- /// <param name="mapValue">An array</param>
+ /// <param name="mapValue">An array.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(PropertyMap mapValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_15(PropertyMap.getCPtr(mapValue)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Creates a PropertyType value.
/// </summary>
/// <param name="type">A PropertyType values</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(PropertyType type) : this(NDalicPINVOKE.new_Property_Value__SWIG_16((int)type), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Creates a PropertyValue value.
/// </summary>
/// <param name="value">A PropertyValue values</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyValue(PropertyValue value) : this(NDalicPINVOKE.new_Property_Value__SWIG_17(PropertyValue.getCPtr(value)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Queries the type of this property value.
/// </summary>
/// <returns>The type ID</returns>
- public PropertyType GetType()
+ /// <since_tizen> 3 </since_tizen>
+ public new PropertyType GetType()
{
PropertyType ret = (PropertyType)NDalicPINVOKE.Property_Value_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Retrieves a boolean value.
/// </summary>
- /// <param name="boolValue">On return, a boolean value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="boolValue">On return, a boolean value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(out bool boolValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_1(swigCPtr, out boolValue);
/// <summary>
/// Retrieves a floating-point value.
/// </summary>
- /// <param name="floatValue">On return, a floating-point value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="floatValue">On return, a floating-point value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(out float floatValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_2(swigCPtr, out floatValue);
}
/// <summary>
- /// Retrieves a integer value.
+ /// Retrieves an integer value.
/// </summary>
- /// <param name="integerValue">On return, a integer value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="integerValue">On return, an integer value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(out int integerValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_3(swigCPtr, out integerValue);
/// <summary>
/// Retrieves an integer rectangle.
/// </summary>
- /// <param name="rect">On return, an integer rectangle</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="rect">On return, an integer rectangle.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Rectangle rect)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_4(swigCPtr, Rectangle.getCPtr(rect));
/// <summary>
/// Retrieves a vector value.
/// </summary>
- /// <param name="vectorValue">On return, a vector value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="vectorValue">On return, a vector value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Vector2 vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Vector2.getCPtr(vectorValue));
/// <summary>
/// Retrieves a vector value.
/// </summary>
- /// <param name="vectorValue">On return, a vector value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="vectorValue">On return, a vector value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Vector3 vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Vector3.getCPtr(vectorValue));
/// <summary>
/// Retrieves a vector value.
/// </summary>
- /// <param name="vectorValue">On return, a vector value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="vectorValue">On return, a vector value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Vector4 vectorValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_7(swigCPtr, Vector4.getCPtr(vectorValue));
/// <summary>
/// Retrieves a Rotation value.
/// </summary>
- /// <param name="quaternionValue">On return, a Rotation value</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="quaternionValue">On return, a rotation value.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(Rotation quaternionValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_11(swigCPtr, Rotation.getCPtr(quaternionValue));
/// <summary>
/// Retrieves a string property value.
/// </summary>
- /// <param name="stringValue">On return, a string</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="stringValue">On return, a string.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(out string stringValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_12(swigCPtr, out stringValue);
/// <summary>
/// Retrieves an array property value.
/// </summary>
- /// <param name="arrayValue">On return, the array as a vector Property Values</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="arrayValue">On return, the array as a vector property values.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(PropertyArray arrayValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_13(swigCPtr, PropertyArray.getCPtr(arrayValue));
}
/// <summary>
- /// Retrieves an map property value.
+ /// Retrieves a map property value.
/// </summary>
- /// <param name="mapValue">On return, the map as vector of string and Property Value pairs</param>
- /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible</returns>
+ /// <param name="mapValue">On return, the map as vector of string and property value pairs.</param>
+ /// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Get(PropertyMap mapValue)
{
bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_14(swigCPtr, PropertyMap.getCPtr(mapValue));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// PropertyBuffer is a handle to an object that contains a buffer of structured properties.<br />
+ /// PropertyBuffers can be used to provide data to Geometry objects.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PropertyBuffer : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Creates a PropertyBuffer.
+ /// </summary>
+ /// <param name="bufferFormat">The map of names and types that describes the components of the buffer.</param>
+ /// <since_tizen> 3 </since_tizen>
public PropertyBuffer(PropertyMap bufferFormat) : this(NDalicPINVOKE.PropertyBuffer_New(PropertyMap.getCPtr(bufferFormat)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
+ /// <summary>
+ /// Updates the whole buffer information.<br />
+ /// This function expects a pointer to an array of structures with the same
+ /// format that was given in the construction, and the number of elements to
+ /// be the same as the size of the buffer.<br />
+ /// </summary>
+ /// <param name="data">A pointer to the data that will be copied to the buffer.</param>
+ /// <param name="size">Number of elements to expand or contract the buffer.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetData(System.IntPtr data, uint size)
{
NDalicPINVOKE.PropertyBuffer_SetData(swigCPtr, data, size);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the number of elements in the buffer.
+ /// </summary>
+ /// <returns>Number of elements to expand or contract the buffer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetSize()
{
uint ret = NDalicPINVOKE.PropertyBuffer_GetSize(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
/// A condition that can be evaluated on a Property Value
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class PropertyCondition : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Create a property condition instance.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public PropertyCondition() : this(NDalicPINVOKE.new_PropertyCondition__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Retrieves the arguments that this condition uses.
/// </summary>
+ /// <returns>The arguments used for this condition.</returns>
+ /// <since_tizen> 4 </since_tizen>
public uint GetArgumentCount()
{
uint ret = NDalicPINVOKE.PropertyCondition_GetArgumentCount(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
- ///<summary>
+ /// <summary>
/// Retrieves the arguments that this condition uses
- ///</summary>
+ /// </summary>
+ /// <param name="index">The condition index to get the argument.</param>
+ /// <returns>The arguments used for this condition.</returns>
+ /// <since_tizen> 4 </since_tizen>
public float GetArgument(uint index)
{
float ret = NDalicPINVOKE.PropertyCondition_GetArgument(swigCPtr, index);
return ret;
}
- ///<summary>
+ /// <summary>
/// LessThan condition compares whether property is less than arg.
- ///</summary>
+ /// </summary>
+ /// <param name="arg">The argument for the condition.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition LessThan(float arg)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.LessThanCondition(arg), true);
return ret;
}
- ///<summary>
+ /// <summary>
/// GreaterThan condition compares whether property is greater than arg.
- ///</summary>
+ /// </summary>
+ /// <param name="arg">The argument for the condition.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition GreaterThan(float arg)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.GreaterThanCondition(arg), true);
return ret;
}
- ///<summary>
+ /// <summary>
/// Inside condition compares whether property is greater than arg0 and less than arg1.
- ///</summary>
+ /// </summary>
+ /// <param name="arg0">The first argument for the condition.</param>
+ /// <param name="arg1">The second argument for the condition.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition Inside(float arg0, float arg1)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.InsideCondition(arg0, arg1), true);
return ret;
}
- ///<summary>
+ /// <summary>
/// Outside condition compares whether property is less than arg0 or greater than arg1
- ///</summary>
+ /// </summary>
+ /// <param name="arg0">The first argument for the condition.</param>
+ /// <param name="arg1">The second argument for the condition.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition Outside(float arg0, float arg1)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.OutsideCondition(arg0, arg1), true);
return ret;
}
- ///<summary>
+ /// <summary>
/// Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
- ///</summary>
+ /// </summary>
+ /// <param name="stepAmount">The step size required to trigger condition.</param>
+ /// <param name="initialValue">The initial value to step from.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition Step(float stepAmount, float initialValue)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.StepCondition__SWIG_0(stepAmount, initialValue), true);
return ret;
}
- ///<summary>
+ /// <summary>
/// Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
- ///</summary>
+ /// </summary>
+ /// <param name="stepAmount">List of values to receive notifications for as a property crosses them.</param>
+ /// <returns>A property condition function object.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyCondition Step(float stepAmount)
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.StepCondition__SWIG_1(stepAmount), true);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// Issues a notification upon a condition of the property being met.
/// See PropertyCondition for available defined conditions.
///</summary>
+ /// <since_tizen> 4 </since_tizen>
public class PropertyNotification : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
- /**
- * @brief Event arguments that passed via Notify signal
- *
- */
+ ///<summary>
+ /// Event arguments that passed via Notify signal
+ ///</summary>
+ /// <since_tizen> 3 </since_tizen>
public class NotifyEventArgs : EventArgs
{
private PropertyNotification _propertyNotification;
- /**
- * @brief PropertyNotification - is the PropertyNotification handle that has the notification properties.
- *
- */
+ ///<summary>
+ /// PropertyNotification - is the PropertyNotification handle that has the notification properties.
+ ///</summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyNotification PropertyNotification
{
get
private DaliEventHandler<object, NotifyEventArgs> _propertyNotificationNotifyEventHandler;
private NotifyEventCallbackDelegate _propertyNotificationNotifyEventCallbackDelegate;
- /**
- * @brief Event for Notified signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of NotifyEventHandler-DaliEventHandler<object,NotifyEventArgs>) provided by the user.
- * Notified signal is emitted when the notification upon a condition of the property being met, has occurred.
- */
+ ///<summary>
+ /// Event for Notified signal which can be used to subscribe/unsubscribe the event handler
+ /// Notified signal is emitted when the notification upon a condition of the property being met, has occurred.
+ ///</summary>
+ /// <since_tizen> 4 </since_tizen>
public event DaliEventHandler<object, NotifyEventArgs> Notified
{
add
}
}
+ /// <summary>
+ /// Get property notification from Intptr.<br/>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <param name="cPtr">An object of IntPtr type.</param>
+ /// <returns>An object of the PropertyNotification type.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyNotification GetPropertyNotificationFromPtr(global::System.IntPtr cPtr)
{
PropertyNotification ret = new PropertyNotification(cPtr, false);
return ret;
}
-
+ /// <summary>
+ /// Create a instance of PropertyNotification.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotification() : this(NDalicPINVOKE.new_PropertyNotification__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Downcast a PropertyNotification instance.
+ /// </summary>
+ /// <param name="handle">Handle to an object of BaseHandle type.</param>
+ /// <returns>Handle to an object of the PropertyNotification type.</returns>
+ /// <since_tizen> 4 </since_tizen>
public static PropertyNotification DownCast(BaseHandle handle)
{
PropertyNotification ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as PropertyNotification;
return ret;
}
+ /// <summary>
+ /// Create a instance of PropertyNotification.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotification(PropertyNotification handle) : this(NDalicPINVOKE.new_PropertyNotification__SWIG_1(PropertyNotification.getCPtr(handle)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Assign.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle.</param>
+ /// <returns>A reference to this.</returns>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotification Assign(PropertyNotification rhs)
{
PropertyNotification ret = new PropertyNotification(NDalicPINVOKE.PropertyNotification_Assign(swigCPtr, PropertyNotification.getCPtr(rhs)), false);
return ret;
}
+ /// <summary>
+ /// Gets the condition of this notification.
+ /// </summary>
+ /// <returns>The condition is returned.</returns>
+ /// <since_tizen> 4 </since_tizen>
public PropertyCondition GetCondition()
{
PropertyCondition ret = new PropertyCondition(NDalicPINVOKE.PropertyNotification_GetCondition__SWIG_0(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Gets the target handle that this notification is observing.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Animatable GetTarget()
{
Animatable ret = new Animatable(NDalicPINVOKE.PropertyNotification_GetTarget(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Gets the target handle's property index that this notification.
+ /// </summary>
+ /// <returns>The target property index.</returns>
+ /// <since_tizen> 4 </since_tizen>
public int GetTargetProperty()
{
int ret = NDalicPINVOKE.PropertyNotification_GetTargetProperty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the Notification mode.
+ /// </summary>
+ /// <param name="mode">mode Notification mode (Default is PropertyNotification::NotifyOnTrue).</param>
+ /// <since_tizen> 4 </since_tizen>
public void SetNotifyMode(PropertyNotification.NotifyMode mode)
{
NDalicPINVOKE.PropertyNotification_SetNotifyMode(swigCPtr, (int)mode);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Retrieves the current Notification mode.
+ /// </summary>
+ /// <returns>Notification mode.</returns>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotification.NotifyMode GetNotifyMode()
{
PropertyNotification.NotifyMode ret = (PropertyNotification.NotifyMode)NDalicPINVOKE.PropertyNotification_GetNotifyMode(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Gets the result of the last condition check that caused a signal emit,
+ /// useful when using NotifyOnChanged mode and need to know what it changed to.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool GetNotifyResult()
{
bool ret = NDalicPINVOKE.PropertyNotification_GetNotifyResult(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects to this signal to be notified when the notification has occurred.
+ /// </summary>
+ /// <returns>A signal object to Connect() with</returns>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotifySignal NotifySignal()
{
PropertyNotifySignal ret = new PropertyNotifySignal(NDalicPINVOKE.PropertyNotification_NotifySignal(swigCPtr), false);
return ret;
}
+ /// <summary>
+ /// Enumeration for description of how to check condition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum NotifyMode
{
+ /// <summary>
+ /// Don't notify, regardless of result of Condition
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Disabled,
+ /// <summary>
+ /// Notify whenever condition changes from false to true.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotifyOnTrue,
+ /// <summary>
+ /// Notify whenever condition changes from true to false.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotifyOnFalse,
+ /// <summary>
+ /// Notify whenever condition changes (false to true, and true to false)
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotifyOnChanged
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
///<summary>
/// Signal connection class for PropertyNotification
///</summary>
+ /// <since_tizen> 4 </since_tizen>
public class PropertyNotifySignal : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool swigCMemOwn;
internal PropertyNotifySignal(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~PropertyNotifySignal()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">The dispose type.</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
-
+ /// <summary>
+ /// Queries whether there are any connected slots.
+ /// </summary>
+ /// <returns>True if there are any slots connected to the signal.</returns>
+ /// <since_tizen> 4 </since_tizen>
public bool Empty()
{
bool ret = NDalicPINVOKE.PropertyNotifySignal_Empty(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Queries the number of slots.
+ /// </summary>
+ /// <returns>The number of slots connected to this signal</returns>
+ /// <since_tizen> 4 </since_tizen>
public uint GetConnectionCount()
{
uint ret = NDalicPINVOKE.PropertyNotifySignal_GetConnectionCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Connects a function.
+ /// </summary>
+ /// <param name="func">The function to connect</param>
+ /// <since_tizen> 4 </since_tizen>
public void Connect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Disconnects a function.
+ /// </summary>
+ /// <param name="func">The function to disconnect.</param>
+ /// <since_tizen> 4 </since_tizen>
public void Disconnect(System.Delegate func)
{
System.IntPtr ip = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func);
}
}
+ /// <summary>
+ /// Emits a signal with 1 parameter.
+ /// </summary>
+ /// <param name="arg">The first value to pass to callbacks.</param>
+ /// <since_tizen> 4 </since_tizen>
public void Emit(PropertyNotification arg)
{
NDalicPINVOKE.PropertyNotifySignal_Emit(swigCPtr, PropertyNotification.getCPtr(arg));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// The constructor.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public PropertyNotifySignal() : this(NDalicPINVOKE.new_PropertyNotifySignal(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
/// An angle in radians.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Radian : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Radian(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Radian()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Default constructor, initializes to 0.
+ /// The default constructor, initializes to 0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Radian() : this(NDalicPINVOKE.new_Radian__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates an angle in radians.
/// </summary>
- /// <param name="value">The initial value in radians</param>
+ /// <param name="value">The initial value in radians.</param>
+ /// <since_tizen> 3 </since_tizen>
public Radian(float value) : this(NDalicPINVOKE.new_Radian__SWIG_1(value), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Creates an angle in radians from an angle in degrees.
/// </summary>
- /// <param name="degree">The initial value in degrees</param>
+ /// <param name="degree">The initial value in degrees.</param>
+ /// <since_tizen> 3 </since_tizen>
public Radian(Degree degree) : this(NDalicPINVOKE.new_Radian__SWIG_2(Degree.getCPtr(degree)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Conversion to float.
/// </summary>
- /// <returns>The float value of this Radian</returns>
+ /// <returns>The float value of this radian.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float ConvertToFloat()
{
float ret = NDalicPINVOKE.Radian_ConvertToFloat(swigCPtr);
}
/// <summary>
- /// The value in radians
+ /// The value in radians.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Value
{
set
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// Rectangle class
+ /// The Rectangle class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Rectangle : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Rectangle(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Rectangle()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Equality operator.
+ /// THe Equality operator.
/// </summary>
- /// <param name="a">First operand</param>
- /// <param name="b">Second operand</param>
- /// <returns>True if boxes are exactly same</returns>
+ /// <param name="a">The first operand.</param>
+ /// <param name="b">The second operand.</param>
+ /// <returns>True if the boxes are exactly the same.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator ==(Rectangle a, Rectangle b)
{
// If both are null, or both are same instance, return true.
/// <summary>
/// Inequality operator.
/// </summary>
- /// <param name="a">The first rectangle</param>
- /// <param name="b">The second rectangle</param>
- /// <returns>True if rectangles are not identical</returns>
+ /// <param name="a">The first rectangle.</param>
+ /// <param name="b">The second rectangle.</param>
+ /// <returns>True if the rectangles are not identical.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator !=(Rectangle a, Rectangle b)
{
return !(a == b);
}
/// <summary>
- /// X position of the rectangle
+ /// The x position of the rectangle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int X
{
set
}
/// <summary>
- /// Y position of the rectangle
+ /// The Y position of the rectangle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Y
{
set
}
/// <summary>
- /// Width of the rectangle
+ /// The width of the rectangle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Width
{
set
}
/// <summary>
- /// Height of the rectangle
+ /// The height of the rectangle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Height
{
set
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle() : this(NDalicPINVOKE.new_Rectangle__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="x">X coordinate (or left)</param>
- /// <param name="y">Y coordinate (or right)</param>
- /// <param name="width">Width (or bottom)</param>
- /// <param name="height">Height (or top)</param>
+ /// <param name="x">The x coordinate (or left).</param>
+ /// <param name="y">The y coordinate (or right).</param>
+ /// <param name="width">The width (or bottom).</param>
+ /// <param name="height">The height (or top).</param>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle(int x, int y, int width, int height) : this(NDalicPINVOKE.new_Rectangle__SWIG_1(x, y, width, height), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Assignment from individual values.
/// </summary>
- /// <param name="newX">X coordinate</param>
- /// <param name="newY">Y coordinate</param>
- /// <param name="newWidth">Width</param>
- /// <param name="newHeight">Height</param>
+ /// <param name="newX">The x coordinate.</param>
+ /// <param name="newY">The y coordinate.</param>
+ /// <param name="newWidth">The width.</param>
+ /// <param name="newHeight">The height.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Set(int newX, int newY, int newWidth, int newHeight)
{
NDalicPINVOKE.Rectangle_Set(swigCPtr, newX, newY, newWidth, newHeight);
}
/// <summary>
- /// Determines whether or not this Rectangle is empty.
+ /// Determines whether or not this rectangle is empty.
/// </summary>
- /// <returns>True if width or height are zero</returns>
+ /// <returns>True if width or height are zero.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsEmpty()
{
bool ret = NDalicPINVOKE.Rectangle_IsEmpty(swigCPtr);
/// <summary>
/// Gets the left of the rectangle.
/// </summary>
- /// <returns>The left edge of the rectangle</returns>
+ /// <returns>The left edge of the rectangle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int Left()
{
int ret = NDalicPINVOKE.Rectangle_Left(swigCPtr);
/// <summary>
/// Gets the right of the rectangle.
/// </summary>
- /// <returns>The right edge of the rectangle</returns>
+ /// <returns>The right edge of the rectangle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int Right()
{
int ret = NDalicPINVOKE.Rectangle_Right(swigCPtr);
/// <summary>
/// Gets the top of the rectangle.
/// </summary>
- /// <returns>The top of the rectangle</returns>
+ /// <returns>The top of the rectangle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int Top()
{
int ret = NDalicPINVOKE.Rectangle_Top(swigCPtr);
/// <summary>
/// Gets the bottom of the rectangle.
/// </summary>
- /// <returns>The bottom of the rectangle</returns>
+ /// <returns>The bottom of the rectangle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int Bottom()
{
int ret = NDalicPINVOKE.Rectangle_Bottom(swigCPtr);
/// <summary>
/// Gets the area of the rectangle.
/// </summary>
- /// <returns>The area of the rectangle</returns>
+ /// <returns>The area of the rectangle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int Area()
{
int ret = NDalicPINVOKE.Rectangle_Area(swigCPtr);
/// <summary>
/// Determines whether or not this rectangle and the specified rectangle intersect.
/// </summary>
- /// <param name="other">The other rectangle to test against this rectangle</param>
- /// <returns>True if the rectangles intersect</returns>
+ /// <param name="other">The other rectangle to test against this rectangle.</param>
+ /// <returns>True if the rectangles intersect.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Intersects(Rectangle other)
{
bool ret = NDalicPINVOKE.Rectangle_Intersects(swigCPtr, Rectangle.getCPtr(other));
}
/// <summary>
- /// Determines whether or not this Rectangle contains the specified rectangle.
+ /// Determines whether or not this rectangle contains the specified rectangle.
/// </summary>
- /// <param name="other">The other rectangle to test against this rectangle</param>
- /// <returns>True if the specified rectangle is contained</returns>
+ /// <param name="other">The other rectangle to test against this rectangle.</param>
+ /// <returns>True if the specified rectangle is contained.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Contains(Rectangle other)
{
bool ret = NDalicPINVOKE.Rectangle_Contains(swigCPtr, Rectangle.getCPtr(other));
{
/// <summary>
- /// RelativeVector2 is a two dimensional vector.
- /// Both values(x and y) should be between [0, 1].
+ /// RelativeVector2 is a two-dimensional vector.
+ /// Both values (x and y) should be between [0, 1].
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RelativeVector2 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal RelativeVector2(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~RelativeVector2()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">The vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator +(RelativeVector2 arg1, RelativeVector2 arg2)
{
RelativeVector2 result = arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator -(RelativeVector2 arg1, RelativeVector2 arg2)
{
RelativeVector2 result = arg1.Subtract(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator *(RelativeVector2 arg1, RelativeVector2 arg2)
{
RelativeVector2 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator *(RelativeVector2 arg1, float arg2)
{
RelativeVector2 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator /(RelativeVector2 arg1, RelativeVector2 arg2)
{
RelativeVector2 result = arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector2 operator /(RelativeVector2 arg1, float arg2)
{
RelativeVector2 result = arg1.Divide(arg2);
/// <summary>
- /// Const array subscript operator overload. Should be 0, 1.
+ /// The const array subscript operator overload. Should be 0, 1.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="x">x component</param>
- /// <param name="y">y component</param>
+ /// <param name="x">The x component.</param>
+ /// <param name="y">The y component.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2(float x, float y) : this(NDalicPINVOKE.new_Vector2__SWIG_1(x, y), true)
{
ValueCheck(x);
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector3">RelativeVector3 to create this vector from</param>
+ /// <param name="relativeVector3">The RelativeVector3 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2(RelativeVector3 relativeVector3) : this(NDalicPINVOKE.new_Vector2__SWIG_3(RelativeVector3.getCPtr(relativeVector3)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector4">RelativeVector4 to create this vector from</param>
+ /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector2__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if the rhs is equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(RelativeVector2 rhs)
{
bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if the rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(RelativeVector2 rhs)
{
bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector2(RelativeVector2 relativeVector2)
{
return new Vector2(relativeVector2.X, relativeVector2.Y);
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator RelativeVector2(Vector2 vec)
{
ValueCheck(vec.X);
{
/// <summary>
- /// RelativeVector3 is a three dimensional vector.
- /// All values(x, y, z and w) should be between [0, 1].
+ /// RelativeVector3 is a three-dimensional vector.
+ /// All values (x, y, z and w) should be between [0, 1].
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RelativeVector3 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal RelativeVector3(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~RelativeVector3()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">Th vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator +(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator -(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Subtract(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator *(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator *(RelativeVector3 arg1, float arg2)
{
RelativeVector3 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator /(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector3 operator /(RelativeVector3 arg1, float arg2)
{
RelativeVector3 result = arg1.Divide(arg2);
/// <summary>
- /// Const array subscript operator overload. Should be 0, 1 or 2.
+ /// The const array subscript operator overload. Should be 0, 1 or 2.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector3() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="x">x component</param>
- /// <param name="y">y component</param>
- /// <param name="z">z component</param>
+ /// <param name="x">The x component.</param>
+ /// <param name="y">The y component.</param>
+ /// <param name="z">The z component.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector3(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
ValueCheck(x);
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector2">RelativeVector2 to create this vector from</param>
+ /// <param name="relativeVector2">The RelativeVector2 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector3(RelativeVector2 relativeVector2) : this(NDalicPINVOKE.new_Vector3__SWIG_3(RelativeVector2.getCPtr(relativeVector2)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector4">RelativeVector4 to create this vector from</param>
+ /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector3(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector3__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if the rhs is equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(RelativeVector3 rhs)
{
bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if the rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(RelativeVector3 rhs)
{
bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector3(RelativeVector3 relativeVector3)
{
return new Vector3(relativeVector3.X, relativeVector3.Y, relativeVector3.Z);
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator RelativeVector3(Vector3 vec)
{
ValueCheck(vec.X);
{
/// <summary>
- /// RelativeVector4 is a four dimensional vector.
- /// All values(x, y, and z) should be between [0, 1].
+ /// RelativeVector4 is a four-dimensional vector.
+ /// All values (x, y, and z) should be between [0, 1].
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RelativeVector4 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal RelativeVector4(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~RelativeVector4()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">The vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator +(RelativeVector4 arg1, RelativeVector4 arg2)
{
RelativeVector4 result = arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator -(RelativeVector4 arg1, RelativeVector4 arg2)
{
RelativeVector4 result = arg1.Subtract(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator *(RelativeVector4 arg1, RelativeVector4 arg2)
{
RelativeVector4 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator *(RelativeVector4 arg1, float arg2)
{
RelativeVector4 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator /(RelativeVector4 arg1, RelativeVector4 arg2)
{
RelativeVector4 result = arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static RelativeVector4 operator /(RelativeVector4 arg1, float arg2)
{
RelativeVector4 result = arg1.Divide(arg2);
/// <summary>
- /// Const array subscript operator overload. Should be 0, 1 3 or 3.
+ /// The const array subscript operator overload. Should be 0, 1 3 or 3.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4() : this(NDalicPINVOKE.new_Vector4__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="x">x component</param>
- /// <param name="y">y component</param>
- /// <param name="z">z component</param>
- /// <param name="w">w component</param>
+ /// <param name="x">The x component.</param>
+ /// <param name="y">The y component.</param>
+ /// <param name="z">The z component.</param>
+ /// <param name="w">The w component.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4(float x, float y, float z, float w) : this(NDalicPINVOKE.new_Vector4__SWIG_1(x, y, z, w), true)
{
ValueCheck(x);
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector2">RelativeVector2 to create this vector from</param>
+ /// <param name="relativeVector2">The RelativeVector2 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4(RelativeVector2 relativeVector2) : this(NDalicPINVOKE.new_Vector4__SWIG_3(RelativeVector2.getCPtr(relativeVector2)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector3">RelativeVector3 to create this vector from</param>
+ /// <param name="relativeVector3">The RelativeVector3 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4(RelativeVector3 relativeVector3) : this(NDalicPINVOKE.new_Vector4__SWIG_4(RelativeVector3.getCPtr(relativeVector3)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if the rhs is equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(RelativeVector4 rhs)
{
bool ret = NDalicPINVOKE.Vector4_EqualTo(swigCPtr, RelativeVector4.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if the rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(RelativeVector4 rhs)
{
bool ret = NDalicPINVOKE.Vector4_NotEqualTo(swigCPtr, RelativeVector4.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
}
/// <summary>
- /// w component
+ /// The w component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float W
{
set
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector4(RelativeVector4 relativeVector4)
{
return new Vector4(relativeVector4.X, relativeVector4.Y, relativeVector4.Z, relativeVector4.W);
/// <summary>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator RelativeVector4(Vector4 vec)
{
ValueCheck(vec.X);
}
}
-
}
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Interface to encapsulate information required for relayout.
+ /// An interface to encapsulate the information required for relayout.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RelayoutContainer : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal RelayoutContainer(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~RelayoutContainer()
{
if(!isDisposeQueued)
}
/// <summary>
- /// To make RelayoutContainer instance be disposed.
+ /// To make the RelayoutContainer instance be disposed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// Adds relayout information to the container if it doesn't already exist.
/// </summary>
- /// <param name="view">The view to relayout</param>
- /// <param name="size">The size to relayout</param>
+ /// <param name="view">The view to relayout.</param>
+ /// <param name="size">The size to relayout.</param>
+ /// <since_tizen> 3 </since_tizen>
public virtual void Add(View view, Size2D size)
{
NDalicPINVOKE.RelayoutContainer_Add(swigCPtr, View.getCPtr(view), Size2D.getCPtr(size));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Renderer : Animatable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
+ /// <summary>
+ /// Enumeration for instances of properties belonging to the Renderer class.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Property
{
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DEPTH_INDEX = NDalicPINVOKE.Renderer_Property_DEPTH_INDEX_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int FACE_CULLING_MODE = NDalicPINVOKE.Renderer_Property_FACE_CULLING_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_MODE = NDalicPINVOKE.Renderer_Property_BLEND_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_EQUATION_RGB = NDalicPINVOKE.Renderer_Property_BLEND_EQUATION_RGB_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_EQUATION_ALPHA = NDalicPINVOKE.Renderer_Property_BLEND_EQUATION_ALPHA_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_FACTOR_SRC_RGB = NDalicPINVOKE.Renderer_Property_BLEND_FACTOR_SRC_RGB_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_FACTOR_DEST_RGB = NDalicPINVOKE.Renderer_Property_BLEND_FACTOR_DEST_RGB_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_FACTOR_SRC_ALPHA = NDalicPINVOKE.Renderer_Property_BLEND_FACTOR_SRC_ALPHA_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_FACTOR_DEST_ALPHA = NDalicPINVOKE.Renderer_Property_BLEND_FACTOR_DEST_ALPHA_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_COLOR = NDalicPINVOKE.Renderer_Property_BLEND_COLOR_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int BLEND_PRE_MULTIPLIED_ALPHA = NDalicPINVOKE.Renderer_Property_BLEND_PRE_MULTIPLIED_ALPHA_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int INDEX_RANGE_FIRST = NDalicPINVOKE.Renderer_Property_INDEX_RANGE_FIRST_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int INDEX_RANGE_COUNT = NDalicPINVOKE.Renderer_Property_INDEX_RANGE_COUNT_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DEPTH_WRITE_MODE = NDalicPINVOKE.Renderer_Property_DEPTH_WRITE_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DEPTH_FUNCTION = NDalicPINVOKE.Renderer_Property_DEPTH_FUNCTION_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DEPTH_TEST_MODE = NDalicPINVOKE.Renderer_Property_DEPTH_TEST_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int RENDER_MODE = NDalicPINVOKE.Renderer_Property_RENDER_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_FUNCTION = NDalicPINVOKE.Renderer_Property_STENCIL_FUNCTION_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_FUNCTION_MASK = NDalicPINVOKE.Renderer_Property_STENCIL_FUNCTION_MASK_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_FUNCTION_REFERENCE = NDalicPINVOKE.Renderer_Property_STENCIL_FUNCTION_REFERENCE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_MASK = NDalicPINVOKE.Renderer_Property_STENCIL_MASK_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_OPERATION_ON_FAIL = NDalicPINVOKE.Renderer_Property_STENCIL_OPERATION_ON_FAIL_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_OPERATION_ON_Z_FAIL = NDalicPINVOKE.Renderer_Property_STENCIL_OPERATION_ON_Z_FAIL_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STENCIL_OPERATION_ON_Z_PASS = NDalicPINVOKE.Renderer_Property_STENCIL_OPERATION_ON_Z_PASS_get();
}
+ /// <summary>
+ /// Create an instance of Renderer.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Renderer(Geometry geometry, Shader shader) : this(NDalicPINVOKE.Renderer_New(Geometry.getCPtr(geometry), Shader.getCPtr(shader)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the geometry to be used by this renderer.
+ /// </summary>
+ /// <param name="geometry">The geometry to be used by this renderer.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetGeometry(Geometry geometry)
{
NDalicPINVOKE.Renderer_SetGeometry(swigCPtr, Geometry.getCPtr(geometry));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the geometry used by this renderer.
+ /// </summary>
+ /// <returns>The geometry used by the renderer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Geometry GetGeometry()
{
System.IntPtr cPtr = NDalicPINVOKE.Renderer_GetGeometry(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets effective range of indices to draw from bound index buffer.
+ /// </summary>
+ /// <param name="firstElement">The First element to draw.</param>
+ /// <param name="elementsCount">The number of elements to draw.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetIndexRange(int firstElement, int elementsCount)
{
NDalicPINVOKE.Renderer_SetIndexRange(swigCPtr, firstElement, elementsCount);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the texture set to be used by this renderer.
+ /// </summary>
+ /// <param name="textureSet">The texture set to be used by this renderer.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetTextures(TextureSet textureSet)
{
NDalicPINVOKE.Renderer_SetTextures(swigCPtr, TextureSet.getCPtr(textureSet));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the texture set used by this renderer.
+ /// </summary>
+ /// <returns>The texture set used by the renderer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public TextureSet GetTextures()
{
System.IntPtr cPtr = NDalicPINVOKE.Renderer_GetTextures(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the shader used by this renderer.
+ /// </summary>
+ /// <param name="shader">The shader to be used by this renderer.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetShader(Shader shader)
{
NDalicPINVOKE.Renderer_SetShader(swigCPtr, Shader.getCPtr(shader));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the shader used by this renderer.
+ /// </summary>
+ /// <returns>The shader used by the renderer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Shader GetShader()
{
System.IntPtr cPtr = NDalicPINVOKE.Renderer_GetShader(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Gets and Sets DepthIndex property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthIndex
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.DEPTH_INDEX, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets FaceCullingMode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int FaceCullingMode
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.FACE_CULLING_MODE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendMode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendMode
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_MODE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendEquationRgb.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendEquationRgb
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_EQUATION_RGB, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendEquationAlpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendEquationAlpha
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_EQUATION_ALPHA, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendFactorSrcRgb.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendFactorSrcRgb
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_FACTOR_SRC_RGB, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendFactorDestRgb.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendFactorDestRgb
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_FACTOR_DEST_RGB, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendFactorSrcAlpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendFactorSrcAlpha
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_FACTOR_SRC_ALPHA, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendFactorDestAlpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int BlendFactorDestAlpha
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_FACTOR_DEST_ALPHA, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendColor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 BlendColor
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_COLOR, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets BlendPreMultipliedAlpha.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BlendPreMultipliedAlpha
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.BLEND_PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets IndexRangeFirst.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int IndexRangeFirst
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.INDEX_RANGE_FIRST, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets IndexRangeCount.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int IndexRangeCount
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.INDEX_RANGE_COUNT, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets DepthWriteMode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthWriteMode
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.DEPTH_WRITE_MODE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets DepthFunction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthFunction
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.DEPTH_FUNCTION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets DepthTestMode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthTestMode
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.DEPTH_TEST_MODE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets RenderMode.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int RenderMode
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.RENDER_MODE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilFunction.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilFunction
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_FUNCTION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilFunctionMask.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilFunctionMask
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_FUNCTION_MASK, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilFunctionReference.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilFunctionReference
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_FUNCTION_REFERENCE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilMask.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilMask
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_MASK, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilOperationOnFail.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilOperationOnFail
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_OPERATION_ON_FAIL, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilOperationOnZFail.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilOperationOnZFail
{
get
Tizen.NUI.Object.SetProperty(swigCPtr, Renderer.Property.STENCIL_OPERATION_ON_Z_FAIL, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets StencilOperationOnZPass property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StencilOperationOnZPass
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// Rotation Class
+ /// The Rotation class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Rotation : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Rotation(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Rotation()
{
if(!isDisposeQueued)
}
/// <summary>
- /// To make Rotation instance be disposed.
+ /// To make the Rotation instance be disposed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">First Rotation</param>
- /// <param name="arg2">Second Rotation</param>
- /// <returns>A Rotation containing the result of the Addition</returns>
+ /// <param name="arg1">The first rotation.</param>
+ /// <param name="arg2">The second rotation.</param>
+ /// <returns>The rotation containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator +(Rotation arg1, Rotation arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">First Rotation</param>
- /// <param name="arg2">Second Rotation</param>
- /// <returns>A Rotation containing the result of the subtract</returns>
+ /// <param name="arg1">The first rotation.</param>
+ /// <param name="arg2">The second rotation.</param>
+ /// <returns>The rotation containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator -(Rotation arg1, Rotation arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary Negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">First Rotation</param>
- /// <returns>A Rotation containing the negated result</returns>
+ /// <param name="arg1">The first rotation.</param>
+ /// <returns>The rotation containing the negated result.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator -(Rotation arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Rotation</param>
- /// <param name="arg2">Second Rotation</param>
- /// <returns>A Rotation containing the result of the Multiplication</returns>
+ /// <param name="arg1">The first rotation.</param>
+ /// <param name="arg2">The second rotation.</param>
+ /// <returns>The rotation containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator *(Rotation arg1, Rotation arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Rotation</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A Rotation containing the result of the multiplication</returns>
+ /// <param name="arg1">Rotation.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The rotation containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator *(Rotation arg1, Vector3 arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Scale operator.
+ /// The scale operator.
/// </summary>
- /// <param name="arg1">Rotation</param>
- /// <param name="arg2">A value to scale by</param>
- /// <returns>A Rotation containing the result of the scaling</returns>
+ /// <param name="arg1">Rotation.</param>
+ /// <param name="arg2">A value to scale by.</param>
+ /// <returns>The rotation containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator *(Rotation arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Rotation</param>
- /// <param name="arg2">Second Rotation</param>
- /// <returns>A Rotation containing the result of the scaling</returns>
+ /// <param name="arg1">The first rotation.</param>
+ /// <param name="arg2">The second rotation.</param>
+ /// <returns>The rotation containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator /(Rotation arg1, Rotation arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Scale operator.
+ /// The scale operator.
/// </summary>
- /// <param name="arg1">Rotation</param>
- /// <param name="arg2">A value to scale by</param>
- /// <returns>A Rotation containing the result of the scaling</returns>
+ /// <param name="arg1">Rotation.</param>
+ /// <param name="arg2">A value to scale by.</param>
+ /// <returns>The rotation containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation operator /(Rotation arg1, float arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Default Constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rotation() : this(NDalicPINVOKE.new_Rotation__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor from an axis and angle.
+ /// The constructor from an axis and angle.
/// </summary>
- /// <param name="angle">The angle around the axis</param>
- /// <param name="axis">The vector of the axis</param>
+ /// <param name="angle">The angle around the axis.</param>
+ /// <param name="axis">The vector of the axis.</param>
+ /// <since_tizen> 3 </since_tizen>
public Rotation(Radian angle, Vector3 axis) : this(NDalicPINVOKE.new_Rotation__SWIG_1(Radian.getCPtr(angle), Vector3.getCPtr(axis)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// (0.0f,0.0f,0.0f,1.0f)
+ /// (0.0f,0.0f,0.0f,1.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation IDENTITY
{
get
/// <summary>
/// Helper to check if this is an identity quaternion.
/// </summary>
- /// <returns>True if this is identity quaternion</returns>
+ /// <returns>True if this is identity quaternion.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsIdentity()
{
bool ret = NDalicPINVOKE.Rotation_IsIdentity(swigCPtr);
}
/// <summary>
- /// Converts the quaternion to an axis/angle pair.
+ /// Converts the quaternion to an axis or angle pair.
/// </summary>
- /// <param name="axis">the result of axis</param>
- /// <param name="angle">the result of angle Angle in radians</param>
- /// <returns>True if converted correctly</returns>
+ /// <param name="axis">The result of an an axis.</param>
+ /// <param name="angle">The result of angle in radians.</param>
+ /// <returns>True if converted correctly.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GetAxisAngle(Vector3 axis, Radian angle)
{
bool ret = NDalicPINVOKE.Rotation_GetAxisAngle(swigCPtr, Vector3.getCPtr(axis), Radian.getCPtr(angle));
}
/// <summary>
- /// Returns the length of the rotation
+ /// Returns the length of the rotation.
/// </summary>
- /// <returns>The length of the rotation</returns>
+ /// <returns>The length of the rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float Length()
{
float ret = NDalicPINVOKE.Rotation_Length(swigCPtr);
}
/// <summary>
- /// Returns the squared length of the rotation
+ /// Returns the squared length of the rotation.
/// </summary>
- /// <returns>The squared length of the rotation</returns>
+ /// <returns>The squared length of the rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float LengthSquared()
{
float ret = NDalicPINVOKE.Rotation_LengthSquared(swigCPtr);
/// <summary>
/// Normalizes this to unit length.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Normalize()
{
NDalicPINVOKE.Rotation_Normalize(swigCPtr);
/// <summary>
/// Normalized.
/// </summary>
- /// <returns>A normalized version of this rotation</returns>
+ /// <returns>A normalized version of this rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Rotation Normalized()
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Normalized(swigCPtr), true);
/// <summary>
/// Conjugates this rotation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Conjugate()
{
NDalicPINVOKE.Rotation_Conjugate(swigCPtr);
/// <summary>
/// Inverts this rotation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Invert()
{
NDalicPINVOKE.Rotation_Invert(swigCPtr);
}
/// <summary>
- /// Performs the logarithm of a rotation
+ /// Performs the logarithm of a rotation.
/// </summary>
- /// <returns>A rotation representing the logarithm</returns>
+ /// <returns>The rotation representing the logarithm.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Rotation Log()
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Log(swigCPtr), true);
}
/// <summary>
- /// Performs an exponent
+ /// Performs an exponent.
/// </summary>
- /// <returns>A rotation representing the exponent</returns>
+ /// <returns>The rotation representing the exponent.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Rotation Exp()
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Exp(swigCPtr), true);
/// <summary>
/// Returns the dot product of two rotations.
/// </summary>
- /// <param name="q1">The first rotation</param>
- /// <param name="q2">The second rotation</param>
- /// <returns>The dot product of the two rotations</returns>
+ /// <param name="q1">The first rotation.</param>
+ /// <param name="q2">The second rotation.</param>
+ /// <returns>The dot product of the two rotations.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static float Dot(Rotation q1, Rotation q2)
{
float ret = NDalicPINVOKE.Rotation_Dot(Rotation.getCPtr(q1), Rotation.getCPtr(q2));
}
/// <summary>
- /// Linear Interpolation (using a straight line between the two rotations).
+ /// The linear iterpolation (using a straight line between the two rotations).
/// </summary>
- /// <param name="q1">The start rotation</param>
- /// <param name="q2">The end rotation</param>
- /// <param name="t">A progress value between 0 and 1</param>
- /// <returns>The interpolated rotation</returns>
+ /// <param name="q1">The start rotation.</param>
+ /// <param name="q2">The end rotation.</param>
+ /// <param name="t">A progress value between 0 and 1.</param>
+ /// <returns>The interpolated rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation Lerp(Rotation q1, Rotation q2, float t)
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Lerp(Rotation.getCPtr(q1), Rotation.getCPtr(q2), t), true);
}
/// <summary>
- /// Spherical Linear Interpolation (using the shortest arc of a great circle between the two rotations).
+ /// The spherical linear interpolation (using the shortest arc of a great circle between the two rotations).
/// </summary>
- /// <param name="q1">The start rotation</param>
- /// <param name="q2">The end rotation</param>
- /// <param name="progress">A progress value between 0 and 1</param>
- /// <returns>The interpolated rotation</returns>
+ /// <param name="q1">The start rotation.</param>
+ /// <param name="q2">The end rotation.</param>
+ /// <param name="progress">A progress value between 0 and 1.</param>
+ /// <returns>The interpolated rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation Slerp(Rotation q1, Rotation q2, float progress)
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Slerp(Rotation.getCPtr(q1), Rotation.getCPtr(q2), progress), true);
}
/// <summary>
- /// This version of Slerp, used by Squad, does not check for theta > 90.
+ /// This version of slerp, used by squad, does not check for theta > 90.
/// </summary>
- /// <param name="q1">The start rotation</param>
- /// <param name="q2">The end rotation</param>
- /// <param name="t">A progress value between 0 and 1</param>
- /// <returns>The interpolated rotation</returns>
+ /// <param name="q1">The start rotation.</param>
+ /// <param name="q2">The end rotation.</param>
+ /// <param name="t">A progress value between 0 and 1.</param>
+ /// <returns>The interpolated rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation SlerpNoInvert(Rotation q1, Rotation q2, float t)
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_SlerpNoInvert(Rotation.getCPtr(q1), Rotation.getCPtr(q2), t), true);
}
/// <summary>
- /// Spherical Cubic Interpolation.
+ /// The spherical cubic interpolation.
/// </summary>
- /// <param name="start">The start rotation</param>
- /// <param name="end">The end rotation</param>
- /// <param name="ctrl1">The control rotation for q1</param>
- /// <param name="ctrl2">The control rotation for q2</param>
- /// <param name="t">A progress value between 0 and 1</param>
- /// <returns>The interpolated rotation</returns>
+ /// <param name="start">The start rotation.</param>
+ /// <param name="end">The end rotation.</param>
+ /// <param name="ctrl1">The control rotation for q1.</param>
+ /// <param name="ctrl2">The control rotation for q2.</param>
+ /// <param name="t">A progress value between 0 and 1.</param>
+ /// <returns>The interpolated rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Rotation Squad(Rotation start, Rotation end, Rotation ctrl1, Rotation ctrl2, float t)
{
Rotation ret = new Rotation(NDalicPINVOKE.Rotation_Squad(Rotation.getCPtr(start), Rotation.getCPtr(end), Rotation.getCPtr(ctrl1), Rotation.getCPtr(ctrl2), t), true);
}
/// <summary>
- /// Returns the shortest angle between two rotations in Radians.
+ /// Returns the shortest angle between two rotations in radians.
/// </summary>
- /// <param name="q1">The first rotation</param>
- /// <param name="q2">The second rotation</param>
- /// <returns>The angle between the two rotation</returns>
+ /// <param name="q1">The first rotation.</param>
+ /// <param name="q2">The second rotation.</param>
+ /// <returns>The angle between the two rotation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static float AngleBetween(Rotation q1, Rotation q2)
{
float ret = NDalicPINVOKE.Rotation_AngleBetween(Rotation.getCPtr(q1), Rotation.getCPtr(q2));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Sampler : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Create an instance of Sampler.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Sampler() : this(NDalicPINVOKE.Sampler_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the filter modes for this sampler.
+ /// </summary>
+ /// <param name="minFilter">The minification filter that will be used.</param>
+ /// <param name="magFilter">The magnification filter that will be used.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFilterMode(FilterModeType minFilter, FilterModeType magFilter)
{
NDalicPINVOKE.Sampler_SetFilterMode(swigCPtr, (int)minFilter, (int)magFilter);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the wrap modes for this sampler.
+ /// </summary>
+ /// <param name="uWrap">Wrap mode for u coordinates.</param>
+ /// <param name="vWrap">Wrap mode for v coordinates.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWrapMode(WrapModeType uWrap, WrapModeType vWrap)
{
NDalicPINVOKE.Sampler_SetWrapMode__SWIG_0(swigCPtr, (int)uWrap, (int)vWrap);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the wrap modes for this sampler.
+ /// </summary>
+ /// <param name="rWrap">Wrap mode for the x direction.</param>
+ /// <param name="sWrap">Wrap mode for the y direction.</param>
+ /// <param name="tWrap">Wrap mode for the z direction.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWrapMode(WrapModeType rWrap, WrapModeType sWrap, WrapModeType tWrap)
{
NDalicPINVOKE.Sampler_SetWrapMode__SWIG_1(swigCPtr, (int)rWrap, (int)sWrap, (int)tWrap);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// ScrollView Effect base class, used to apply custom effects to a
+ /// ScrollView instance.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ScrollViewEffect : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// The constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ScrollViewEffect() : this(NDalicPINVOKE.new_ScrollViewEffect(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// Shader.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Shader : Animatable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Hint.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Hint
{
+ /// <summary>
+ /// Enumeration for the hint value.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Value
{
+ /// <summary>
+ /// No hints.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NONE = 0x00,
+
+ /// <summary>
+ /// Might generate transparent alpha from opaque inputs
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
OUTPUT_IS_TRANSPARENT = 0x01,
+
+ /// <summary>
+ /// Might change position of vertices, this option disables any culling optimizations
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
MODIFIES_GEOMETRY = 0x02
}
}
+ /// <summary>
+ /// Enumeration for instances of properties belonging to the Shader class.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Property
{
+ /// <summary>
+ /// The default value is empty.
+ /// Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PROGRAM = NDalicPINVOKE.Shader_Property_PROGRAM_get();
}
+ /// <summary>
+ /// Creates Shader object.
+ /// </summary>
+ /// <param name="vertexShader">The vertex shader code for the effect.</param>
+ /// <param name="fragmentShader">The fragment Shader code for the effect.</param>
+ /// <param name="hints">The hints to define the geometry of the rendered object.</param>
+ /// <since_tizen> 3 </since_tizen>
public Shader(string vertexShader, string fragmentShader, Shader.Hint.Value hints) : this(NDalicPINVOKE.Shader_New__SWIG_0(vertexShader, fragmentShader, (int)hints), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+
+ /// <summary>
+ /// Creates Shader object.
+ /// </summary>
+ /// <param name="vertexShader">The vertex shader code for the effect.</param>
+ /// <param name="fragmentShader">The fragment Shader code for the effect.</param>
+ /// <since_tizen> 3 </since_tizen>
public Shader(string vertexShader, string fragmentShader) : this(NDalicPINVOKE.Shader_New__SWIG_1(vertexShader, fragmentShader), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+
+ /// <summary>
+ /// Gets and Sets the program property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Program
{
get
{
/// <summary>
- /// A two dimensional size
+ /// A two-dimensional size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Size2D : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Size2D(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Size2D()
{
if(!isDisposeQueued)
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator for A+B
+ /// The addition operator for A+B.
/// </summary>
- /// <param name="arg1">Size, A</param>
- /// <param name="arg2">Size to assign, B</param>
- /// <returns>A Size containing the result of the addition</returns>
+ /// <param name="arg1">Size A.</param>
+ /// <param name="arg2">Size to assign B.</param>
+ /// <returns>A size containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator +(Size2D arg1, Size2D arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator for A-B
+ /// The subtraction operator for A-B.
/// </summary>
- /// <param name="arg1">Size, A</param>
- /// <param name="arg2">Size to subtract, B</param>
- /// <returns>A Size containing the result of the subtraction</returns>
+ /// <param name="arg1">Size A.</param>
+ /// <param name="arg2">Size to subtract B.</param>
+ /// <returns>A size containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator -(Size2D arg1, Size2D arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Size for unary negation</param>
- /// <returns>A Size containg the negation</returns>
+ /// <param name="arg1">Size for unary negation.</param>
+ /// <returns>A size containing the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator -(Size2D arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">Size for multiplication</param>
- /// <param name="arg2">The Size to multipl</param>
- /// <returns>A Size containing the result of the multiplication</returns>
+ /// <param name="arg1">Size for multiplication.</param>
+ /// <param name="arg2">Size to multiply.</param>
+ /// <returns>A size containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator *(Size2D arg1, Size2D arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
/// <param name="arg1">Size for multiplication</param>
- /// <param name="arg2">The int value to scale the Size</param>
- /// <returns>A Size containing the result of the scaling</returns>
+ /// <param name="arg2">The integer value to scale the size.</param>
+ /// <returns>A size containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator *(Size2D arg1, int arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Size for division</param>
- /// <param name="arg2">The Size to divide</param>
- /// <returns>A Size containing the result of the division></returns>
+ /// <param name="arg1">Size for division.</param>
+ /// <param name="arg2">Size to divide.</param>
+ /// <returns>A size containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator /(Size2D arg1, Size2D arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">Size for division</param>
- /// <param name="arg2">The int value to scale the Size by</param>
- /// <returns>A Size containing the result of the scaling</returns>
+ /// <param name="arg1">Size for division.</param>
+ /// <param name="arg2">The integer value to scale the size by.</param>
+ /// <returns>A size containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Size2D operator /(Size2D arg1, int arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator.
+ /// The array subscript operator.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Get Size from pointer.
+ /// Gets the size from the pointer.
/// </summary>
- /// <param name="cPtr">Pointer of the Size</param>
+ /// <param name="cPtr">The pointer of the size.</param>
/// <returns>Size</returns>
internal static Size2D GetSize2DFromPtr(global::System.IntPtr cPtr)
{
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="x">x (or width) component</param>
- /// <param name="y">y (or height) component</param>
+ /// <param name="x">The x (or width) component.</param>
+ /// <param name="y">The y (or height) component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Size2D(int x, int y) : this(NDalicPINVOKE.new_Vector2__SWIG_1((float)x, (float)y), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Check equality.<br>
- /// Utilizes appropriate machine epsilon values.<br>
+ /// Checks equality.<br />
+ /// Utilizes appropriate machine epsilon values.<br />
/// </summary>
- /// <param name="rhs">The Size to test against</param>
- /// <returns>True if the Sizes are equal</returns>
+ /// <param name="rhs">The size to test against.</param>
+ /// <returns>True if the sizes are equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Size2D rhs)
{
bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, Size2D.getCPtr(rhs));
}
/// <summary>
- /// Check inequality.<br>
- /// Utilizes appropriate machine epsilon values.<br>
+ /// Checks inequality.<br />
+ /// Utilizes appropriate machine epsilon values.<br />
/// </summary>
- /// <param name="rhs">The Size to test against</param>
- /// <returns>True if the Sizes are not equal</returns>
+ /// <param name="rhs">The size to test against.</param>
+ /// <returns>True if the sizes are not equal.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Size2D rhs)
{
bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, Size2D.getCPtr(rhs));
}
/// <summary>
- /// Property for width component of Size
+ /// The property for the width component of a size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Width
{
set
}
/// <summary>
- /// Property for height component of Size
+ /// The property for the height component of a size.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Height
{
set
}
/// <summary>
- /// Type cast operator, Size2D to Vector2.
+ /// The type cast operator, Size2D to Vector2.
/// </summary>
- /// <param name="size">Object of Size2D type</param>
+ /// <param name="size">An object of the Size2D type.</param>
+ /// <returns>return a Vector2 instance</returns>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector2(Size2D size)
{
return new Vector2((float)size.Width, (float)size.Height);
}
/// <summary>
- /// Type cast operator, Vector2 to Size2D type.
+ /// The type cast operator, Vector2 to Size2D type.
/// </summary>
- /// <param name="vec">Object of Vector2 type</param>
+ /// <param name="vector2">An object of the Vector2 type.</param>
+ /// <returns>return a Size2D instance</returns>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Size2D(Vector2 vec)
{
return new Size2D((int)vec.X, (int)vec.Y);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using Tizen.NUI.BaseComponents;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
- using System;
- using System.Runtime.InteropServices;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// StyleManager informs applications of system theme change, and supports application theme change at runtime.<br>
- /// Applies various styles to Controls using the properties system.<br>
- /// On theme change, it automatically updates all controls, then raises a event to inform the application.<br>
- /// If the application wants to customize the theme, RequestThemeChange needs to be called.<br>
- /// It provides the path to the application resource root folder, from there the filename can an be specified along with any sub folders, e.g Images, Models etc.<br>
+ /// The StyleManager informs applications of the system theme change, and supports application theme change at runtime.<br />
+ /// Applies various styles to controls using the properties system.<br />
+ /// On theme change, it automatically updates all controls, then raises a event to inform the application.<br />
+ /// If the application wants to customize the theme, RequestThemeChange needs to be called.<br />
+ /// It provides the path to the application resource root folder, from there the filename can be specified along with any subfolders, for example, Images, Models, etc.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StyleManager : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// </summary>
protected override void Dispose(DisposeTypes type)
{
- if(disposed)
+ if (disposed)
{
return;
}
- if(type == DisposeTypes.Explicit)
+ if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
}
/// <summary>
- /// Style changed event arguments
+ /// Style changed event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StyleChangedEventArgs : EventArgs
{
private StyleManager _styleManager;
/// <summary>
/// StyleManager.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public StyleManager StyleManager
{
get
}
/// <summary>
- /// StyleChange - contains Style change information (default font changed or
- /// default font size changed or theme has changed).<br>
+ /// StyleChange - contains the style change information (default font changed or
+ /// default font size changed or theme has changed).<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public StyleChangeType StyleChange
{
get
private StyleChangedCallbackDelegate _styleManagerStyleChangedCallbackDelegate;
/// <summary>
- /// Event for StyleChanged signal which can be used to subscribe/unsubscribe the
- /// event handler provided by the user.<br>
- /// StyleChanged signal is is emitted after the style (e.g. theme/font change) has changed
- /// and the controls have been informed.<br>
+ /// An event for the StyleChanged signal which can be used to subscribe or unsubscribe the
+ /// event handler provided by the user.<br />
+ /// The StyleChanged signal is emitted after the style (for example, theme or font change) has changed
+ /// and the controls have been informed.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<StyleChangedEventArgs> StyleChanged
{
add
}
/// <summary>
- /// Creates a StyleManager handle.<br>
- /// this can be initialized with StyleManager::Get().<br>
+ /// Creates a StyleManager handle.<br />
+ /// This can be initialized with StyleManager::Get().<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public StyleManager() : this(NDalicPINVOKE.new_StyleManager(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Gets the singleton of StyleManager object.
/// </summary>
- /// <returns>A handle to the StyleManager control</returns>
+ /// <returns>A handle to the StyleManager control.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static StyleManager Get()
{
StyleManager ret = new StyleManager(NDalicPINVOKE.StyleManager_Get(), true);
}
/// <summary>
- /// Applies a new theme to the application. <br>
- /// This will be merged on top of the default Toolkit theme.<br>
+ /// Applies a new theme to the application.<br />
+ /// This will be merged on the top of the default Toolkit theme.<br />
/// If the application theme file doesn't style all controls that the
/// application uses, then the default Toolkit theme will be used
- /// instead for those controls.<br>
+ /// instead for those controls.<br />
/// </summary>
- /// <param name="themeFile">A relative path is specified for style theme</param>
+ /// <param name="themeFile">A relative path is specified for style theme.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ApplyTheme(string themeFile)
{
NDalicPINVOKE.StyleManager_ApplyTheme(swigCPtr, themeFile);
/// <summary>
/// Applies the default Toolkit theme.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void ApplyDefaultTheme()
{
NDalicPINVOKE.StyleManager_ApplyDefaultTheme(swigCPtr);
/// <summary>
/// Sets a constant for use when building styles.
/// </summary>
- /// <param name="key">The key of the constant</param>
- /// <param name="value">The value of the constant</param>
+ /// <param name="key">The key of the constant.</param>
+ /// <param name="value">The value of the constant.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddConstant(string key, PropertyValue value)
{
NDalicPINVOKE.StyleManager_SetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(value));
/// <summary>
/// Returns the style constant set for a specific key.
/// </summary>
- /// <param name="key">The key of the constant</param>
- /// <param name="valueOut">The value of the constant if it exists</param>
+ /// <param name="key">The key of the constant.</param>
+ /// <param name="valueOut">The value of the constant if it exists.</param>
/// <returns></returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GetConstant(string key, PropertyValue valueOut)
{
bool ret = NDalicPINVOKE.StyleManager_GetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(valueOut));
/// <summary>
/// Applies the specified style to the control.
/// </summary>
- /// <param name="control">The control to which to apply the style</param>
- /// <param name="jsonFileName">The name of the JSON style file to apply</param>
- /// <param name="styleName">The name of the style within the JSON file to apply</param>
+ /// <param name="control">The control to which to apply the style.</param>
+ /// <param name="jsonFileName">The name of the JSON style file to apply.</param>
+ /// <param name="styleName">The name of the style within the JSON file to apply.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ApplyStyle(View control, string jsonFileName, string styleName)
{
NDalicPINVOKE.StyleManager_ApplyStyle(swigCPtr, View.getCPtr(control), jsonFileName, styleName);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI
{
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
- /// The Text-to-speech (TTS) Player.
+ /// The Text-to-speech (TTS) player.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TTSPlayer : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// Gets the singleton of the TtsPlayer for the given mode.
+ /// Gets the singleton of the TTS player for the given mode.
/// </summary>
- /// <param name="mode"> The mode of tts-player. </param>
- /// <returns> A handle of the Ttsplayer for the given mode. </returns>
+ /// <param name="mode"> The mode of TTS player.</param>
+ /// <returns> A handle of the TTS player for the given mode.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static TTSPlayer Get(TTSMode mode)
{
TTSPlayer ret = new TTSPlayer(NDalicManualPINVOKE.TtsPlayer_Get__SWIG_0((int)mode), true);
}
/// <summary>
- /// Gets the singleton of the TtsPlayer for the default mode..
+ /// Gets the singleton of the TTS player for the default mode.
/// </summary>
- /// <returns> A handle of the Ttsplayer for the default mode. </returns>
+ /// <returns> A handle of the TTS player for the default mode.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static TTSPlayer Get()
{
TTSPlayer ret = new TTSPlayer(NDalicManualPINVOKE.TtsPlayer_Get__SWIG_1(), true);
/// <summary>
/// Starts playing the audio data synthesized from the specified text.
/// </summary>
- /// <param name="text"> The text to play. </param>
- /// <remarks>The TtsPlayer needs to be initialized.</remarks>
+ /// <param name="text"> The text to play.</param>
+ /// <remarks>The TTS player needs to be initialized.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Play(string text)
{
NDalicManualPINVOKE.TtsPlayer_Play(swigCPtr, text);
/// <summary>
/// Stops playing the utterance.
/// </summary>
- /// <remarks>The TtsPlayer needs to be initialized.</remarks>
+ /// <remarks>The TTS player needs to be initialized.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Stop()
{
NDalicManualPINVOKE.TtsPlayer_Stop(swigCPtr);
/// <summary>
/// Pauses the currently playing utterance.
/// </summary>
- /// <remarks>The TtsPlayer needs to be initialized.</remarks>
+ /// <remarks>The TTS player needs to be initialized.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Pause()
{
NDalicManualPINVOKE.TtsPlayer_Pause(swigCPtr);
/// <summary>
/// Resumes the previously paused utterance.
/// </summary>
- /// <remarks>The TtsPlayer needs to be initialized.</remarks>
+ /// <remarks>The TTS player needs to be initialized.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public void Resume()
{
NDalicManualPINVOKE.TtsPlayer_Resume(swigCPtr);
/// Gets the current state of the player.
/// </summary>
/// <returns> The current TTS state. </returns>
- /// <remarks>The TtsPlayer needs to be initialized.</remarks>
+ /// <remarks>The TTS player needs to be initialized.</remarks>
+ /// <since_tizen> 3 </since_tizen>
public TTSState GetState()
{
TTSState ret = (TTSState)NDalicManualPINVOKE.TtsPlayer_GetState(swigCPtr);
/// <summary>
/// State changed argument.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StateChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// PrevState.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TTSState PrevState
{
get;
set;
}
+ /// <summary>
+ /// NextState.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TTSState NextState
{
get;
/// <summary>
/// State changed event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<StateChangedEventArgs> StateChanged
{
add
/// <summary>
/// Enumeration for the instance of TTS mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TTSMode
{
/// <summary>
/// </summary>
Notification,
/// <summary>
- /// Screen reader mode. <br>
- /// To help visually impaired users interact with their devices, <br>
+ /// Screen reader mode. <br />
+ /// To help visually impaired users interact with their devices,<br />
/// screen reader reads text or graphic elements on the screen using the TTS engine.
/// </summary>
ScreenReader,
/// <summary>
- /// Number of Mode.
+ /// Number of mode.
/// </summary>
ModeNum
}
/// <summary>
/// Enumeration for the instance of TTS state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TTSState
{
/// <summary>
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
/// A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TapGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
/// <summary>
- /// Get TapGesture from the pointer.
+ /// Gets the TapGesture from the pointer.
/// </summary>
- /// <param name="cPtr">The pointer to cast</param>
- /// <returns>TapGesture object</returns>
+ /// <param name="cPtr">The pointer to cast.</param>
+ /// <returns>The TapGesture object.</returns>
internal static TapGesture GetTapGestureFromPtr(global::System.IntPtr cPtr)
{
TapGesture ret = new TapGesture(cPtr, false);
}
/// <summary>
- /// Number of taps property (read-only).
+ /// The number of taps property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint NumberOfTaps
{
get
}
/// <summary>
- /// Number of touches property (read-only).
+ /// The number of touches property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint NumberOfTouches
{
get
}
/// <summary>
- /// Screen point property (read-only).
+ /// The screen point property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScreenPoint
{
get
}
/// <summary>
- /// Local point property (read-only).
+ /// The local point property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 LocalPoint
{
get
/// <summary>
/// Creates a TapGesture.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TapGesture() : this(NDalicPINVOKE.new_TapGesture__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// Texture represents a texture object used as input or output by shaders.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Texture : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
+ /// <summary>
+ /// Creates a new Texture object.
+ /// </summary>
+ /// <param name="type">The type of the texture.</param>
+ /// <param name="format">The format of the pixel data.</param>
+ /// <param name="width">The width of the texture.</param>
+ /// <param name="height">The height of the texture.</param>
+ /// <since_tizen> 3 </since_tizen>
public Texture(TextureType type, PixelFormat format, uint width, uint height) : this(NDalicPINVOKE.Texture_New__SWIG_0((int)type, (int)format, width, height), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Uploads data to the texture from a PixelData object.
+ /// </summary>
+ /// <param name="pixelData">The pixelData object.</param>
+ /// <returns>True if the PixelData object has compatible pixel format and fits within the texture, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Upload(PixelData pixelData)
{
bool ret = NDalicPINVOKE.Texture_Upload__SWIG_0(swigCPtr, PixelData.getCPtr(pixelData));
return ret;
}
+ /// <summary>
+ /// Uploads data to the texture from a PixelData object.
+ /// </summary>
+ /// <param name="pixelData">The pixelData object.</param>
+ /// <param name="layer">The layer of a cube map or array texture.</param>
+ /// <param name="mipmap">The level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.</param>
+ /// <param name="xOffset">The horizontal offset of the rectangular area in the texture that will be updated.</param>
+ /// <param name="yOffset">The vertical offset of the rectangular area in the texture that will be updated.</param>
+ /// <param name="width">The width of the rectangular area in the texture that will be updated.</param>
+ /// <param name="height">height of the rectangular area in the texture that will be updated.</param>
+ /// <returns>True if the PixelData object has compatible pixel format and fits within the texture, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool Upload(PixelData pixelData, uint layer, uint mipmap, uint xOffset, uint yOffset, uint width, uint height)
{
bool ret = NDalicPINVOKE.Texture_Upload__SWIG_1(swigCPtr, PixelData.getCPtr(pixelData), layer, mipmap, xOffset, yOffset, width, height);
return ret;
}
+ /// <summary>
+ /// Generates mipmaps for the texture.<br />
+ /// This will auto generate all the mipmaps for the texture based on the data in the base level.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void GenerateMipmaps()
{
NDalicPINVOKE.Texture_GenerateMipmaps(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Returns the width of the texture.<br />
+ /// </summary>
+ /// <returns>The width, in pixels, of the texture.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetWidth()
{
uint ret = NDalicPINVOKE.Texture_GetWidth(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Returns the height of the texture..<br />
+ /// </summary>
+ /// <returns>The height, in pixels, of the texture.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetHeight()
{
uint ret = NDalicPINVOKE.Texture_GetHeight(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// TextureSet is a handle to an object that specifies the set of images used as textures by a renderer.<br />
+ /// The images have to be ordered in the same order they are declared in the shader.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextureSet : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Create an instance of TextureSet.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextureSet() : this(NDalicPINVOKE.TextureSet_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the texture at position "index".
+ /// </summary>
+ /// <param name="index">The position in the texture set of the texture.</param>
+ /// <param name="texture">The texture.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetTexture(uint index, Texture texture)
{
NDalicPINVOKE.TextureSet_SetTexture(swigCPtr, index, Texture.getCPtr(texture));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the image at position "index".
+ /// </summary>
+ /// <param name="index">The position in the texture set of the image.</param>
+ /// <returns>A handle to the image at the the specified position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Texture GetTexture(uint index)
{
System.IntPtr cPtr = NDalicPINVOKE.TextureSet_GetTexture(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Sets the sampler to be used by the image at position "index".
+ /// </summary>
+ /// <param name="index">The position in the texture set of the image.</param>
+ /// <param name="sampler">The sampler to use.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetSampler(uint index, Sampler sampler)
{
NDalicPINVOKE.TextureSet_SetSampler(swigCPtr, index, Sampler.getCPtr(sampler));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the sampler to be used by the image at position "index".
+ /// </summary>
+ /// <param name="index">The position in the texture set of the image.</param>
+ /// <returns>A handle to the sampler at the specified position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Sampler GetSampler(uint index)
{
System.IntPtr cPtr = NDalicPINVOKE.TextureSet_GetSampler(swigCPtr, index);
return ret;
}
+ /// <summary>
+ /// Gets the number of textures present in the TextureSet.
+ /// </summary>
+ /// <returns>The number of textures in the TextureSet.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetTextureCount()
{
uint ret = NDalicPINVOKE.TextureSet_GetTextureCount(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// The texture type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TextureType
{
+ /// <summary>
+ /// One 2D image
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TEXTURE_2D,
+ /// <summary>
+ /// Six 2D images arranged in a cube-shape
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
TEXTURE_CUBE
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
- using System;
- using System.Runtime.InteropServices;
-
/// <summary>
- /// Mechanism to issue simple periodic or one-shot events.<br>
+ /// Mechanism to issue simple periodic or one-shot events.<br />
/// Timer is provided for application developers to be able to issue
- /// simple periodic or one-shot events. Please note that timer
- /// callback functions should return as soon as possible, because they
- /// block the next SignalTick. Please note that timer signals are not
- /// in sync with Dali's render timer.<br>
+ /// simple periodic or one-shot events. Please note that the timer
+ /// callback functions should return as soon as possible because they
+ /// block the next SignalTick. Please note that timer signals are not
+ /// in sync with DALi's render timer.<br />
/// This class is a handle class so it can be stack allocated and used
- /// as a member.<br>
+ /// as a member.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Timer : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
/// <summary>
- /// Event arguments that passed via Tick event.
+ /// Event arguments that passed via the tick event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TickEventArgs : EventArgs
{
}
private TickCallbackDelegate _timerTickCallbackDelegate;
/// <summary>
- /// brief Event for Ticked signal which can be used to subscribe/unsubscribe the event handler
- /// (in the type of TickEventHandler-DaliEventHandlerWithReturnType<object,TickEventArgs,bool>).<br>
- /// provided by the user. Ticked signal is emitted after specified time interval.<br>
+ /// @brief Event for the ticked signal, which can be used to subscribe or unsubscribe the event handler
+ /// provided by the user. The ticked signal is emitted after specified time interval.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, TickEventArgs, bool> Tick
{
add
}
/// <summary>
- /// Creates a tick Timer that emits periodic signal.
+ /// Creates a tick timer that emits periodic signal.
/// </summary>
- /// <param name="milliSec">Interval in milliseconds</param>
- /// <returns>A new timer</returns>
+ /// <param name="milliSec">Interval in milliseconds.</param>
+ /// <returns>A new timer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Timer(uint milliSec) : this(NDalicPINVOKE.Timer_New(milliSec), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to Timer handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static Timer DownCast(BaseHandle handle)
{
Timer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Timer;
}
/// <summary>
- /// Starts timer.<br>
- /// In case a Timer is already running, its time is reset and timer is restarted.<br>
+ /// Starts the timer.<br />
+ /// In case a timer is already running, its time is reset and the timer is restarted.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Start()
{
NDalicPINVOKE.Timer_Start(swigCPtr);
}
/// <summary>
- /// Stops timer.
+ /// Stops the timer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Stop()
{
NDalicPINVOKE.Timer_Stop(swigCPtr);
/// <summary>
/// Gets/Sets the interval of the timer.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public uint Interval
{
get
}
/// <summary>
- /// Sets a new interval on the timer and starts the timer.<br>
- /// Cancels the previous timer.<br>
+ /// Sets a new interval on the timer and starts the timer.<br />
+ /// Cancels the previous timer.<br />
/// </summary>
- /// <param name="milliSec">milliSec Interval in milliseconds</param>
+ /// <param name="milliSec">MilliSec interval in milliseconds.</param>
internal void SetInterval(uint milliSec)
{
NDalicPINVOKE.Timer_SetInterval(swigCPtr, milliSec);
}
/// <summary>
- /// Tells whether timer is running.
+ /// Tells whether the timer is running.
/// </summary>
- /// <returns>Whether Timer is started or not</returns>
+ /// <returns>Whether the timer is started or not.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsRunning()
{
bool ret = NDalicPINVOKE.Timer_IsRunning(swigCPtr);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Touch events are a collection of points at a specific moment in time.<br>
+ /// Touch events are a collection of points at a specific moment in time.<br />
/// When a multi-touch event occurs, each point represents the points that are currently being
- /// touched or the points where a touch has stopped.<br>
+ /// touched or the points where a touch has stopped.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Touch : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// An uninitialized Touch instance.<br>
- /// Calling member functions with an uninitialized Touch handle is not allowed.<br>
+ /// An uninitialized touch instance.<br />
+ /// Calling member functions with an uninitialized touch handle is not allowed.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Touch() : this(NDalicPINVOKE.new_Touch__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Returns the time (in ms) that the touch event occurred.
/// </summary>
- /// <returns>The time (in ms) that the touch event occurred</returns>
+ /// <returns>The time (in ms) that the touch event occurred.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetTime()
{
uint ret = NDalicPINVOKE.Touch_GetTime(swigCPtr);
/// <summary>
/// Returns the total number of points in this TouchData.
/// </summary>
- /// <returns>Total number of Points</returns>
+ /// <returns>The total number of points.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetPointCount()
{
uint ret = NDalicPINVOKE.Touch_GetPointCount(swigCPtr);
}
/// <summary>
- /// Returns the ID of the device used for the Point specified.<br>
- /// Each point has a unique device ID which specifies the device used for that
- /// point. This is returned by this method.<br>
- /// If point is greater than GetPointCount() then this method will return -1.<br>
+ /// Returns the ID of the device used for the point specified.<br />
+ /// Each point has a unique device ID, which specifies the device used for that
+ /// point. This is returned by this method.<br />
+ /// If a point is greater than GetPointCount(), then this method will return -1.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The Device ID of this point</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The device ID of this point.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetDeviceId(uint point)
{
int ret = NDalicPINVOKE.Touch_GetDeviceId(swigCPtr, point);
}
/// <summary>
- /// Retrieves the State of the point specified.<br>
- /// If point is greater than GetPointCount() then this method will return PointState.Finished.<br>
+ /// Retrieves the state of the point specified.<br />
+ /// If a point is greater than GetPointCount(), then this method will return PointState.Finished.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The state of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The state of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PointStateType GetState(uint point)
{
PointStateType ret = (PointStateType)NDalicPINVOKE.Touch_GetState(swigCPtr, point);
}
/// <summary>
- /// Retrieves the actor that was underneath the point specified.<br>
- /// If point is greater than GetPointCount() then this method will return an empty handle.<br>
+ /// Retrieves the actor that was underneath the point specified.<br />
+ /// If a point is greater than GetPointCount(), then this method will return an empty handle.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The actor that was underneath the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The actor that was underneath the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetHitView(uint point)
{
global::System.IntPtr cPtr = NDalicPINVOKE.Touch_GetHitActor(swigCPtr, point);
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.<br>
- /// The top-left of an actor is (0.0, 0.0, 0.5).<br>
- /// If you require the local coordinates of another actor (e.g the parent of the hit actor),
- /// then you should use Actor::ScreenToLocal().<br>
- /// If point is greater than GetPointCount() then this method will return Vector2.Zero.<br>
+ /// Retrieves the coordinates relative to the top-left of the hit actor at the point specified.<br />
+ /// The top-left of an actor is (0.0, 0.0, 0.5).<br />
+ /// If you require the local coordinates of another actor (for example, the parent of the hit actor),
+ /// then you should use Actor::ScreenToLocal().<br />
+ /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the hit-actor of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the hit actor of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetLocalPosition(uint point)
{
Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetLocalPosition(swigCPtr, point), false);
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified.<br>
- /// If point is greater than GetPointCount() then this method will return Vector2.Zero.<br>
+ /// Retrieves the coordinates relative to the top-left of the screen of the point specified.<br />
+ /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the screen of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the screen of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetScreenPosition(uint point)
{
Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetScreenPosition(swigCPtr, point), false);
}
/// <summary>
- /// Retrieves the radius of the press point.<br>
- /// This is the average of both the horizontal and vertical radii of the press point.<br>
- /// If point is greater than GetPointCount() then this method will return 0.0f.<br>
+ /// Retrieves the radius of the press point.<br />
+ /// This is the average of both the horizontal and vertical radii of the press point.<br />
+ /// If point is greater than GetPointCount(), then this method will return 0.0f.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The radius of the press point</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The radius of the press point.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetRadius(uint point)
{
float ret = NDalicPINVOKE.Touch_GetRadius(swigCPtr, point);
}
/// <summary>
- /// Retrieves BOTH the horizontal and the vertical radii of the press point.<br>
- /// If point is greater than GetPointCount() then this method will return Vector2.Zero.<br>
+ /// Retrieves both the horizontal and the vertical radii of the press point.<br />
+ /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br />
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The horizontal and vertical radii of the press point</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The horizontal and vertical radii of the press point.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetEllipseRadius(uint point)
{
Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetEllipseRadius(swigCPtr, point), false);
}
/// <summary>
- /// Retrieves the touch pressure.<br>
- /// The pressure range starts at 0.0f.<br>
- /// Normal pressure is defined as 1.0f.<br>
- /// A value between 0.0f and 1.0f means light pressure has been applied.<br>
- /// A value greater than 1.0f means more pressure than normal has been applied.<br>
- /// If point is greater than GetPointCount() then this method will return 1.0f.<br>
+ /// Retrieves the touch pressure.<br />
+ /// The pressure range starts at 0.0f.<br />
+ /// Normal pressure is defined as 1.0f.<br />
+ /// A value between 0.0f and 1.0f means light pressure has been applied.<br />
+ /// A value greater than 1.0f means more pressure than normal has been applied.<br />
+ /// If point is greater than GetPointCount(), then this method will return 1.0f.<br />
/// </summary>
- /// <param name="point">point The point required</param>
- /// <returns>The touch pressure</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The touch pressure.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetPressure(uint point)
{
float ret = NDalicPINVOKE.Touch_GetPressure(swigCPtr, point);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// This object translates data from a property array of maps into an array of animators.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TransitionData : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
+ /// <summary>
+ /// Create an instance of TransitionData.
+ /// </summary>
+ /// <param name="transition">The transition data to store (a single animator).</param>
+ /// <since_tizen> 3 </since_tizen>
public TransitionData(PropertyMap transition) : this(NDalicPINVOKE.TransitionData_New__SWIG_0(PropertyMap.getCPtr(transition)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+
+ /// <summary>
+ /// Create an instance of TransitionData.
+ /// </summary>
+ /// <param name="transition">The transition data to store (an array of maps of animators).</param>
+ /// <since_tizen> 3 </since_tizen>
public TransitionData(PropertyArray transition) : this(NDalicPINVOKE.TransitionData_New__SWIG_1(PropertyArray.getCPtr(transition)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Create an instance of TransitionData by copy constructor.
+ /// </summary>
+ /// <param name="handle">Handle to an object.</param>
+ /// <since_tizen> 3 </since_tizen>
public TransitionData(TransitionData handle) : this(NDalicPINVOKE.new_TransitionData__SWIG_1(TransitionData.getCPtr(handle)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// returns the count of the individual property transitions stored within this handle.
+ /// </summary>
+ /// <returns>A handle to the image at the the specified position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint Count()
{
uint ret = NDalicPINVOKE.TransitionData_Count(swigCPtr);
return ret;
}
+ /// <summary>
+ /// returns the count of the individual property transitions stored within this handle.
+ /// </summary>
+ /// <param name="index">The index of the animator.</param>
+ /// <returns>A property map representing the animator.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap GetAnimatorAt(uint index)
{
PropertyMap ret = new PropertyMap(NDalicPINVOKE.TransitionData_GetAnimatorAt(swigCPtr, index), true);
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// TypeInfo class for instantiation of registered types and introspection of their actions and signals.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TypeInfo : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
-
+ /// <summary>
+ /// Creates TypeInfo object.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TypeInfo() : this(NDalicPINVOKE.new_TypeInfo__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Creates TypeInfo object.
+ /// </summary>
+ /// <param name="handle">This copy constructor is required for (smart) pointer semantics.</param>
+ /// <since_tizen> 3 </since_tizen>
public TypeInfo(TypeInfo handle) : this(NDalicPINVOKE.new_TypeInfo__SWIG_1(TypeInfo.getCPtr(handle)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Retrieves the type name for this type.
+ /// </summary>
+ /// <returns>The string name.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetName()
{
string ret = NDalicPINVOKE.TypeInfo_GetName(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Retrieves the type name for this type.
+ /// </summary>
+ /// <returns>The string name.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetBaseName()
{
string ret = NDalicPINVOKE.TypeInfo_GetBaseName(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Creates an object from this type.
+ /// </summary>
+ /// <returns>The BaseHandle for the newly created object.</returns>
+ /// <since_tizen> 3 </since_tizen>
public BaseHandle CreateInstance()
{
BaseHandle ret = new BaseHandle(NDalicPINVOKE.TypeInfo_CreateInstance(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Retrieves the number of event side type registered properties for this type.<br />
+ /// This count does not include all properties.
+ /// </summary>
+ /// <returns>The count.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetPropertyCount()
{
uint ret = NDalicPINVOKE.TypeInfo_GetPropertyCount(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Given a property index, retrieve the property name associated with it.
+ /// </summary>
+ /// <param name="index">The property index.</param>
+ /// <returns>The name of the property at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetPropertyName(int index)
{
string ret = NDalicPINVOKE.TypeInfo_GetPropertyName(swigCPtr, index);
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Button is a base class for different kinds of buttons.<br>
- /// This class provides the disabled property and the clicked signal.<br>
- /// A Clicked event handler is emitted when the button is touched and the touch point doesn't leave the boundary of the button.<br>
- /// When the disabled property is set to true, no signal is emitted.<br>
- /// 'Visual' describes not just traditional images like png, bmp but refers to whatever is used to show the button, it could be a color, gradient or some other kind of renderer.<br>
- /// The button's appearance can be modified by setting properties for the various visuals/images.<br>
- /// It is not mandatory to set all visuals. A button could be defined only by setting its background visual or by setting its background and selected visuals.<br>
- /// The button visual is shown over the background visual.<br>
- /// When pressed the unselected visuals are replaced by the selected visual.<br>
- /// The text label is always placed on the top of all images.<br>
- /// When the button is disabled, background, button and selected visuals are replaced by their disabled visuals.<br>
+ /// The Button class is a base class for different kinds of buttons.<br />
+ /// This class provides the disabled property and the clicked signal.<br />
+ /// The clicked event handler is emitted when the button is touched, and the touch point doesn't leave the boundary of the button.<br />
+ /// When the disabled property is set to true, no signal is emitted.<br />
+ /// The 'Visual' describes not just traditional images like PNG and BMP, but also refers to whatever is used to show the button. It could be a color, gradient, or some other kind of renderer.<br />
+ /// The button's appearance can be modified by setting properties for the various visuals or images.<br />
+ /// It is not mandatory to set all the visuals. A button could be defined only by setting its background visual, or by setting its background and selected visuals.<br />
+ /// The button visual is shown over the background visual.<br />
+ /// When pressed, the unselected visuals are replaced by the selected visuals.<br />
+ /// The text label is always placed on the top of all images.<br />
+ /// When the button is disabled, the background button and the selected visuals are replaced by their disabled visuals.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Button : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make Button instance be disposed.
+ /// To dispose the button instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
private ClickedCallbackType _clickedCallback;
/// <summary>
- /// Clicked will be triggered when the button is touched and the touch point doesn't leave the boundary of the button.
+ /// The Clicked event will be triggered when the button is touched and the touch point doesn't leave the boundary of the button.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, EventArgs, bool> Clicked
{
add
private PressedCallbackType _pressedCallback;
/// <summary>
- /// Pressed will be triggered when the button is touched.
+ /// The Pressed event will be triggered when the button is touched.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, EventArgs, bool> Pressed
{
add
private ReleasedCallbackType _releasedCallback;
/// <summary>
- /// Released will be triggered when the button is touched and the touch point leaves the boundary of the button.
+ /// The Released event will be triggered when the button is touched and the touch point leaves the boundary of the button.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, EventArgs, bool> Released
{
add
private StateChangedCallback _stateChangedCallback;
/// <summary>
- /// StateChanged will be triggered when the button's state is changed.
+ /// The StateChanged event will be triggered when the button's state is changed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, EventArgs, bool> StateChanged
{
add
/// <summary>
- /// Gets/Sets the unselected button foreground/icon visual
+ /// Gets or sets the unselected button foreground or icon visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap UnselectedVisual
{
get
}
/// <summary>
- /// Gets/Sets the selected button foreground/icon visual
+ /// Gets or sets the selected button foreground or icon visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap SelectedVisual
{
get
}
/// <summary>
- /// Gets/Sets the disabled selected state foreground/icon button visual
+ /// Gets or sets the disabled selected state foreground or icon button visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap DisabledSelectedVisual
{
get
}
/// <summary>
- /// Gets/Sets the disabled unselected state foreground/icon visual
+ /// Gets or sets the disabled unselected state foreground or icon visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap DisabledUnselectedVisual
{
get
}
/// <summary>
- /// Gets/Sets the disabled in the unselected state background, button visual
+ /// Gets or sets the disabled unselected state background button visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap UnselectedBackgroundVisual
{
get
}
/// <summary>
- /// Gets/Sets the selected background button visual
+ /// Gets or sets the selected background button visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap SelectedBackgroundVisual
{
get
}
/// <summary>
- /// Gets/Sets the disabled while unselected background button visual
+ /// Gets or sets the disabled while unselected background button visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap DisabledUnselectedBackgroundVisual
{
get
}
/// <summary>
- /// Gets/Sets the disabled while selected background button visual
+ /// Gets or sets the disabled while selected background button visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap DisabledSelectedBackgroundVisual
{
get
}
/// <summary>
- /// Gets/Sets the position of the the label in relation to the foreground/icon if both present
+ /// Gets or sets the position of the the label in relation to the foreground or icon, if both present.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Align LabelRelativeAlignment
{
get
}
/// <summary>
- /// Gets/Sets the padding around the text
+ /// Gets or sets the padding around the text.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 LabelPadding
{
get
}
/// <summary>
- /// Gets/Sets the padding around the foreground visual
+ /// Gets or sets the padding around the foreground visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 ForegroundVisualPadding
{
get
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int UNSELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_UNSELECTED_VISUAL_get();
internal static readonly int SELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_SELECTED_VISUAL_get();
}
/// <summary>
- /// Creates an uninitialized Button.<br>
- /// Only derived versions can be instantiated.<br>
+ /// Creates an uninitialized button.<br />
+ /// Only the derived versions can be instantiated.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Button() : this(NDalicPINVOKE.new_Button__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// If the autorepeating property is set to true then the togglable property is set to false.
+ /// If the autorepeating property is set to true, then the togglable property is set to false.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool AutoRepeating
{
get
}
/// <summary>
- /// By default this value is set to 0.15 seconds.
+ /// By default, this value is set to 0.15 seconds.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float InitialAutoRepeatingDelay
{
get
}
/// <summary>
- /// default this value is set to 0.05 seconds.
+ /// By default, this value is set to 0.05 seconds.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float NextAutoRepeatingDelay
{
get
/// <summary>
/// If the togglable property is set to true, then the autorepeating property is set to false.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Togglable
{
get
}
/// <summary>
- /// /Gets/Sets the togglable button as either selected or unselected, togglable property must be set to true.
+ /// Gets or sets the togglable button as either selected or unselected, togglable property must be set to true.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Selected
{
get
}
/// <summary>
- /// Gets/Sets unselected color.
+ /// Gets or sets the unselected color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color UnselectedColor
{
get
}
/// <summary>
- /// Gets/Sets selected color.
+ /// Gets or sets the selected color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color SelectedColor
{
get
}
/// <summary>
- /// Gets/Sets label.
+ /// Gets or sets the label.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap Label
{
get
}
/// <summary>
- /// Gets/Sets text of label.
+ /// Gets or sets the text of the label.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string LabelText
{
get
}
/// <summary>
- /// Enumeration for describing the position the text label can be in relation to the control(and foreground/icon).
+ /// Enumeration for describing the position, the text label can be, in relation to the control (and foreground/icon).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Align
{
/// <summary>
- /// At the start of the control before the foreground/icon
+ /// At the start of the control before the foreground or icon.
/// </summary>
Begin,
/// <summary>
- /// At the end of the control after the foreground/icon
+ /// At the end of the control after the foreground or icon.
/// </summary>
End,
/// <summary>
- /// At the top of the control above the foreground/icon
+ /// At the top of the control above the foreground or icon.
/// </summary>
Top,
/// <summary>
- /// At the bottom of the control below the foreground/icon
+ /// At the bottom of the control below the foreground or icon.
/// </summary>
Bottom
}
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
-// Some have been manually changed
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
/// <summary>
- /// CheckBoxButton provides a check box button which user can check or uncheck.<br>
- /// By default, a CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected.<br>
- /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage.<br>
- /// When the button is not disabled, if it's not selected it only shows the background image.<br>
- /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image).<br>
- /// When the button is disabled, background image and selected image are replaced by disabled images.<br>
+ /// The CheckBoxButton provides a checkbox button which the user can check or uncheck.<br />
+ /// By default, the CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected.<br />
+ /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage.<br />
+ /// When the button is not disabled, if it's not selected, it only shows the background image.<br />
+ /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image).<br />
+ /// When the button is disabled, the background image and the selected image are replaced by disabled images.<br />
/// /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class CheckBoxButton : Button
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
- /// To make CheckBoxButton instance be disposed.
+ /// To dispose the CheckBoxButton instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Creates an initialized CheckBoxButton
+ /// Creates an initialized CheckBoxButton.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public CheckBoxButton() : this(NDalicPINVOKE.CheckBoxButton_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.ComponentModel;
+using System.Runtime.InteropServices;
+using Tizen.NUI.BaseComponents;
namespace Tizen.NUI.UIComponents
{
-
- using System;
- using System.Runtime.InteropServices;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// The Popup widget provides a configurable pop-up dialog with built-in layout of three main fields.
+ /// The Popup widget provides a configurable popup dialog with a built-in layout of three main fields.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Popup : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Event arguments that passed via OutsideTouchedEvent
+ /// Event arguments that passed via the OutsideTouchedEvent.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TouchedOutsideEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via ShowingEventArgs
+ /// Event arguments that passed via the ShowingEventArgs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ShowingEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via ShownEventArgs
+ /// Event arguments that passed via the ShownEventArgs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ShownEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via HidingEventArgs
+ /// Event arguments that passed via the HidingEventArgs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class HidingEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via HiddenEventArgs
+ /// Event arguments that passed via the HiddenEventArgs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class HiddenEventArgs : EventArgs
{
}
private HiddenEventCallbackDelegate _popUpHiddenEventCallbackDelegate;
/// <summary>
- /// Event is sent when user has touched outside of the Dialog.
+ /// An event is sent when the user has touched outside the dialog.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<TouchedOutsideEventArgs> TouchedOutside
{
add
}
/// <summary>
- /// Event is sent when the Popup is starting to be shown.
+ /// An event is sent when the popup starts showing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ShowingEventArgs> Showing
{
add
/// <summary>
- /// Event is sent when the Popup has been fully displayed.
+ /// An event is sent when the popup has been fully displayed.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ShownEventArgs> Shown
{
add
}
/// <summary>
- /// Event is sent when the Popup is starting to be hidden.
+ /// An event is sent when the popup starts to hide.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<HidingEventArgs> Hiding
{
add
}
/// <summary>
- /// Event is sent when the Popup has been completely hidden.
+ /// An event is sent when the popup has been completely hidden.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<HiddenEventArgs> Hidden
{
add
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int TITLE = NDalicPINVOKE.Popup_Property_TITLE_get();
internal static readonly int CONTENT = NDalicPINVOKE.Popup_Property_CONTENT_get();
}
/// <summary>
- /// Create the Popup.
+ /// Creates the popup.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Popup() : this(NDalicPINVOKE.Popup_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to popup handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static Popup DownCast(BaseHandle handle)
{
Popup ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Popup;
}
/// <summary>
- /// Sets a title for this Popup.
+ /// Sets the title for this popup.
/// </summary>
- /// <param name="titleView">The actor to set a title</param>
+ /// <param name="titleView">The actor to set the title.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetTitle(View titleView)
{
NDalicPINVOKE.Popup_SetTitle(swigCPtr, View.getCPtr(titleView));
/// <summary>
/// Sets the content actor.
/// </summary>
- /// <param name="content">The actor to use</param>
+ /// <param name="content">The actor to use.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetContent(View content)
{
NDalicPINVOKE.Popup_SetContent(swigCPtr, View.getCPtr(content));
}
/// <summary>
- /// Sets the actor to use for a footer in this Popup.
+ /// Sets the actor to use for the footer in this popup.
/// </summary>
- /// <param name="footer">The footer actor to be added to this Popup</param>
+ /// <param name="footer">The footer actor to be added to this popup.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFooter(View footer)
{
NDalicPINVOKE.Popup_SetFooter(swigCPtr, View.getCPtr(footer));
}
/// <summary>
- /// Sets the display state of Popup.<br>
- /// There are 4 total display states.<br>
- /// Only 2 can be set, but all four can be read for better inspection of the current popup state.<br>
- /// <br>
- /// The other two states are getable, but not setable and are there for consistency.<br>
- /// <br>
- /// | Value | Setting the state | Getting the state |<br>
- /// |----------|--------------------------------|--------------------------------|<br>
- /// | SHOWN | Show the popup | The popup is fully shown |<br>
- /// | HIDDEN | Hide the popup | The popup is fully hidden |<br>
- /// | SHOWING | | The popup is transitioning in |<br>
- /// | HIDING | | The popup is transitioning out |<br>
- /// <br>
- /// All 4 state changes cause notifications via 4 respective signals that can be connected to.<br>
+ /// Sets the display state of popup.<br />
+ /// There are 4 total display states.<br />
+ /// Only 2 can be set, but all four can be read for better inspection of the current popup state.<br />
+ /// <br />
+ /// The other two states are getable, but not setable, and are there for consistency.<br />
+ /// <br />
+ /// | Value | Setting the state | Getting the state |<br />
+ /// |----------|--------------------------------|--------------------------------|<br />
+ /// | SHOWN | Show the popup | The popup is fully shown |<br />
+ /// | HIDDEN | Hide the popup | The popup is fully hidden |<br />
+ /// | SHOWING | | The popup is transitioning in |<br />
+ /// | HIDING | | The popup is transitioning out |<br />
+ /// <br />
+ /// All 4 states changes cause notifications via 4 respective signals that can be connected to.<br />
/// </summary>
- /// <param name="displayState">The desired display state to change to</param>
+ /// <param name="displayState">The desired display state to change to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetDisplayState(Popup.DisplayStateType displayState)
{
NDalicPINVOKE.Popup_SetDisplayState(swigCPtr, (int)displayState);
}
/// <summary>
- /// The display states of the Popup.
+ /// The display states of the popup.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum DisplayStateType
{
+ /// <summary>
+ /// The popup is transitioning in
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Showing,
+ /// <summary>
+ /// The popup is fully shown
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Shown,
+ /// <summary>
+ /// The popup is transitioning out
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Hiding,
+ /// <summary>
+ /// The popup is fully hidden
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Hidden
}
/// <summary>
- /// The animation mode within popup.<br>
- /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties.<br>
+ /// The animation modes within the popup.<br />
+ /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum AnimationModeType
{
+ /// <summary>
+ /// No animation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
+ /// <summary>
+ /// Popup zooms in and out animating the scale property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Zoom,
+ /// <summary>
+ /// Popup fades in and out
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fade,
+ /// <summary>
+ /// Use the EntryAnimation and ExitAnimation animation properties.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Custom
}
/// <summary>
- /// Types of contextual layout.<br>
- /// The Popup is positioned adjacent to it's parent in the direction specified by this mode.<br>
- /// NON_CONTEXTUAL disables any contextual positioning.<br>
+ /// The types of the contextual layout.<br />
+ /// The popup is positioned adjacent to it's parent in the direction specified by this mode.<br />
+ /// NON_CONTEXTUAL disables any contextual positioning.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ContextualModeType
{
+ /// <summary>
+ /// any contextual positioning
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
NonContextual,
+ /// <summary>
+ /// Above
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Above,
+ /// <summary>
+ /// Rright
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Rright,
+ /// <summary>
+ /// Below
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Below,
+ /// <summary>
+ /// Left
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Left
}
/// <summary>
- /// Popup title.
+ /// The popup title.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Title
{
get
}
}
/// <summary>
- /// Popup content.
+ /// The popup content.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Content
{
get
}
}
/// <summary>
- /// Popup footer.
+ /// The popup footer.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Footer
{
get
}
}
/// <summary>
- /// Popup display state.
+ /// The popup display state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public DisplayStateType DisplayState
{
get
}
}
/// <summary>
- /// Touch transparent.
+ /// The touch transparent.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool TouchTransparent
{
get
}
}
/// <summary>
- /// Popup tail visibility.
+ /// The popup tail visibility.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool TailVisibility
{
get
}
}
/// <summary>
- /// Popup tail position.
+ /// The popup tail position.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 TailPosition
{
get
}
}
/// <summary>
- /// Contextual mode.
+ /// The contextual mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ContextualModeType ContextualMode
{
get
}
}
/// <summary>
- /// Animation duration.
+ /// The animation duration.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float AnimationDuration
{
get
}
}
/// <summary>
- /// Animation mode.
+ /// The animation mode.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AnimationModeType AnimationMode
{
get
}
}
/// <summary>
- /// Entry animation.
+ /// The entry animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap EntryAnimation
{
get
}
}
/// <summary>
- /// Exit animation.
+ /// The exit animation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap ExitAnimation
{
get
}
}
/// <summary>
- /// Auto hide delay.
+ /// The auto hide delay.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int AutoHideDelay
{
get
}
}
/// <summary>
- /// Backing enabled.
+ /// The backing enabled.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BackingEnabled
{
get
}
}
/// <summary>
- /// Backing color.
+ /// The backing color.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 BackingColor
{
get
}
}
/// <summary>
- /// Background image.
+ /// The background image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PopupBackgroundImage
{
get
}
}
/// <summary>
- /// Background border.
+ /// The background border.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle PopupBackgroundBorder
{
get
}
}
/// <summary>
- /// Tail up image.
+ /// The tail up image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailUpImage
{
get
}
}
/// <summary>
- /// Tail down image.
+ /// The tail down image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailDownImage
{
get
}
}
/// <summary>
- /// Tail left image.
+ /// The tail left image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailLeftImage
{
get
}
}
/// <summary>
- /// Tail right image.
+ /// The tail right image.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TailRightImage
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// ProgressBar is a control to give the user an indication of the progress of an operation.
+ /// The ProgressBar is a control to give the user an indication of the progress of an operation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ProgressBar : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make ProgressBar instance be disposed.
+ /// To dispose the ProgressBar instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
- /// Event arguments that passed via ValueChangedEventArgs
+ /// Event arguments that passed via the ValueChangedEventArgs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ValueChangedEventArgs : EventArgs
{
private ProgressBar _progressBar;
private float _progressValue;
private float _secondaryProgressValue;
+ /// <summary>
+ /// ProgressBar
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ProgressBar ProgressBar
{
get
}
}
+ /// <summary>
+ /// The progress value of the progress bar, the progress runs from 0 to 1.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ProgressValue
{
get
}
}
+ /// <summary>
+ /// The secondary progress value of the progress bar, the secondary progress runs from 0 to 1.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SecondaryProgressValue
{
get
private ValueChangedCallbackDelegate _progressBarValueChangedCallbackDelegate;
/// <summary>
- /// Event is sent when the ProgressBar value changes.
+ /// The event is sent when the ProgressBar value changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ValueChangedEventArgs> ValueChanged
{
add
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_PROGRESS_VALUE_get();
internal static readonly int SECONDARY_PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_SECONDARY_PROGRESS_VALUE_get();
/// <summary>
/// Creates the ProgressBar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ProgressBar() : this(NDalicPINVOKE.ProgressBar_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// The progress value of progress bar, progress runs form 0 to 1.<br>
- /// If Value is set to 0, progress bar will be set to beginning.<br>
- /// If Value is set to 1, progress bar will be set to end.<br>
- /// Any Value outside of the range is ignored.<br>
+ /// The progress value of the progress bar, the progress runs from 0 to 1.<br />
+ /// If the value is set to 0, then the progress bar will be set to beginning.<br />
+ /// If the value is set to 1, then the progress bar will be set to end.<br />
+ /// Any value outside the range is ignored.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ProgressValue
{
get
}
}
/// <summary>
- /// The secondary progress value of progress bar, secondary progress runs form 0 to 1.<br>
- /// Optional. If not supplied, the default is 0.<br>
- /// If Value is set to 0, progress bar will be set secondary progress to beginning.<br>
- /// If Value is set to 1, progress bar will be set secondary progress to end.<br>
- /// Any Value outside of the range is ignored.<br>
+ /// The secondary progress value of the progress bar, the secondary progress runs from 0 to 1.<br />
+ /// Optional. If not supplied, the default is 0.<br />
+ /// If the value is set to 0, then the progress bar will be set secondary progress to beginning.<br />
+ /// If the value is set to 1, then the progress bar will be set secondary progress to end.<br />
+ /// Any value outside of the range is ignored.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SecondaryProgressValue
{
get
}
}
/// <summary>
- /// Sets the progress-bar as \e indeterminate state.
+ /// Sets the progress bar as \e indeterminate state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Indeterminate
{
get
}
}
/// <summary>
- /// The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.<br>
- /// Optional. If not supplied, the default track visual will be shown.<br>
+ /// The track visual value of progress bar, it's full progress area, and it's shown behind the PROGRESS_VISUAL.<br />
+ /// Optional. If not supplied, the default track visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap TrackVisual
{
get
}
}
/// <summary>
- /// The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.<br>
- /// Optional. If not supplied, the default progress visual will be shown.<br>
+ /// The progress visual value of the progress bar, the size of the progress visual is changed based on the PROGRESS_VALUE.<br />
+ /// Optional. If not supplied, then the default progress visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap ProgressVisual
{
get
}
}
/// <summary>
- /// The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.<br>
- /// Optional. If not supplied, the secondary progress visual will not be shown.<br>
+ /// The secondary progress visual of the progress bar, the size of the secondary progress visual is changed based on the SECONDARY_PROGRESS_VALUE.<br />
+ /// Optional. If not supplied, then the secondary progress visual will not be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap SecondaryProgressVisual
{
get
}
}
/// <summary>
- /// The indeterminate visual of progress bar.<br>
- /// Optional. If not supplied, the default inditerminate visual will be shown.<br>
+ /// The indeterminate visual of the progress bar.<br />
+ /// Optional. If not supplied, then the default indeterminate visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap IndeterminateVisual
{
get
}
}
/// <summary>
- /// The transition data for indeterminate visual animation.<br>
- /// Optional. If not supplied, default animation will be played.<br>
+ /// The transition data for the indeterminate visual animation.<br />
+ /// Optional. If not supplied, then the default animation will be played.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray IndeterminateVisualAnimation
{
get
}
}
/// <summary>
- /// The Label visual of progress bar.
+ /// The label visual of the progress bar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap LabelVisual
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
+using System.ComponentModel;
using Tizen.NUI.BaseComponents;
namespace Tizen.NUI.UIComponents
{
/// <summary>
- /// A PushButton changes its appearance when is pressed and returns to its original when is released.
+ /// The PushButton changes its appearance when it is pressed, and returns to its original when it is released.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PushButton : Button
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make PushButton instance be disposed.
+ /// To dispose the PushButton instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
- internal class Property
+ internal new class Property
{
internal static readonly int UNSELECTED_ICON = NDalicPINVOKE.PushButton_Property_UNSELECTED_ICON_get();
internal static readonly int SELECTED_ICON = NDalicPINVOKE.PushButton_Property_SELECTED_ICON_get();
/// <summary>
/// Creates the PushButton.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PushButton() : this(NDalicPINVOKE.PushButton_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to pushButton handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static PushButton DownCast(BaseHandle handle)
{
PushButton ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as PushButton;
return ret;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// UnselectedIcon.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use UnselectedVisual.
+ [Obsolete("Please do not use! This will be deprecated! Please use UnselectedVisual instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public string UnselectedIcon
{
set
SetProperty(PushButton.Property.UNSELECTED_ICON, new Tizen.NUI.PropertyValue(value));
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+
+ /// <summary>
+ /// SelectedIcon.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use SelectedVisual.
+ [Obsolete("Please do not use! This will be deprecated! Please use SelectedVisual instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public string SelectedIcon
{
set
SetProperty(PushButton.Property.SELECTED_ICON, new Tizen.NUI.PropertyValue(value));
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use LabelRelativeAlignment instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public IconAlignmentType IconAlignment
{
get
SetProperty(PushButton.Property.ICON_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
}
}
- [Obsolete("Please do not use! this will be deprecated")]
- public Vector4 LabelPadding
+
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// no use
+ [Obsolete("Please do not use! This will be deprecated! Please use Button.LabelPadding instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public new Vector4 LabelPadding
{
get
{
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// no use
+ [Obsolete("Please do not use! This will be deprecated! Please use ForegroundVisualPadding instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public Vector4 IconPadding
{
get
}
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// no use
+ [Obsolete("Please do not use! This will be deprecated! Please use Button.Align instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public enum IconAlignmentType
{
/// <summary>
- /// Icon located to the left of text.
+ /// The icon located to the left of text.
/// </summary>
Left,
/// <summary>
- /// Icon located to the right of text.
+ /// The icon located to the right of text.
/// </summary>
Right,
/// <summary>
- /// Icon located to the top of text.
+ /// The icon located to the top of text.
/// </summary>
Top,
/// <summary>
- /// Icon located to the bottom of text.
+ /// The icon located to the bottom of text.
/// </summary>
Bottom,
/// <summary>
- /// Icon located to the right of text by default.
+ /// The icon located to the right of text by default.
/// </summary>
Default = Right
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
/// <summary>
- /// A RadioButton provides a radio button which two states \e selected or \e unselected.<br>
- /// Radio buttons are designed to select one of many option at the same time.<br>
- /// RadioButton can change its current state using Selected.<br>
- /// <br>
- /// RadioButtons can be grouped.<br>
- /// Two or more RadioButtons are in one group when they have this same parent.<br>
- /// In each groups only one RadioButton can be \e selected at a given time.<br>
- /// So when RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.<br>
- /// When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.<br>
- /// <br>
- /// A StateChanged Event is emitted when the RadioButton change its state to \e selected or \e unselected.<br>
+ /// A RadioButton provides a radio button with two states, \e selected or \e unselected.<br />
+ /// Radio buttons are designed to select one of the many options at the same time.<br />
+ /// A RadioButton can change its current state using the selected.<br />
+ /// <br />
+ /// RadioButtons can be grouped.<br />
+ /// Two or more RadioButtons are in one group when they have this same parent.<br />
+ /// In each groups only one RadioButton can be \e selected at a given time.<br />
+ /// So when a RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.<br />
+ /// When \e selected RadioButton is set to \e unselected, no other RadioButtons in this group are set to \e selected.<br />
+ /// <br />
+ /// The StateChanged event is emitted when the RadioButton change its state to \e selected or \e unselected.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RadioButton : Button
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make RadioButton instance be disposed.
+ /// To dispose the RadioButton instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
/// <summary>
- /// Creates an uninitialized RadioButton
+ /// Creates an uninitialized RadioButton.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RadioButton() : this(NDalicPINVOKE.RadioButton_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an uninitialized RadioButton with Label
+ /// Creates an uninitialized RadioButton with the label.
/// </summary>
- /// <param name="label">Label text</param>
+ /// <param name="label">The label text.</param>
+ /// <since_tizen> 3 </since_tizen>
public RadioButton(string label) : this(NDalicPINVOKE.RadioButton_New__SWIG_1(label), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.ComponentModel;
+using System.Runtime.InteropServices;
+using Tizen.NUI.BaseComponents;
namespace Tizen.NUI.UIComponents
{
-
- using System;
- using System.Runtime.InteropServices;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// ScrollBar is a UI component that can be linked to the scrollable objects
- /// indicating the current scroll position of the scrollable object.<br>
+ /// The ScrollBar is a UI component that can be linked to the scrollable objects
+ /// indicating the current scroll position of the scrollable object.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ScrollBar : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// To make ScrollBar instance be disposed.
+ /// To dispose the ScrollBar instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Event arguments that passed via PanFinished event
+ /// Event arguments that passed via the PanFinished event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PanFinishedEventArgs : EventArgs
{
}
/// <summary>
- /// Event arguments that passed via ScrollPositionIntervalReached event
+ /// Event arguments that passed via the ScrollPositionIntervalReached event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ScrollIntervalEventArgs : EventArgs
{
private float _currentScrollPosition;
/// <summary>
- /// current scroll position of the scrollable content
+ /// The current scroll position of the scrollable content.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float CurrentScrollPosition
{
get
private ScrollPositionIntervalReachedEventCallbackDelegate _scrollBarScrollPositionIntervalReachedEventCallbackDelegate;
/// <summary>
- /// Event emitted when panning is finished on the scroll indicator.
+ /// The event emitted when panning is finished on the scroll indicator.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<PanFinishedEventArgs> PanFinished
{
add
/// <summary>
- /// Event emitted when the current scroll position of the scrollable content
+ /// This is the event emitted when the current scroll position of the scrollable content.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ScrollIntervalEventArgs> ScrollInterval
{
add
}
- internal class Property
+ internal new class Property
{
internal static readonly int SCROLL_DIRECTION = NDalicPINVOKE.ScrollBar_Property_SCROLL_DIRECTION_get();
internal static readonly int INDICATOR_HEIGHT_POLICY = NDalicPINVOKE.ScrollBar_Property_INDICATOR_HEIGHT_POLICY_get();
}
/// <summary>
- /// Creates an initialized ScrollBar.
+ /// Creates an initialized scrollbar.
/// </summary>
- /// <param name="direction">The direction of scroll bar (either vertically or horizontally)</param>
+ /// <param name="direction">The direction of the scrollbar (either vertically or horizontally).</param>
+ /// <since_tizen> 3 </since_tizen>
public ScrollBar(ScrollBar.Direction direction) : this(NDalicPINVOKE.ScrollBar_New__SWIG_0((int)direction), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an uninitialized ScrollBar
+ /// Creates an uninitialized scrollbar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ScrollBar() : this(NDalicPINVOKE.ScrollBar_New__SWIG_1(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to scrollBar handle.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static ScrollBar DownCast(BaseHandle handle)
{
ScrollBar ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ScrollBar;
}
/// <summary>
- /// Direction of scroll bar
+ /// The direction of the scrollbar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Direction
{
+ /// <summary>
+ /// Scroll in the vertical direction
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Vertical = 0,
+ /// <summary>
+ /// Scroll in the horizontal direction
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Horizontal
}
/// <summary>
- /// Indicator height policy.
+ /// The indicator height policy.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum IndicatorHeightPolicyType
{
+ /// <summary>
+ /// Variable height changed dynamically according to the length of scroll content
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Variable = 0,
+ /// <summary>
+ /// Fixed height regardless of the length of scroll content
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Fixed
}
/// <summary>
- /// Direction of scroll bar
+ /// The direction of the scrollbar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Direction ScrollDirection
{
get
}
/// <summary>
- /// Indicator height policy.
+ /// The indicator height policy.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public IndicatorHeightPolicyType IndicatorHeightPolicy
{
get
}
/// <summary>
- /// the fixed height of scroll indicator.
+ /// The fixed height of the scroll indicator.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorFixedHeight
{
get
}
/// <summary>
- /// the duration in seconds for the scroll indicator to become fully visible.
+ /// The duration in seconds for the scroll indicator to become fully visible.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorShowDuration
{
get
}
/// <summary>
- /// the duration in seconds for the scroll indicator to become fully invisible.
+ /// The duration in seconds for the scroll indicator to become fully invisible.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorHideDuration
{
get
}
/// <summary>
- /// the list of values to get notification when the current scroll position of the scrollable object goes above or below any of these values.
+ /// The list of values to get the notification when the current scroll position of the scrollable object goes above or below any of these values.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray ScrollPositionIntervals
{
get
/// <summary>
/// The minimum height for a variable size indicator.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorMinimumHeight
{
get
}
/// <summary>
- /// The padding at the start of the indicator. For example, the top if scrollDirection is Vertical.
+ /// The padding at the start of the indicator. For example, the top if the scrollDirection is vertical.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorStartPadding
{
get
}
/// <summary>
- /// The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical.
+ /// The padding at the end of the indicator. For example, the bottom if the scrollDirection is vertical.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float IndicatorEndPadding
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using System.Runtime.InteropServices;
using Tizen.NUI.BaseComponents;
+ /// <summary>
+ /// ScrollView contains views that can be scrolled manually (via touch).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ScrollView : Scrollable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">the dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
- /**
- * @brief Event arguments that passed via SnapStarted signal
- *
- */
+ /// <summary>
+ /// Event arguments that passed via the SnapStarted signal.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SnapStartedEventArgs : EventArgs
{
private Tizen.NUI.ScrollView.SnapEvent _snapEvent;
- /**
- * @brief SnapEvent - is the SnapEvent information like snap or flick (it tells the target position, scale, rotation for the snap or flick).
- *
- */
+ /// <summary>
+ /// SnapEventInfo is the SnapEvent information like snap or flick (it tells the target position, scale, rotation for the snap or flick).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.ScrollView.SnapEvent SnapEventInfo
{
get
private DaliEventHandler<object, SnapStartedEventArgs> _scrollViewSnapStartedEventHandler;
private SnapStartedCallbackDelegate _scrollViewSnapStartedCallbackDelegate;
- /**
- * @brief Event for SnapStarted signal which can be used to subscribe/unsubscribe the event handler
- * (in the type of SnapStartedEventHandler-DaliEventHandler<object,SnapStartedEventArgs>) provided by the user.
- * SnapStarted signal is emitted hen the ScrollView has started to snap or flick (it tells the target
- * position, scale, rotation for the snap or flick).
- *
- */
+ /// <summary>
+ /// SnapStarted can be used to subscribe or unsubscribe the event handler
+ /// The SnapStarted signal is emitted when the ScrollView has started to snap or flick (it tells the target
+ /// position, scale, rotation for the snap or flick).
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event DaliEventHandler<object, SnapStartedEventArgs> SnapStarted
{
add
}
}
+ /// <summary>
+ /// Snaps signal event's data.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SnapEvent : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal SnapEvent(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// swigCMemOwn
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~SnapEvent()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">the dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
+ /// <summary>
+ /// Get SnapEvent From Ptr
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static SnapEvent GetSnapEventFromPtr(global::System.IntPtr cPtr)
{
SnapEvent ret = new SnapEvent(cPtr, false);
}
}
+ /// <summary>
+ /// Scroll position.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 position
{
set
}
}
+ /// <summary>
+ /// Scroll duration.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float duration
{
set
}
}
+ /// <summary>
+ /// Create an instance of SnapEvent.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public SnapEvent() : this(NDalicPINVOKE.new_ScrollView_SnapEvent(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public class Property
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property
{
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WRAP_ENABLED = NDalicPINVOKE.ScrollView_Property_WRAP_ENABLED_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PANNING_ENABLED = NDalicPINVOKE.ScrollView_Property_PANNING_ENABLED_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int AXIS_AUTO_LOCK_ENABLED = NDalicPINVOKE.ScrollView_Property_AXIS_AUTO_LOCK_ENABLED_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WHEEL_SCROLL_DISTANCE_STEP = NDalicPINVOKE.ScrollView_Property_WHEEL_SCROLL_DISTANCE_STEP_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_MODE = NDalicPINVOKE.ScrollView_Property_SCROLL_MODE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION = NDalicPINVOKE.ScrollView_Property_SCROLL_POSITION_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION_X = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_X_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION_Y = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_Y_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION_MAX = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_MAX_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION_MAX_X = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_MAX_X_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_PRE_POSITION_MAX_Y = NDalicPINVOKE.ScrollView_Property_SCROLL_PRE_POSITION_MAX_Y_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_X = NDalicPINVOKE.ScrollView_Property_OVERSHOOT_X_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int OVERSHOOT_Y = NDalicPINVOKE.ScrollView_Property_OVERSHOOT_Y_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_FINAL = NDalicPINVOKE.ScrollView_Property_SCROLL_FINAL_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_FINAL_X = NDalicPINVOKE.ScrollView_Property_SCROLL_FINAL_X_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_FINAL_Y = NDalicPINVOKE.ScrollView_Property_SCROLL_FINAL_Y_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int WRAP = NDalicPINVOKE.ScrollView_Property_WRAP_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int PANNING = NDalicPINVOKE.ScrollView_Property_PANNING_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLLING = NDalicPINVOKE.ScrollView_Property_SCROLLING_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_DOMAIN_SIZE = NDalicPINVOKE.ScrollView_Property_SCROLL_DOMAIN_SIZE_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_DOMAIN_SIZE_X = NDalicPINVOKE.ScrollView_Property_SCROLL_DOMAIN_SIZE_X_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_DOMAIN_SIZE_Y = NDalicPINVOKE.ScrollView_Property_SCROLL_DOMAIN_SIZE_Y_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_DOMAIN_OFFSET = NDalicPINVOKE.ScrollView_Property_SCROLL_DOMAIN_OFFSET_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int SCROLL_POSITION_DELTA = NDalicPINVOKE.ScrollView_Property_SCROLL_POSITION_DELTA_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int START_PAGE_POSITION = NDalicPINVOKE.ScrollView_Property_START_PAGE_POSITION_get();
}
+ /// <summary>
+ /// Create an instance of ScrollView.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ScrollView() : this(NDalicPINVOKE.ScrollView_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets snap-animation's AlphaFunction.
+ /// </summary>
+ /// <returns>Current easing alpha function of the snap animation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction GetScrollSnapAlphaFunction()
{
AlphaFunction ret = new AlphaFunction(NDalicPINVOKE.ScrollView_GetScrollSnapAlphaFunction(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Sets snap-animation's AlphaFunction.
+ /// </summary>
+ /// <param name="alpha">Easing alpha function of the snap animation.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollSnapAlphaFunction(AlphaFunction alpha)
{
NDalicPINVOKE.ScrollView_SetScrollSnapAlphaFunction(swigCPtr, AlphaFunction.getCPtr(alpha));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets flick-animation's AlphaFunction.
+ /// </summary>
+ /// <returns>Current easing alpha function of the flick animation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction GetScrollFlickAlphaFunction()
{
AlphaFunction ret = new AlphaFunction(NDalicPINVOKE.ScrollView_GetScrollFlickAlphaFunction(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Sets flick-animation's AlphaFunction.
+ /// </summary>
+ /// <param name="alpha">Easing alpha function of the flick animation.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollFlickAlphaFunction(AlphaFunction alpha)
{
NDalicPINVOKE.ScrollView_SetScrollFlickAlphaFunction(swigCPtr, AlphaFunction.getCPtr(alpha));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the time for the scroll snap-animation.
+ /// </summary>
+ /// <returns>The time in seconds for the animation to take.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetScrollSnapDuration()
{
float ret = NDalicPINVOKE.ScrollView_GetScrollSnapDuration(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the time for the scroll snap-animation.
+ /// </summary>
+ /// <param name="time">The time in seconds for the animation to take.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollSnapDuration(float time)
{
NDalicPINVOKE.ScrollView_SetScrollSnapDuration(swigCPtr, time);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the time for the scroll flick-animation.
+ /// </summary>
+ /// <returns>The time in seconds for the animation to take.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetScrollFlickDuration()
{
float ret = NDalicPINVOKE.ScrollView_GetScrollFlickDuration(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the time for the scroll snap-animation.
+ /// </summary>
+ /// <param name="time">The time in seconds for the animation to take.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollFlickDuration(float time)
{
NDalicPINVOKE.ScrollView_SetScrollFlickDuration(swigCPtr, time);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
-
+ /// <summary>
+ /// Sets scroll sensibility of pan gesture.
+ /// </summary>
+ /// <param name="sensitive">True to enable scroll, false to disable scrolling.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollSensitive(bool sensitive)
{
NDalicPINVOKE.ScrollView_SetScrollSensitive(swigCPtr, sensitive);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets maximum overshoot amount.
+ /// </summary>
+ /// <param name="overshootX">The maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f.</param>
+ /// <param name="overshootY">The maximum number of vertically scrolled pixels before overshoot X reaches 1.0f.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetMaxOvershoot(float overshootX, float overshootY)
{
NDalicPINVOKE.ScrollView_SetMaxOvershoot(swigCPtr, overshootX, overshootY);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets Snap Overshoot animation's AlphaFunction.
+ /// </summary>
+ /// <param name="alpha">Easing alpha function of the overshoot snap animation.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetSnapOvershootAlphaFunction(AlphaFunction alpha)
{
NDalicPINVOKE.ScrollView_SetSnapOvershootAlphaFunction(swigCPtr, AlphaFunction.getCPtr(alpha));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets Snap Overshoot animation's Duration.
+ /// </summary>
+ /// <param name="duration">duration The duration of the overshoot snap animation.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetSnapOvershootDuration(float duration)
{
NDalicPINVOKE.ScrollView_SetSnapOvershootDuration(swigCPtr, duration);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Enables or Disables Actor Auto-Snap mode.<br />
+ /// When Actor Auto-Snap mode has been enabled, ScrollView will automatically,
+ /// snap to the closest actor (The closest actor will appear in the center of the ScrollView).
+ /// </summary>
+ /// <param name="enable">Enables (true), or disables (false) Actor AutoSnap.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetViewAutoSnap(bool enable)
{
NDalicPINVOKE.ScrollView_SetActorAutoSnap(swigCPtr, enable);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Enables or Disables Wrap mode for ScrollView contents.<br />
+ /// When enabled, the ScrollView contents are wrapped over the X/Y Domain.
+ /// </summary>
+ /// <param name="enable">Enables (true), or disables (false) Wrap Mode.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWrapMode(bool enable)
{
NDalicPINVOKE.ScrollView_SetWrapMode(swigCPtr, enable);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted.
+ /// </summary>
+ /// <returns>Current scroll update distance.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetScrollUpdateDistance()
{
int ret = NDalicPINVOKE.ScrollView_GetScrollUpdateDistance(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted.<br />
+ /// The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.<br />
+ /// Each time the ScrollView crosses this distance the signal will be emitted.<br />
+ /// </summary>
+ /// <param name="distance">The distance for ScrollView to move before emitting update signal.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollUpdateDistance(int distance)
{
NDalicPINVOKE.ScrollView_SetScrollUpdateDistance(swigCPtr, distance);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Returns state of Axis Auto Lock mode.
+ /// </summary>
+ /// <returns>Whether Axis Auto Lock mode has been enabled or not.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GetAxisAutoLock()
{
bool ret = NDalicPINVOKE.ScrollView_GetAxisAutoLock(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Enables or Disables Axis Auto Lock mode for panning within the ScrollView.<br />
+ /// When enabled, any pan gesture that appears mostly horizontal or mostly
+ /// vertical, will be automatically restricted to horizontal only or vertical
+ /// only panning, until the pan gesture has completed.
+ /// </summary>
+ /// <param name="enable">Enables (true), or disables (false) AxisAutoLock mode.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetAxisAutoLock(bool enable)
{
NDalicPINVOKE.ScrollView_SetAxisAutoLock(swigCPtr, enable);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis.
+ /// </summary>
+ /// <returns>The gradient, a value between 0.0 and 1.0f.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetAxisAutoLockGradient()
{
float ret = NDalicPINVOKE.ScrollView_GetAxisAutoLockGradient(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis.<br />
+ /// By default, this is 0.36 (0.36:1) which means angles less than 20 degrees to an axis will lock to that axis.<br />
+ /// </summary>
+ /// <param name="gradient">gradient A value between 0.0 and 1.0 (auto-lock for all angles).</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetAxisAutoLockGradient(float gradient)
{
NDalicPINVOKE.ScrollView_SetAxisAutoLockGradient(swigCPtr, gradient);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the friction coefficient setting for ScrollView when flicking in free panning mode.
+ /// This is a value in stage-diagonals per second^2, stage-diagonal = Length( stage.width, stage.height )
+ /// </summary>
+ /// <returns>Friction coefficient is returned.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetFrictionCoefficient()
{
float ret = NDalicPINVOKE.ScrollView_GetFrictionCoefficient(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the friction coefficient for ScrollView when flicking.<br />
+ /// </summary>
+ /// <param name="friction">Friction coefficient must be greater than 0.0 (default = 1.0).</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFrictionCoefficient(float friction)
{
NDalicPINVOKE.ScrollView_SetFrictionCoefficient(swigCPtr, friction);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the flick speed coefficient for ScrollView when flicking in free panning mode.<br />
+ /// This is a constant which multiplies the input touch flick velocity to determine the actual velocity at which to move the scrolling area.
+ /// </summary>
+ /// <returns>The flick speed coefficient is returned.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetFlickSpeedCoefficient()
{
float ret = NDalicPINVOKE.ScrollView_GetFlickSpeedCoefficient(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the flick speed coefficient for ScrollView when flicking in free panning mode.<br />
+ /// This is a constant which multiplies the input touch flick velocity to determine the actual velocity at
+ /// which to move the scrolling area.<br />
+ /// </summary>
+ /// <param name="speed">The flick speed coefficient (default = 1.0).</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetFlickSpeedCoefficient(float speed)
{
NDalicPINVOKE.ScrollView_SetFlickSpeedCoefficient(swigCPtr, speed);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the minimum pan distance required for a flick gesture in pixels.<br />
+ /// </summary>
+ /// <returns>Minimum pan distance vector with separate x and y distance.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetMinimumDistanceForFlick()
{
Vector2 ret = new Vector2(NDalicPINVOKE.ScrollView_GetMinimumDistanceForFlick(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Sets the minimum pan distance required for a flick in pixels.<br />
+ /// Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes, a flick will be allowed.
+ /// </summary>
+ /// <param name="distance">The flick speed coefficient (default = 1.0).</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetMinimumDistanceForFlick(Vector2 distance)
{
NDalicPINVOKE.ScrollView_SetMinimumDistanceForFlick(swigCPtr, Vector2.getCPtr(distance));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Returns the minimum pan speed required for a flick gesture in pixels per second.
+ /// </summary>
+ /// <returns>Minimum pan speed.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetMinimumSpeedForFlick()
{
float ret = NDalicPINVOKE.ScrollView_GetMinimumSpeedForFlick(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the minimum pan speed required for a flick in pixels per second.<br />
+ /// </summary>
+ /// <param name="speed">The minimum pan speed for a flick.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetMinimumSpeedForFlick(float speed)
{
NDalicPINVOKE.ScrollView_SetMinimumSpeedForFlick(swigCPtr, speed);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the maximum flick speed setting for ScrollView when flicking in free panning mode.<br />
+ /// This is a value in stage-diagonals per second.
+ /// </summary>
+ /// <returns>Maximum flick speed is returned.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetMaxFlickSpeed()
{
float ret = NDalicPINVOKE.ScrollView_GetMaxFlickSpeed(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the maximum flick speed for the ScrollView when flicking in free panning mode.<br />
+ /// This is a value in stage-diagonals per second. stage-diagonal = Length( stage.width, stage.height ).<br />
+ /// </summary>
+ /// <param name="speed">Maximum flick speed (default = 3.0).</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetMaxFlickSpeed(float speed)
{
NDalicPINVOKE.ScrollView_SetMaxFlickSpeed(swigCPtr, speed);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets the step of scroll distance in actor coordinates for each wheel event received in free panning mode.<br />
+ /// </summary>
+ /// <returns>The step of scroll distance(pixel) in X and Y axes.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetWheelScrollDistanceStep()
{
Vector2 ret = new Vector2(NDalicPINVOKE.ScrollView_GetWheelScrollDistanceStep(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Sets the step of scroll distance in actor coordinates for each wheel event received in free panning mode.<br />
+ /// </summary>
+ /// <param name="step">step The step of scroll distance(pixel) in X and Y axes.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWheelScrollDistanceStep(Vector2 step)
{
NDalicPINVOKE.ScrollView_SetWheelScrollDistanceStep(swigCPtr, Vector2.getCPtr(step));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Retrieves current scroll position.<br />
+ /// </summary>
+ /// <returns>The current scroll position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetCurrentScrollPosition()
{
Vector2 ret = new Vector2(NDalicPINVOKE.ScrollView_GetCurrentScrollPosition(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Retrieves current scroll page based on ScrollView dimensions being the size of one page, and all pages laid out in<br />
+ /// a grid fashion, increasing from left to right until the end of the X-domain.
+ /// </summary>
+ /// <returns>The current scroll position.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetCurrentPage()
{
uint ret = NDalicPINVOKE.ScrollView_GetCurrentPage(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="position">The position to scroll to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(Vector2 position)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_0(swigCPtr, Vector2.getCPtr(position));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="position">The position to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(Vector2 position, float duration)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_1(swigCPtr, Vector2.getCPtr(position), duration);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="position">The position to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <param name="alpha">The alpha function to use.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(Vector2 position, float duration, AlphaFunction alpha)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_2(swigCPtr, Vector2.getCPtr(position), duration, AlphaFunction.getCPtr(alpha));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="position">The position to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <param name="horizontalBias">Whether to bias scrolling to left or right.</param>
+ /// <param name="verticalBias">Whether to bias scrolling to top or bottom.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(Vector2 position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_3(swigCPtr, Vector2.getCPtr(position), duration, (int)horizontalBias, (int)verticalBias);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="position">The position to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <param name="alpha">Alpha function to use.</param>
+ /// <param name="horizontalBias">Whether to bias scrolling to left or right.</param>
+ /// <param name="verticalBias">Whether to bias scrolling to top or bottom.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(Vector2 position, float duration, AlphaFunction alpha, DirectionBias horizontalBias, DirectionBias verticalBias)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_4(swigCPtr, Vector2.getCPtr(position), duration, AlphaFunction.getCPtr(alpha), (int)horizontalBias, (int)verticalBias);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="page">The page to scroll to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(uint page)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_5(swigCPtr, page);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="page">The page to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(uint page, float duration)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_6(swigCPtr, page, duration);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="page">The page to scroll to.</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <param name="bias">Whether to bias scrolling to left or right.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(uint page, float duration, DirectionBias bias)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_7(swigCPtr, page, duration, (int)bias);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="view">The view to center in on (via Scrolling).</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(View view)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_8(swigCPtr, View.getCPtr(view));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to position specified (contents will scroll to this position).
+ /// </summary>
+ /// <param name="view">The view to center in on (via Scrolling).</param>
+ /// <param name="duration">The duration of the animation in seconds.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ScrollTo(View view, float duration)
{
NDalicPINVOKE.ScrollView_ScrollTo__SWIG_9(swigCPtr, View.getCPtr(view), duration);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Scrolls View to the nearest snap points as specified by the Rulers.<br />
+ /// If already at snap points, then will return false, and not scroll.<br />
+ /// </summary>
+ /// <returns>True if Snapping necessary.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool ScrollToSnapPoint()
{
bool ret = NDalicPINVOKE.ScrollView_ScrollToSnapPoint(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Applies Effect to ScrollView.
+ /// </summary>
+ /// <param name="effect">The effect to apply to scroll view.</param>
+ /// <since_tizen> 3 </since_tizen>
public void ApplyEffect(ScrollViewEffect effect)
{
NDalicPINVOKE.ScrollView_ApplyEffect(swigCPtr, ScrollViewEffect.getCPtr(effect));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Removes Effect from ScrollView.
+ /// </summary>
+ /// <param name="effect">The effect to remove.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveEffect(ScrollViewEffect effect)
{
NDalicPINVOKE.ScrollView_RemoveEffect(swigCPtr, ScrollViewEffect.getCPtr(effect));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Remove All Effects from ScrollView.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveAllEffects()
{
NDalicPINVOKE.ScrollView_RemoveAllEffects(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Binds view to this ScrollView.
+ /// Once an actor is bound to a ScrollView, it will be subject to that ScrollView's properties.
+ /// </summary>
+ /// <param name="child">The view to add to this ScrollView.</param>
+ /// <since_tizen> 3 </since_tizen>
public void BindView(View child)
{
NDalicPINVOKE.ScrollView_BindActor(swigCPtr, View.getCPtr(child));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Unbinds view to this ScrollView.
+ /// Once an actor is bound to a ScrollView, it will be subject to that ScrollView's properties.
+ /// </summary>
+ /// <param name="child">The view to remove to this ScrollView.</param>
+ /// <since_tizen> 3 </since_tizen>
public void UnbindView(View child)
{
NDalicPINVOKE.ScrollView_UnbindActor(swigCPtr, View.getCPtr(child));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Allows the user to constrain the scroll view in a particular direction.
+ /// </summary>
+ /// <param name="direction">The axis to constrain the scroll-view to.</param>
+ /// <param name="threshold">The threshold to apply around the axis.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollingDirection(Radian direction, Radian threshold)
{
NDalicPINVOKE.ScrollView_SetScrollingDirection__SWIG_0(swigCPtr, Radian.getCPtr(direction), Radian.getCPtr(threshold));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Allows the user to constrain the scroll view in a particular direction.
+ /// </summary>
+ /// <param name="direction">The axis to constrain the scroll-view to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetScrollingDirection(Radian direction)
{
NDalicPINVOKE.ScrollView_SetScrollingDirection__SWIG_1(swigCPtr, Radian.getCPtr(direction));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Removes a direction constraint from the scroll view.
+ /// </summary>
+ /// <param name="direction">The axis to constrain the scroll-view to.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveScrollingDirection(Radian direction)
{
NDalicPINVOKE.ScrollView_RemoveScrollingDirection(swigCPtr, Radian.getCPtr(direction));
return ret;
}
+ /// <summary>
+ /// Sets and Gets WrapEnabled property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool WrapEnabled
{
get
SetProperty(ScrollView.Property.WRAP_ENABLED, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets PanningEnabled property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool PanningEnabled
{
get
SetProperty(ScrollView.Property.PANNING_ENABLED, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets AxisAutoLockEnabled property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool AxisAutoLockEnabled
{
get
SetProperty(ScrollView.Property.AXIS_AUTO_LOCK_ENABLED, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets WheelScrollDistanceStep property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 WheelScrollDistanceStep
{
get
SetProperty(ScrollView.Property.WHEEL_SCROLL_DISTANCE_STEP, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollPosition property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPosition
{
get
SetProperty(ScrollView.Property.SCROLL_POSITION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollPrePosition property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPrePosition
{
get
SetProperty(ScrollView.Property.SCROLL_PRE_POSITION, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollPrePositionMax property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPrePositionMax
{
get
SetProperty(ScrollView.Property.SCROLL_PRE_POSITION_MAX, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets OvershootX property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float OvershootX
{
get
SetProperty(ScrollView.Property.OVERSHOOT_X, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets OvershootY property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float OvershootY
{
get
SetProperty(ScrollView.Property.OVERSHOOT_Y, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollFinal property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollFinal
{
get
SetProperty(ScrollView.Property.SCROLL_FINAL, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets Wrap property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Wrap
{
get
SetProperty(ScrollView.Property.WRAP, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets Panning property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Panning
{
get
SetProperty(ScrollView.Property.PANNING, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets Scrolling property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Scrolling
{
get
SetProperty(ScrollView.Property.SCROLLING, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollDomainSize property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollDomainSize
{
get
SetProperty(ScrollView.Property.SCROLL_DOMAIN_SIZE, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollDomainOffset property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollDomainOffset
{
get
SetProperty(ScrollView.Property.SCROLL_DOMAIN_OFFSET, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollPositionDelta property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 ScrollPositionDelta
{
get
SetProperty(ScrollView.Property.SCROLL_POSITION_DELTA, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Sets and Gets StartPagePosition property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 StartPagePosition
{
get
}
}
+
+ /// <summary>
+ /// Sets and Gets ScrollMode property.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap ScrollMode
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// Slider is a control to enable sliding an indicator between two values.
+ /// The slider is a control to enable sliding an indicator between two values.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Slider : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Value changed event arguments.
+ /// The ValueChanged event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ValueChangedEventArgs : EventArgs
{
private Slider _slider;
private float _slideValue;
/// <summary>
- /// Slider.
+ /// The slider.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Slider Slider
{
get
}
/// <summary>
- /// Slider value.
+ /// The slider value.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SlideValue
{
get
}
/// <summary>
- /// Sliding finished event arguments.
+ /// The SlidingFinished event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SlidingFinishedEventArgs : EventArgs
{
private Slider _slider;
private float _slideValue;
/// <summary>
- /// Slider.
+ /// The slider.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Slider Slider
{
get
}
/// <summary>
- /// Slider value.
+ /// The slider value.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SlideValue
{
get
}
/// <summary>
- /// Mark reached event arguments.
+ /// The MarkReached event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class MarkReachedEventArgs : EventArgs
{
private Slider _slider;
private int _slideValue;
/// <summary>
- /// Slider.
+ /// The slider.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Slider Slider
{
get
}
/// <summary>
- /// Slider value.
+ /// The slider value.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int SlideValue
{
get
private MarkReachedCallbackDelegate _sliderMarkReachedCallbackDelegate;
/// <summary>
- /// Event emitted when the slider value changes.
+ /// An event emitted when the slider value changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, ValueChangedEventArgs, bool> ValueChanged
{
add
}
/// <summary>
- /// Event emitted when the sliding is finished.
+ /// An event emitted when the sliding is finished.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, SlidingFinishedEventArgs, bool> SlidingFinished
{
add
}
/// <summary>
- /// Event emitted when the slider handle reaches a mark.
+ /// An event emitted when the slider handle reaches a mark.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandlerWithReturnType<object, MarkReachedEventArgs, bool> MarkReached
{
add
}
/// <summary>
- /// Get Slider from the pointer.
+ /// Gets the slider from the pointer.
/// </summary>
- /// <param name="cPtr">The pointer of Slider</param>
- /// <returns>Object of Slider type</returns>
+ /// <param name="cPtr">The pointer of the slider.</param>
+ /// <returns>The object of the slider type.</returns>
internal static Slider GetSliderFromPtr(global::System.IntPtr cPtr)
{
Slider ret = new Slider(cPtr, false);
return ret;
}
- internal class Property : global::System.IDisposable
+ internal new class Property : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
protected bool swigCMemOwn;
}
}
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
/// <summary>
- /// Creates the Slider control.
+ /// Creates the slider control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Slider() : this(NDalicPINVOKE.Slider_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Downcasts an Object handle to Slider.<br>
- /// If handle points to a Slider, the downcast produces valid handle.<br>
- /// If not, the returned handle is left uninitialized.<br>
+ /// Downcasts an object handle to the slider.<br />
+ /// If the handle points to a slider, then the downcast produces a valid handle.<br />
+ /// If not, then the returned handle is left uninitialized.<br />
/// </summary>
- /// <param name="handle">Handle to an object</param>
- /// <returns>Handle to a Slider or an uninitialized handle</returns>
+ /// <param name="handle">The handle to an object.</param>
+ /// <returns>The handle to a slider or an uninitialized handle.</returns>
+ /// <since_tizen> 3 </since_tizen>
public new static Slider DownCast(BaseHandle handle)
{
Slider ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Slider;
}
/// <summary>
- /// Lower bound property
+ /// The lower bound property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float LowerBound
{
get
}
/// <summary>
- /// Upper bound property
+ /// The upper bound property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float UpperBound
{
get
}
/// <summary>
- /// Value property
+ /// The value property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Value
{
get
}
/// <summary>
- /// Track visual property
+ /// The track visual property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap TrackVisual
{
get
}
/// <summary>
- /// Handle visual property
+ /// The handle visual property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap HandleVisual
{
get
}
/// <summary>
- /// Progress visual property
+ /// The progress visual property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap ProgressVisual
{
get
}
/// <summary>
- /// Popup visual property
+ /// The popup visual property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap PopupVisual
{
get
}
/// <summary>
- /// Popup arrow visual property
+ /// The popup arrow visual property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap PopupArrowVisual
{
get
}
/// <summary>
- /// Disable color property
+ /// The disable color property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 DisabledColor
{
get
}
/// <summary>
- /// Value presicion property
+ /// The value precision property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int ValuePrecision
{
get
}
/// <summary>
- /// Show popup property
+ /// The show popup property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool ShowPopup
{
get
}
/// <summary>
- /// Show value property
+ /// The show value property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool ShowValue
{
get
}
/// <summary>
- /// Marks property
+ /// The marks property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray Marks
{
get
}
/// <summary>
- /// Snap to marks property
+ /// The snap to marks property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SnapToMarks
{
get
}
/// <summary>
- /// Mark tolerance property
+ /// The mark tolerance property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float MarkTolerance
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using Tizen.NUI.BaseComponents;
namespace Tizen.NUI
{
+ /// <summary>
+ /// A ToggleButton allows the user to change a setting between two or more states.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ToggleButton : Tizen.NUI.UIComponents.Button
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
- public class Property
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ public new class Property
{
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int STATE_VISUALS = NDalicPINVOKE.ToggleButton_Property_STATE_VISUALS_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int TOOLTIPS = NDalicPINVOKE.ToggleButton_Property_TOOLTIPS_get();
+ /// <summary>
+ /// This should be internal, please do not use.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int CURRENT_STATE_INDEX = NDalicPINVOKE.ToggleButton_Property_CURRENT_STATE_INDEX_get();
}
+ /// <summary>
+ /// Create an instance for toggleButton.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ToggleButton() : this(NDalicPINVOKE.ToggleButton_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Gets and Sets the state visual array of toggle button.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray StateVisuals
{
get
SetProperty(ToggleButton.Property.STATE_VISUALS, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets the tooltips of toggle button.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray Tooltips
{
get
SetProperty(ToggleButton.Property.TOOLTIPS, new Tizen.NUI.PropertyValue(value));
}
}
+
+ /// <summary>
+ /// Gets and Sets the current state index of toggle button.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int CurrentStateIndex
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A two dimensional vector.
+ /// A two-dimensional vector.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Vector2 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Vector2(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Vector2()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator +(Vector2 arg1, Vector2 arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator -(Vector2 arg1, Vector2 arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Target Value</param>
- /// <returns>A vector containg the negation</returns>
+ /// <param name="arg1">The target value.</param>
+ /// <returns>The vector containing the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator -(Vector2 arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator *(Vector2 arg1, Vector2 arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// Th multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator *(Vector2 arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator /(Vector2 arg1, Vector2 arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// Th division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 operator /(Vector2 arg1, float arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator overload.
+ /// The array subscript operator overload.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Default constructor, initializes the vector to 0.
+ /// The default constructor initializes the vector to 0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="x">x or width component</param>
- /// <param name="y">y or height component</param>
+ /// <param name="x">The x or width component.</param>
+ /// <param name="y">The y or height component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector2(float x, float y) : this(NDalicPINVOKE.new_Vector2__SWIG_1(x, y), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Conversion constructor from an array of two floats.
+ /// The conversion constructor from an array of two floats.
/// </summary>
- /// <param name="array">Array of xy</param>
+ /// <param name="array">The array of xy.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector2(float[] array) : this(NDalicPINVOKE.new_Vector2__SWIG_2(array), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="vec3">Vector3 to create this vector from</param>
+ /// <param name="vec3">Vector3 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector2(Vector3 vec3) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Vector3.getCPtr(vec3)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="vec4">Vector4 to create this vector from</param>
+ /// <param name="vec4">Vector4 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector2(Vector4 vec4) : this(NDalicPINVOKE.new_Vector2__SWIG_4(Vector4.getCPtr(vec4)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// (1.0f,1.0f)
+ /// (1.0f,1.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 One
{
get
}
/// <summary>
- /// Vector representing the X axis
+ /// The vector representing the x-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 XAxis
{
get
}
/// <summary>
- /// Vector representing the Y axis
+ /// The vector representing the y-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 YAxis
{
get
}
/// <summary>
- /// Vector representing the negative X axis
+ /// The vector representing the negative x-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 NegativeXAxis
{
get
}
/// <summary>
- /// Vector representing the negative Y axis
+ /// The vector representing the negative y-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 NegativeYAxis
{
get
}
/// <summary>
- /// (0.0f, 0.0f)
+ /// (0.0f, 0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector2 Zero
{
get
/// <summary>
/// Returns the length of the vector.
/// </summary>
- /// <returns>The length of the vector</returns>
+ /// <returns>The length of the vector.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float Length()
{
float ret = NDalicPINVOKE.Vector2_Length(swigCPtr);
}
/// <summary>
- /// Returns the length of the vector squared.<br>
+ /// Returns the length of the vector squared.<br />
/// This is more efficient than Length() for threshold
- /// testing as it avoids the use of a square root.<br>
+ /// testing as it avoids the use of a square root.<br />
/// </summary>
/// <returns>The length of the vector squared</returns>
+ /// <since_tizen> 3 </since_tizen>
public float LengthSquared()
{
float ret = NDalicPINVOKE.Vector2_LengthSquared(swigCPtr);
}
/// <summary>
- /// Sets the vector to be unit length, whilst maintaining its direction.
+ /// Sets the vector to be the unit length, whilst maintaining its direction.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Normalize()
{
NDalicPINVOKE.Vector2_Normalize(swigCPtr);
/// <summary>
/// Clamps the vector between minimum and maximum vectors.
/// </summary>
- /// <param name="min">The minimum vector</param>
- /// <param name="max">The maximum vector</param>
+ /// <param name="min">The minimum vector.</param>
+ /// <param name="max">The maximum vector.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Clamp(Vector2 min, Vector2 max)
{
NDalicPINVOKE.Vector2_Clamp(swigCPtr, Vector2.getCPtr(min), Vector2.getCPtr(max));
}
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// width
+ /// The width.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Width
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// height
+ /// The height.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Height
{
set
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A three dimensional vector.
+ /// A three-dimensional vector.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Vector3 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Vector3(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Vector3()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator +(Vector3 arg1, Vector3 arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator -(Vector3 arg1, Vector3 arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Target Value</param>
- /// <returns>A vector containg the negation</returns>
+ /// <param name="arg1">The target value.</param>
+ /// <returns>The vector containg the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator -(Vector3 arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator *(Vector3 arg1, Vector3 arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator *(Vector3 arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator /(Vector3 arg1, Vector3 arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 operator /(Vector3 arg1, float arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator overload.
+ /// An array subscript operator overload.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Default constructor, initializes the vector to 0.
+ /// The default constructor initializes the vector to 0.
/// </summary>
- /// <param name="x">x (or width) component</param>
- /// <param name="y">y (or height) component</param>
- /// <param name="z">z (or depth) component</param>
+ /// <param name="x">The x (or width) component.</param>
+ /// <param name="y">The y (or height) component.</param>
+ /// <param name="z">The z (or depth) component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Conversion constructor from an array of three floats.
/// </summary>
- /// <param name="array">Array of xyz</param>
+ /// <param name="array">An array of xyz.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3(float[] array) : this(NDalicPINVOKE.new_Vector3__SWIG_2(array), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="vec2">Vector2 to create this vector from</param>
+ /// <param name="vec2">Vector2 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3(Vector2 vec2) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Vector2.getCPtr(vec2)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="vec4">Vector4 to create this vector from</param>
+ /// <param name="vec4">Vector4 to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector3(Vector4 vec4) : this(NDalicPINVOKE.new_Vector3__SWIG_4(Vector4.getCPtr(vec4)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// (1.0f,1.0f,1.0f)
+ /// (1.0f,1.0f,1.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 One
{
get
}
/// <summary>
- /// Vector representing the X axis
+ /// The vector representing the x-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 XAxis
{
get
}
/// <summary>
- /// Vector representing the Y axis
+ /// The vector representing the y-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 YAxis
{
get
}
/// <summary>
- /// Vector representing the Z axis
+ /// The vector representing the z-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 ZAxis
{
get
}
/// <summary>
- /// Vector representing the negative X axis
+ /// The vector representing the negative x-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 NegativeXAxis
{
get
}
/// <summary>
- /// Vector representing the negative Y axis
+ /// Th vector representing the negative y-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 NegativeYAxis
{
get
}
/// <summary>
- /// Vector representing the negative Z axis
+ /// The vector representing the negative z-axis.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 NegativeZAxis
{
get
}
/// <summary>
- /// (0.0f, 0.0f, 0.0f)
+ /// (0.0f, 0.0f, 0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector3 Zero
{
get
/// <summary>
/// Returns the length of the vector.
/// </summary>
- /// <returns>The length of the vector</returns>
+ /// <returns>The length of the vector.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float Length()
{
float ret = NDalicPINVOKE.Vector3_Length(swigCPtr);
}
/// <summary>
- /// Returns the length of the vector squared.<br>
+ /// Returns the length of the vector squared.<br />
/// This is more efficient than Length() for threshold
- /// testing as it avoids the use of a square root.<br>
+ /// testing as it avoids the use of a square root.<br />
/// </summary>
- /// <returns>The length of the vector squared</returns>
+ /// <returns>The length of the vector squared.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float LengthSquared()
{
float ret = NDalicPINVOKE.Vector3_LengthSquared(swigCPtr);
/// <summary>
/// Sets the vector to be unit length, whilst maintaining its direction.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Normalize()
{
NDalicPINVOKE.Vector3_Normalize(swigCPtr);
/// <summary>
/// Clamps the vector between minimum and maximum vectors.
/// </summary>
- /// <param name="min">The minimum vector</param>
- /// <param name="max">The maximum vector</param>
+ /// <param name="min">The minimum vector.</param>
+ /// <param name="max">The maximum vector.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Clamp(Vector3 min, Vector3 max)
{
NDalicPINVOKE.Vector3_Clamp(swigCPtr, Vector3.getCPtr(min), Vector3.getCPtr(max));
}
/// <summary>
- /// Returns the x & y components (or width & height, or r & g) as a Vector2.
+ /// Returns the x and y components (or width and height, or r and g) as a Vector2.
/// </summary>
- /// <returns>The partial vector contents as Vector2 (x,y)</returns>
+ /// <returns>The partial vector contents as Vector2 (x,y).</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetVectorXY()
{
Vector2 ret = new Vector2(NDalicPINVOKE.Vector3_GetVectorXY__SWIG_0(swigCPtr), false);
}
/// <summary>
- /// Returns the y & z components (or height & depth, or g & b) as a Vector2.
+ /// Returns the y and z components (or height and depth, or g and b) as a Vector2.
/// </summary>
- /// <returns>The partial vector contents as Vector2 (y,z)</returns>
+ /// <returns>The partial vector contents as Vector2 (y,z).</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetVectorYZ()
{
Vector2 ret = new Vector2(NDalicPINVOKE.Vector3_GetVectorYZ__SWIG_0(swigCPtr), false);
}
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// width component
+ /// The width component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Width
{
set
}
/// <summary>
- /// red component
+ /// The red component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float R
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// height component
+ /// The height component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Height
{
set
}
/// <summary>
- /// green component
+ /// The green component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float G
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
}
/// <summary>
- /// depth component
+ /// The depth component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Depth
{
set
}
/// <summary>
- /// blue component
+ /// The blue component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float B
{
set
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// A four dimensional vector.
+ /// A four-dimensional vector.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Vector4 : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Vector4(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Vector4()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator +(Vector4 arg1, Vector4 arg2)
{
return arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">First value</param>
- /// <param name="arg2">Second value</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator -(Vector4 arg1, Vector4 arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Target Value</param>
- /// <returns>A vector containg the negation</returns>
+ /// <param name="arg1">The target value.</param>
+ /// <returns>The vector containing the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator -(Vector4 arg1)
{
return arg1.Subtract();
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator *(Vector4 arg1, Vector4 arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator *(Vector4 arg1, float arg2)
{
return arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">Second Value</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The second value.</param>
+ /// <returns>The vector containing the result of the division.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator /(Vector4 arg1, Vector4 arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">First Value</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The first value.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 operator /(Vector4 arg1, float arg2)
{
return arg1.Divide(arg2);
}
/// <summary>
- /// Array subscript operator overload.
+ /// The array subscript operator overload.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
/// <summary>
- /// Default constructor, initializes the vector to 0.
+ /// The default constructor initializes the vector to 0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4() : this(NDalicPINVOKE.new_Vector4__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Conversion constructor from four floats.
+ /// The conversion constructor from four floats.
/// </summary>
- /// <param name="x">x (or r/s) component</param>
- /// <param name="y">y (or g/t) component</param>
- /// <param name="z">z (or b/p) component</param>
- /// <param name="w">w (or a/q) component</param>
+ /// <param name="x">The x (or r/s) component.</param>
+ /// <param name="y">The y (or g/t) component.</param>
+ /// <param name="z">The z (or b/p) component.</param>
+ /// <param name="w">The w (or a/q) component.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector4(float x, float y, float z, float w) : this(NDalicPINVOKE.new_Vector4__SWIG_1(x, y, z, w), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Conversion constructor from an array of four floats.
+ /// The conversion constructor from an array of four floats.
/// </summary>
- /// <param name="array">array Array of either xyzw/rgba/stpq</param>
+ /// <param name="array">The array of either xyzw/rgba/stpq.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector4(float[] array) : this(NDalicPINVOKE.new_Vector4__SWIG_2(array), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Conversion constructor from Vector2.
+ /// The conversion constructor from Vector2.
/// </summary>
- /// <param name="vec2">Vector2 to copy from, z and w are initialized to 0</param>
+ /// <param name="vec2">Vector2 to copy from, z and w are initialized to 0.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector4(Vector2 vec2) : this(NDalicPINVOKE.new_Vector4__SWIG_3(Vector2.getCPtr(vec2)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Conversion constructor from Vector3.
+ /// The conversion constructor from Vector3.
/// </summary>
- /// <param name="vec3">Vector3 to copy from, w is initialized to 0</param>
+ /// <param name="vec3">Vector3 to copy from, w is initialized to 0.</param>
+ /// <since_tizen> 3 </since_tizen>
public Vector4(Vector3 vec3) : this(NDalicPINVOKE.new_Vector4__SWIG_4(Vector3.getCPtr(vec3)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// (1.0f,1.0f,1.0f,1.0f)
+ /// (1.0f,1.0f,1.0f,1.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 One
{
get
}
/// <summary>
- /// (1.0f,0.0f,0.0f,0.0f)
+ /// (1.0f,0.0f,0.0f,0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 XAxis
{
get
}
/// <summary>
- /// (0.0f,1.0f,0.0f,0.0f)
+ /// (0.0f,1.0f,0.0f,0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 YAxis
{
get
}
/// <summary>
- /// (0.0f,0.0f,1.0f,0.0f)
+ /// (0.0f,0.0f,1.0f,0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 ZAxis
{
get
}
/// <summary>
- /// (0.0f, 0.0f, 0.0f, 0.0f)
+ /// (0.0f, 0.0f, 0.0f, 0.0f).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Vector4 Zero
{
get
/// <summary>
/// Returns the length of the vector.
/// </summary>
- /// <returns>The length</returns>
+ /// <returns>The length.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float Length()
{
float ret = NDalicPINVOKE.Vector4_Length(swigCPtr);
}
/// <summary>
- /// Returns the length of the vector squared.<br>
+ /// Returns the length of the vector squared.<br />
/// This is faster than using Length() when performing
- /// threshold checks as it avoids use of the square root.<br>
+ /// threshold checks as it avoids use of the square root.<br />
/// </summary>
- /// <returns>The length of the vector squared</returns>
+ /// <returns>The length of the vector squared.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float LengthSquared()
{
float ret = NDalicPINVOKE.Vector4_LengthSquared(swigCPtr);
}
/// <summary>
- /// Normalizes the vector.<br>
- /// Sets the vector to unit length whilst maintaining its direction.<br>
+ /// Normalizes the vector.<br />
+ /// Sets the vector to unit length whilst maintaining its direction.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Normalize()
{
NDalicPINVOKE.Vector4_Normalize(swigCPtr);
/// <summary>
/// Clamps the vector between minimum and maximum vectors.
/// </summary>
- /// <param name="min">The minimum vector</param>
- /// <param name="max">The maximum vector</param>
+ /// <param name="min">The minimum vector.</param>
+ /// <param name="max">The maximum vector.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Clamp(Vector4 min, Vector4 max)
{
NDalicPINVOKE.Vector4_Clamp(swigCPtr, Vector4.getCPtr(min), Vector4.getCPtr(max));
}
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// red component
+ /// The red component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float R
{
set
}
/// <summary>
- /// s component
+ /// The s component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float S
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// green component
+ /// The green component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float G
{
set
}
/// <summary>
- /// t component
+ /// The t component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float T
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
}
/// <summary>
- /// blue component
+ /// The blue component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float B
{
set
}
/// <summary>
- /// p component
+ /// The p component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float P
{
set
}
/// <summary>
- /// w component
+ /// The w component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float W
{
set
}
/// <summary>
- /// alpha component
+ /// The alpha component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float A
{
set
}
/// <summary>
- /// q component
+ /// The q component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Q
{
set
namespace Tizen.NUI
{
+ /// <summary>
+ /// ViewWrapper.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ViewWrapper : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI
{
/// <summary>
- /// Sets whether the actor should be focusable by keyboard navigation.<br>
- /// Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on-window.<br>
- /// Each visual also responds to actor size and color change, and provides clipping at the renderer level.<br>
+ /// Sets whether the actor should be focusable by keyboard navigation.<br />
+ /// Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on window.<br />
+ /// Each visual also responds to actor size and color change, and provides clipping at the renderer level.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VisualBase : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The dispose type</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if(disposed)
}
/// <summary>
- /// Create an empty Visual Handle
+ /// Creates an empty visual handle.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualBase() : this(NDalicPINVOKE.new_VisualBase__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// name of the visual
+ /// The name of the visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
set
}
/// <summary>
- /// Sets the transform and the control size
+ /// Sets the transform and the control size.
/// </summary>
- /// <param name="transform">A property map describing the transform</param>
+ /// <param name="transform">A property map describing the transform.</param>
/// <param name="controlSize">The size of the parent control for visuals that need to scale internally.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetTransformAndSize(PropertyMap transform, Vector2 controlSize)
{
NDalicPINVOKE.VisualBase_SetTransformAndSize(swigCPtr, PropertyMap.getCPtr(transform), Vector2.getCPtr(controlSize));
/// <summary>
/// Returns the height for a given width.
/// </summary>
- /// <param name="width">Width to use.</param>
+ /// <param name="width">The width to use.</param>
/// <returns>The height based on the width.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetHeightForWidth(float width)
{
float ret = NDalicPINVOKE.VisualBase_GetHeightForWidth(swigCPtr, width);
/// <summary>
/// Returns the width for a given height.
/// </summary>
- /// <param name="height">Height to use.</param>
+ /// <param name="height">The height to use.</param>
/// <returns>The width based on the height.</returns>
+ /// <since_tizen> 3 </since_tizen>
public float GetWidthForHeight(float height)
{
float ret = NDalicPINVOKE.VisualBase_GetWidthForHeight(swigCPtr, height);
}
/// <summary>
- /// Return the natural size of the visual.<br>
- /// Deriving classes stipulate the natural size and by default a visual has a ZERO natural size.<br>
- /// A visual may not actually have a natural size until it has been placed on window and acquired all it's resources.<br>
+ /// Returns the natural size of the visual.<br />
+ /// Deriving classes stipulate the natural size and by default a visual has a zero natural size.<br />
+ /// A visual may not actually have a natural size until it has been placed on window and acquired all it's resources.<br />
/// </summary>
- /// <param name="naturalSize">The visual's natural size</param>
+ /// <param name="naturalSize">The visual's natural size.</param>
+ /// <since_tizen> 3 </since_tizen>
public void GetNaturalSize(Size2D naturalSize)
{
NDalicPINVOKE.VisualBase_GetNaturalSize(swigCPtr, Size2D.getCPtr(naturalSize));
}
/// <summary>
- /// the depth index of this visual.
+ /// The depth index of this visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthIndex
{
set
}
/// <summary>
- /// Create the property map representing this visual.
+ /// Creates the property map representing this visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Creation
{
get
return map;
}
}
+
internal void CreatePropertyMap(PropertyMap map)
{
NDalicPINVOKE.VisualBase_CreatePropertyMap(swigCPtr, PropertyMap.getCPtr(map));
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
/// <summary>
- /// VisualFactory is a singleton object that provides and shares visuals between views
+ /// The VisualFactory is a singleton object that provides and shares visuals between views.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VisualFactory : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
protected override void Dispose(DisposeTypes type)
{
- if(disposed)
+ if (disposed)
{
return;
}
- if(type == DisposeTypes.Explicit)
+ if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
base.Dispose(type);
}
-
- [Obsolete("Please do not use! this will be deprecated, please use VisualFactory.Instance instead")]
+ /// <summary>
+ /// Please do not use! this will be deprecated, please use VisualFactory.Instance instead.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use VisualFactory.Instance instead! " +
+ "Like: " +
+ "VisualFactory visualFactory = VisualFactory.Instance; " +
+ "visualFactory.CreateVisual(visualMap);")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public static VisualFactory Get()
{
VisualFactory ret = new VisualFactory(NDalicPINVOKE.VisualFactory_Get(), true);
/// <summary>
- /// Request the visual
+ /// Request the visual.
/// </summary>
/// <param name="propertyMap">The map contains the properties required by the visual. The content of the map determines the type of visual that will be returned.</param>
- /// <returns>The handle to the created visual</returns>
+ /// <returns>The handle to the created visual.</returns>
+ /// <since_tizen> 3 </since_tizen>
public VisualBase CreateVisual(PropertyMap propertyMap)
{
VisualBase ret = new VisualBase(NDalicPINVOKE.VisualFactory_CreateVisual__SWIG_0(swigCPtr, PropertyMap.getCPtr(propertyMap)), true);
private static readonly VisualFactory instance = VisualFactory.Get();
/// <summary>
- /// retrieve VisualFactory singleton.
+ /// Retrieves the VisualFactory singleton.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static VisualFactory Instance
{
get
-// Copyright (c) 2017 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System.Text;
+using System.Collections.Generic;
+using Tizen.NUI.BaseComponents;
+using System.ComponentModel;
namespace Tizen.NUI
{
- using System.Collections.Generic;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// A class encapsulating the transform map of visual.
+ /// A class encapsulating the transform map of the visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VisualMap
{
private Vector2 _visualSize = null;
private PropertyMap _visualTransformMap = null;
private int? _depthIndex = null;
+
+ /// <summary>
+ /// outputVisualMap.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected PropertyMap _outputVisualMap = null;
internal string Name
get;
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualMap()
{
}
/// <summary>
- /// Get or set size of the visual.<br>
+ /// Gets or sets the size of the visual.<br />
/// It can be either relative (percentage of the parent)
- /// or absolute (in world units).<br>
+ /// or absolute (in world units).<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D Size
{
get
}
/// <summary>
- /// Get or set offset of the visual.<br>
+ /// Gets or sets the offset of the visual.<br />
/// It can be either relative (percentage of the parent)
- /// or absolute (in world units).<br>
+ /// or absolute (in world units).<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Position
{
get
}
/// <summary>
- /// Get or set relative size of the visual<br>
- /// (percentage [0.0f to 1.0f] of the control).<br>
+ /// Gets or sets the relative size of the visual<br />
+ /// (percentage [0.0f to 1.0f] of the control).<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2 RelativeSize
{
get
}
/// <summary>
- /// Get or set relative offset of the visual<br>
- /// (percentage [0.0f to 1.0f] of the control).<br>
+ /// Gets or sets the relative offset of the visual<br />
+ /// (percentage [0.0f to 1.0f] of the control).<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector2 RelativePosition
{
get
}
/// <summary>
- /// Get or set whether the x and y offset values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, both the x and the y offset is relative.<br>
+ /// Gets or sets whether the x and y offset values are relative<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, both the x and the y offset are relative.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType PositionPolicy
{
get
}
/// <summary>
- /// Get or set whether the x offset values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, the x offset is relative.<br>
+ /// Gets or sets whether the x offset values are relative<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, the x offset is relative.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType PositionPolicyX
{
get
}
/// <summary>
- /// Get or set whether the y offset values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, the y offset is relative.<br>
+ /// Gets or sets whether the y offset values are relative<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, the y offset is relative.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType PositionPolicyY
{
get
}
/// <summary>
- /// Get or set whether the width or height size values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, both the width and the height offset is relative to the control's size.<br>
+ /// Gets or sets whether the size values of the width or the height are relative<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, offsets of both the width and the height are relative to the control's size.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType SizePolicy
{
get
}
/// <summary>
- /// Get or set whether the width size values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, the width value is relative to the control's width.<br>
+ /// Gets or sets whether size values of the width are relative.<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, the value of the width is relative to the control's width.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType SizePolicyWidth
{
get
}
/// <summary>
- /// Get or set whether the height size values are relative<br>
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br>
- /// Be default, both the height value is relative to the control's height.<br>
+ /// Gets or sets whether size values of the height are relative<br />
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).<br />
+ /// By default, the height value is relative to the control's height.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualTransformPolicyType SizePolicyHeight
{
get
}
/// <summary>
- /// Get or set the origin of the visual within its control area.<br>
- /// By default, the origin is Center.<br>
+ /// Gets or sets the origin of the visual within its control area.<br />
+ /// By default, the origin is center.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Visual.AlignType Origin
{
get
}
/// <summary>
- /// Get or set the anchor-point of the visual.<br>
- /// By default, the anchor point is Center.<br>
+ /// Gets or sets the anchor point of the visual.<br />
+ /// By default, the anchor point is center.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Visual.AlignType AnchorPoint
{
get
}
/// <summary>
- /// Get or set the depth index of the visual.<br>
- /// By default, the depth index is 0.<br>
+ /// Gets or sets the depth index of the visual.<br />
+ /// By default, the depth index is 0.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DepthIndex
{
get
}
/// <summary>
- /// Get the transform map used by the visual.
+ /// Gets the transform map used by the visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap OutputTransformMap
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void ComposingPropertyMap()
{
_outputVisualMap = new PropertyMap();
}
/// <summary>
- /// Get the property map to create the visual.
+ /// Gets the property map to create the visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap OutputVisualMap
{
get
}
}
+ /// <summary>
+ /// The shader of the visual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected PropertyMap _shader = null;
//private PropertyMap _transform = null;
+
+ /// <summary>
+ /// The premultipliedAlpha of the visual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool? _premultipliedAlpha = null;
+
+ /// <summary>
+ /// The mixColor of the Visual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected Color _mixColor = null;
+
+ /// <summary>
+ /// The opacity of the visual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected float? _opacity = null;
+
+ /// <summary>
+ /// The map for visual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected PropertyMap _commonlyUsedMap = null;
/// <summary>
/// The shader to use in the visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap Shader
{
get
}
/// <summary>
- /// Enables/disables premultiplied alpha. <br>
- /// The premultiplied alpha is false by default unless this behaviour is modified by the derived Visual type.
+ /// Enables or disables the premultiplied alpha. <br />
+ /// The premultiplied alpha is false by default unless this behavior is modified by the derived visual type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool PremultipliedAlpha
{
get
/// <summary>
/// Mix color is a blend color for any visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color MixColor
{
get
}
/// <summary>
- /// Opacity is the alpha component of the mixColor, above.
+ /// Opacity is the alpha component of the mix color discussed above.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Opacity
{
get
}
/// <summary>
- /// A class encapsulating the property map of a image visual.
+ /// A class encapsulating the property map of the image visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImageVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImageVisual() : base()
{
}
private bool? _orientationCorrection = true;
/// <summary>
- /// Get or set the URL of the image.<br>
+ /// Gets or sets the URL of the image.<br />
/// Mandatory.
/// </summary>
-
+ /// <since_tizen> 3 </since_tizen>
public string URL
{
get
/// <summary>
- /// Get or set the URL of the alpha mask.<br>
+ /// Gets or sets the URL of the alpha mask.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string AlphaMaskURL
{
get
}
/// <summary>
- /// Get or set fitting options, used when resizing images to fit desired dimensions.<br>
- /// If not supplied, default is FittingModeType.ShrinkToFit.<br>
- /// For Normal Quad images only.<br>
+ /// Gets or sets fitting options used when resizing images to fit the desired dimensions.<br />
+ /// If not supplied, the default is FittingModeType.ShrinkToFit.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public FittingModeType FittingMode
{
get
}
/// <summary>
- /// Get or set filtering options, used when resizing images to sample original pixels.<br>
- /// If not supplied, default is SamplingModeType.Box.<br>
- /// For Normal Quad images only.<br>
+ /// Gets or sets filtering options used when resizing images to the sample original pixels.<br />
+ /// If not supplied, the default is SamplingModeType.Box.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public SamplingModeType SamplingMode
{
get
}
/// <summary>
- /// Get or set the desired image width.<br>
- /// If not specified, the actual image width is used.<br>
- /// For Normal Quad images only.<br>
+ /// Gets or sets the desired image width.<br />
+ /// If not specified, the actual image width is used.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DesiredWidth
{
get
}
/// <summary>
- /// Get or set the desired image height.<br>
- /// If not specified, the actual image height is used.<br>
- /// For Normal Quad images only.<br>
+ /// Gets or sets the desired image height.<br />
+ /// If not specified, the actual image height is used.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DesiredHeight
{
get
}
/// <summary>
- /// Get or set whether to load the image synchronously.<br>
- /// If not specified, the default is false, i.e. the image is loaded asynchronously.<br>
- /// For Normal Quad images only.<br>
+ /// Gets or sets whether to load the image synchronously.<br />
+ /// If not specified, the default is false, i.e., the image is loaded asynchronously.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SynchronousLoading
{
get
}
/// <summary>
- /// Get or set whether to draws the borders only(If true).<br>
- /// If not specified, the default is false.<br>
- /// For N-Patch images only.<br>
+ /// Gets or sets whether to draw the borders only (If true).<br />
+ /// If not specified, the default is false.<br />
+ /// For n-patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BorderOnly
{
get
}
/// <summary>
- /// Get or set the image area to be displayed.<br>
- /// It is a rectangular area.<br>
- /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.<br>
- /// If not specified, the default value is Vector4(0.0, 0.0, 1.0, 1.0), i.e. the entire area of the image.<br>
- /// For For Normal QUAD image only.<br>
+ /// Gets or sets the image area to be displayed.<br />
+ /// It is a rectangular area.<br />
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.<br />
+ /// If not specified, the default value is Vector4 (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image.<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector4 PixelArea
{
get
}
/// <summary>
- /// Get or set the wrap mode for u coordinate.<br>
- /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.<br>
- /// If not specified, the default is WrapModeType.Default(CLAMP).<br>
- /// For Normal QUAD image only.<br>
+ /// Gets or sets the wrap mode for the u coordinate.<br />
+ /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.<br />
+ /// If not specified, the default is WrapModeType.Default(CLAMP).<br />
+ /// For normal quad images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public WrapModeType WrapModeU
{
get
}
/// <summary>
- /// Get or set the wrap mode for v coordinate.<br>
- /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.<br>
- /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.<br>
- /// If not specified, the default is WrapModeType.Default(CLAMP).<br>
- /// For Normal QUAD image only.
+ /// Gets or sets the wrap mode for the v coordinate.<br />
+ /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.<br />
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.<br />
+ /// If not specified, the default is WrapModeType.Default(CLAMP).<br />
+ /// For normal quad images only.
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public WrapModeType WrapModeV
{
get
}
}
+ /// <summary>
+ /// Gets or sets scale factor to apply to the content image before masking.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public float MaskContentScale
{
get
}
}
+ /// <summary>
+ /// Whether to crop image to mask or scale mask to fit image.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public bool CropToMask
{
get
}
}
+
/// <summary>
- /// Get or set the Image Visual release policy<br>
- /// It decides if a texture should be released from the cache or kept to reduce loading time <br>
+ /// Get or set the Image Visual release policy<br />
+ /// It decides if a texture should be released from the cache or kept to reduce loading time <br />
/// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public ReleasePolicyType ReleasePolicy
{
get
/// <summary>
- /// Get or set the Image Visual image loading policy<br>
- /// It decides if a texture should be loaded immediately after source set or only after visual is added to window <br>
+ /// Get or set the Image Visual image loading policy<br />
+ /// It decides if a texture should be loaded immediately after source set or only after visual is added to window <br />
/// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public LoadPolicyType LoadPolicy
{
get
}
/// <summary>
- /// Get or set whether to automatically correct the orientation based on exif data.<br>
- /// If not specified, the default is true.<br>
- /// For JPEG images only.<br>
+ /// Get or set whether to automatically correct the orientation based on exif data.<br />
+ /// If not specified, the default is true.<br />
+ /// For JPEG images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public bool OrientationCorrection
{
get
}
}
+
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_url != null)
}
/// <summary>
- /// A class encapsulating the property map of a text visual.
+ /// A class encapsulating the property map of the text visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TextVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TextVisual() : base()
{
}
private bool? _enableMarkup = null;
/// <summary>
- /// Get or set the text to display in UTF-8 format.<br>
+ /// Gets or sets the text to display in the UTF-8 format.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Text
{
get
}
/// <summary>
- /// Get or set the requested font family to use.<br>
+ /// Gets or sets the requested font family to use.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string FontFamily
{
get
}
/// <summary>
- /// Get or set the requested font style to use.<br>
+ /// Gets or sets the requested font style to use.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyMap FontStyle
{
get
}
/// <summary>
- /// Get or set the size of font in points.<br>
+ /// Gets or sets the size of font in points.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float PointSize
{
get
}
/// <summary>
- /// Get or set the single-line or multi-line layout option.<br>
- /// If not specified, the default is false.<br>
+ /// Gets or sets the single-line or multi-line layout option.<br />
+ /// If not specified, the default is false.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool MultiLine
{
get
}
/// <summary>
- /// Get or set the line horizontal alignment.<br>
- /// If not specified, the default is Begin.<br>
+ /// Gets or sets the line horizontal alignment.<br />
+ /// If not specified, the default is begin.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public HorizontalAlignment HorizontalAlignment
{
get
}
/// <summary>
- /// Get or set the line vertical alignment.<br>
- /// If not specified, the default is Top.<br>
+ /// Gets or sets the line vertical alignment.<br />
+ /// If not specified, the default is top.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VerticalAlignment VerticalAlignment
{
get
}
/// <summary>
- /// Get or set the color of the text.<br>
+ /// Gets or sets the color of the text.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color TextColor
{
get
}
/// <summary>
- /// Get or set whether the mark-up processing is enabled.<br>
+ /// Gets or sets whether the mark-up processing is enabled.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool EnableMarkup
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_text != null && _pointSize != null)
}
/// <summary>
- /// A class encapsulating the property map of a border visual.
+ /// A class encapsulating the property map of the border visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class BorderVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public BorderVisual() : base()
{
}
private bool? _antiAliasing = null;
/// <summary>
- /// Get or set the color of the border.<br>
+ /// Gets or sets the color of the border.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color Color
{
get
}
/// <summary>
- /// Get or set the width of the border (in pixels).<br>
+ /// Gets or sets the width of the border (in pixels).<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float BorderSize
{
get
}
/// <summary>
- /// Get or set whether anti-aliasing of the border is required.<br>
- /// If not supplied, default is false.<br>
+ /// Gets or sets whether the anti-aliasing of the border is required.<br />
+ /// If not supplied, the default is false.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool AntiAliasing
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_color != null && _size != null)
}
/// <summary>
- /// A class encapsulating the property map of a color visual.
+ /// A class encapsulating the property map of the color visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ColorVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ColorVisual() : base()
{
}
private Color _mixColorForColorVisual = null;
/// <summary>
- /// Get or set the solid color required.<br>
+ /// Gets or sets the solid color required.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color Color
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_mixColorForColorVisual != null)
}
/// <summary>
- /// A class encapsulating the property map of a gradient visual.
+ /// A class encapsulating the property map of the gradient visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class GradientVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public GradientVisual() : base()
{
}
private GradientVisualSpreadMethodType? _spreadMethod = null;
/// <summary>
- /// Get or set the start position of a linear gradient.<br>
- /// Mandatory for Linear.<br>
+ /// Gets or sets the start position of a linear gradient.<br />
+ /// Mandatory for linear.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 StartPosition
{
get
}
/// <summary>
- /// Get or set the end position of a linear gradient.<br>
- /// Mandatory for Linear.<br>
+ /// Gets or sets the end position of a linear gradient.<br />
+ /// Mandatory for linear.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 EndPosition
{
get
}
/// <summary>
- /// Get or set the center point of a radial gradient.<br>
- /// Mandatory for Radial.<br>
+ /// Gets or sets the center point of a radial gradient.<br />
+ /// Mandatory for radial.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Center
{
get
}
/// <summary>
- /// Get or set the size of the radius of a radial gradient.<br>
- /// Mandatory for Radial.<br>
+ /// Gets or sets the size of the radius of a radial gradient.<br />
+ /// Mandatory for radial.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Radius
{
get
}
/// <summary>
- /// Get or set all the stop offsets.<br>
- /// A PropertyArray of float.<br>
- /// If not supplied, default is 0.0f and 1.0f.<br>
+ /// Gets or sets all the stop offsets.<br />
+ /// A PropertyArray of float.<br />
+ /// If not supplied, the default is 0.0f and 1.0f.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray StopOffset
{
get
}
/// <summary>
- /// Get or set the color at the stop offsets.<br>
- /// A PropertyArray of Color.<br>
- /// At least 2 values required to show a gradient.<br>
+ /// Gets or sets the color at the stop offsets.<br />
+ /// A PropertyArray of color.<br />
+ /// At least 2 values are required to show a gradient.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PropertyArray StopColor
{
get
}
/// <summary>
- /// Get or set defines the coordinate system for certain attributes of the points in a gradient.<br>
- /// If not supplied, default is GradientVisualUnitsType.ObjectBoundingBox.<br>
+ /// Gets or sets descriptions of the coordinate system for certain attributes of the points in a gradient.<br />
+ /// If not supplied, the default is GradientVisualUnitsType.ObjectBoundingBox.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public GradientVisualUnitsType Units
{
get
}
/// <summary>
- /// Get or set indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.<br>
- /// If not supplied, default is GradientVisualSpreadMethodType.Pad.<br>
+ /// Gets or sets indications of what happens if the gradient starts or ends inside the bounds of the target rectangle.<br />
+ /// If not supplied, the default is GradientVisualSpreadMethodType.Pad.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public GradientVisualSpreadMethodType SpreadMethod
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (((_startPosition != null && _endPosition != null) || (_center != null && _radius != null)) && _stopColor != null)
}
/// <summary>
- /// A class encapsulating the property map of a mesh visual.
+ /// A class encapsulating the property map of the mesh visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class MeshVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public MeshVisual() : base()
{
}
private Vector3 _lightPosition = null;
/// <summary>
- /// Get or set the location of the ".obj" file.<br>
+ /// Gets or sets the location of the ".obj" file.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string ObjectURL
{
get
}
/// <summary>
- /// Get or set the location of the ".mtl" file.<br>
- /// If not specified, then a textureless object is assumed.<br>
+ /// Gets or sets the location of the ".mtl" file.<br />
+ /// If not specified, then a textureless object is assumed.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string MaterialtURL
{
get
}
/// <summary>
- /// Get or set path to the directory the textures (including gloss and normal) are stored in.<br>
- /// Mandatory if using material.<br>
+ /// Gets or sets the path to the directory the textures (including gloss and normal) are stored in.<br />
+ /// Mandatory if using material.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string TexturesPath
{
get
}
/// <summary>
- /// Get or set the type of shading mode that the mesh will use.<br>
- /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead.<br>
- /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TexturedWithDetailedSpecularLighting first).<br>
+ /// Gets or sets the type of shading mode that the mesh will use.<br />
+ /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead.<br />
+ /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TexturedWithDetailedSpecularLighting first).<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public MeshVisualShadingModeValue ShadingMode
{
get
}
/// <summary>
- /// Get or set whether to use mipmaps for textures or not.<br>
- /// If not specified, the default is true.<br>
+ /// Gets or sets whether to use mipmaps for textures or not.<br />
+ /// If not specified, the default is true.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool UseMipmapping
{
get
}
/// <summary>
- /// Get or set whether to average normals at each point to smooth textures or not.<br>
- /// If not specified, the default is true.<br>
+ /// Gets or sets whether to average normals at each point to smooth textures or not.<br />
+ /// If not specified, the default is true.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool UseSoftNormals
{
get
}
/// <summary>
- /// Get or set the position, in stage space, of the point light that applies lighting to the model.<br>
- /// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center,
- /// and using all zeroes will place the light at the top left corner.<br>
- /// If not specified, the default is an offset outwards from the center of the screen.<br>
+ /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.<br />
+ /// This is based off the stage's dimensions, so using the width and the height of the stage halved will correspond to the center,
+ /// and using all zeroes will place the light at the top-left corner.<br />
+ /// If not specified, the default is an offset outwards from the center of the screen.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 LightPosition
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_objectURL != null)
}
/// <summary>
- /// A class encapsulating the property map of a primetive visual.
+ /// A class encapsulating the property map of the primetive visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PrimitiveVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PrimitiveVisual() : base()
{
}
private Vector3 _lightPosition = null;
/// <summary>
- /// Get or set the specific shape to render.<br>
- /// If not specified, the default is PrimitiveVisualShapeType.Sphere.<br>
+ /// Gets or sets the specific shape to render.<br />
+ /// If not specified, the default is PrimitiveVisualShapeType.Sphere.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public PrimitiveVisualShapeType Shape
{
get
}
/// <summary>
- /// Get or set the color of the shape.<br>
- /// If not specified, the default is Color(0.5, 0.5, 0.5, 1.0).<br>
- /// Applies to ALL shapes.<br>
+ /// Gets or sets the color of the shape.<br />
+ /// If not specified, the default is Color (0.5, 0.5, 0.5, 1.0).<br />
+ /// Applies to all shapes.<br />
/// Optional.
/// </summary>
- public Color MixColor
+ /// <since_tizen> 3 </since_tizen>
+ public new Color MixColor
{
get
{
}
/// <summary>
- /// Get or set the number of slices as you go around the shape.<br>
- /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object.<br>
- /// If not specified, the default is 128.<br>
- /// The range is from 1 to 255.<br>
+ /// Gets or sets the number of slices as you go around the shape.<br />
+ /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object.<br />
+ /// If not specified, the default is 128.<br />
+ /// The range is from 1 to 255.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Slices
{
get
}
/// <summary>
- /// Get or set the number of stacks as you go down the shape.<br>
- /// For spheres, 'stacks' determines how many layers there are as you go down the object.<br>
- /// If not specified, the default is 128.<br>
- /// The range is from 1 to 255.<br>
+ /// Gets or sets the number of stacks as you go down the shape.<br />
+ /// For spheres, 'stacks' determines how many layers there are as you go down the object.<br />
+ /// If not specified, the default is 128.<br />
+ /// The range is from 1 to 255.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Stacks
{
get
}
/// <summary>
- /// Get or set the scale of the radius of the top circle of a conical frustrum.<br>
- /// If not specified, the default is 1.0f.<br>
- /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum<br>
- /// Only values greater than or equal to 0.0f are accepted.<br>
+ /// Gets or sets the scale of the radius of the top circle of a conical frustrum.<br />
+ /// If not specified, the default is 1.0f.<br />
+ /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum<br />
+ /// Only values greater than or equal to 0.0f are accepted.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleTopRadius
{
get
}
/// <summary>
- /// Get or set the scale of the radius of the bottom circle of a conical frustrum.<br>
- /// If not specified, the default is 1.5f.<br>
- /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum<br>
- /// - PrimitiveVisualShapeType.Cone<br>
- /// Only values greater than or equal to 0.0f are accepted.<br>
+ /// Gets or sets the scale of the radius of the bottom circle of a conical frustrum.<br />
+ /// If not specified, the default is 1.5f.<br />
+ /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum<br />
+ /// - PrimitiveVisualShapeType.Cone<br />
+ /// Only values greater than or equal to 0.0f are accepted.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleBottomRadius
{
get
}
/// <summary>
- /// Get or set the scale of the height of a conic.<br>
- /// If not specified, the default is 3.0f.<br>
- /// Applies to:<br>
- /// - PrimitiveVisualShapeType.ConicalFrustrum<br>
- /// - PrimitiveVisualShapeType.Cone<br>
- /// - PrimitiveVisualShapeType.Cylinder<br>
- /// Only values greater than or equal to 0.0f are accepted.<br>
+ /// Gets or sets the scale of the height of a conic.<br />
+ /// If not specified, the default is 3.0f.<br />
+ /// Applies to:<br />
+ /// - PrimitiveVisualShapeType.ConicalFrustrum<br />
+ /// - PrimitiveVisualShapeType.Cone<br />
+ /// - PrimitiveVisualShapeType.Cylinder<br />
+ /// Only values greater than or equal to 0.0f are accepted.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleHeight
{
get
}
/// <summary>
- /// Get or set the scale of the radius of a cylinder.<br>
- /// If not specified, the default is 1.0f.<br>
- /// Applies to:<br>
- /// - PrimitiveVisualShapeType.Cylinder<br>
- /// Only values greater than or equal to 0.0f are accepted.<br>
+ /// Gets or sets the scale of the radius of a cylinder.<br />
+ /// If not specified, the default is 1.0f.<br />
+ /// Applies to:<br />
+ /// - PrimitiveVisualShapeType.Cylinder<br />
+ /// Only values greater than or equal to 0.0f are accepted.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ScaleRadius
{
get
}
/// <summary>
- /// Get or set the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.<br>
- /// If not specified, the default is Vector3.One.<br>
- /// Applies to:<br>
- /// - PrimitiveVisualShapeType.Cube<br>
- /// - PrimitiveVisualShapeType.Octahedron<br>
- /// - PrimitiveVisualShapeType.BevelledCube<br>
- /// Each vector3 parameter should be greater than or equal to 0.0f.<br>
+ /// Gets or sets the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.<br />
+ /// If not specified, the default is Vector3.One.<br />
+ /// Applies to:<br />
+ /// - PrimitiveVisualShapeType.Cube<br />
+ /// - PrimitiveVisualShapeType.Octahedron<br />
+ /// - PrimitiveVisualShapeType.BevelledCube<br />
+ /// Each Vector3 parameter should be greater than or equal to 0.0f.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 ScaleDimensions
{
get
}
/// <summary>
- /// Get or set determines how bevelled the cuboid should be, based off the smallest dimension.<br>
- /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.<br>
- /// If not specified, the default is 0.0f (no bevel).<br>
- /// Applies to:<br>
- /// - PrimitiveVisualShapeType.BevelledCube<br>
- /// The range is from 0.0f to 1.0f.<br>
+ /// Gets or sets determines how bevelled the cuboid should be, based off the smallest dimension.<br />
+ /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.<br />
+ /// If not specified, the default is 0.0f (no bevel).<br />
+ /// Applies to:<br />
+ /// - PrimitiveVisualShapeType.BevelledCube<br />
+ /// The range is from 0.0f to 1.0f.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float BevelPercentage
{
get
}
/// <summary>
- /// Get or set defines how smooth the bevelled edges should be.<br>
- /// If not specified, the default is 0.0f (sharp edges).<br>
- /// Applies to:<br>
- /// - PrimitiveVisualShapeType.BevelledCube<br>
- /// The range is from 0.0f to 1.0f.<br>
+ /// Gets or sets descriptions of how smooth the bevelled edges should be.<br />
+ /// If not specified, the default is 0.0f (sharp edges).<br />
+ /// Applies to:<br />
+ /// - PrimitiveVisualShapeType.BevelledCube<br />
+ /// The range is from 0.0f to 1.0f.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float BevelSmoothness
{
get
}
/// <summary>
- /// Get or set the position, in stage space, of the point light that applies lighting to the model.<br>
- /// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center,
- /// and using all zeroes will place the light at the top left corner.<br>
- /// If not specified, the default is an offset outwards from the center of the screen.<br>
- /// Applies to ALL shapes.<br>
+ /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.<br />
+ /// This is based off the stage's dimensions, so using the width and the height of the stage halved will correspond to the center,
+ /// and using all zeroes will place the light at the top-left corner.<br />
+ /// If not specified, the default is an offset outwards from the center of the screen.<br />
+ /// Applies to all shapes.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector3 LightPosition
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
_outputVisualMap = new PropertyMap(); ;
}
/// <summary>
- /// A class encapsulating the property map of a n-patch image visual.
+ /// A class encapsulating the property map of the n-patch image visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class NPatchVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public NPatchVisual() : base()
{
}
private Rectangle _border = null;
/// <summary>
- /// Get or set the URL of the image.<br>
+ /// Gets or sets the URL of the image.<br />
/// Mandatory.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string URL
{
get
}
/// <summary>
- /// Get or set whether to draws the borders only(If true).<br>
- /// If not specified, the default is false.<br>
- /// For N-Patch images only.<br>
+ /// Gets or sets whether to draw the borders only (If true).<br />
+ /// If not specified, the default is false.<br />
+ /// For n-patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BorderOnly
{
get
}
/// <summary>
- /// The border of the image in the order: left, right, bottom, top.<br>
- /// For N-Patch images only.<br>
+ /// The border of the image is in the order: left, right, bottom, top.<br />
+ /// For n-patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle Border
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_url != null)
}
/// <summary>
- /// A class encapsulating the property map of a SVG visual.
+ /// A class encapsulating the property map of the SVG visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SVGVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public SVGVisual() : base()
{
}
private string _url = null;
+ /// <summary>
+ /// The url of the svg resource.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string URL
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_url != null)
}
/// <summary>
- /// A class encapsulating the property map of a Animated Image(AGIF) visual.
+ /// A class encapsulating the property map of the animated image (AGIF) visual.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class AnimatedImageVisual : VisualMap
{
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AnimatedImageVisual() : base()
{
}
private int? _cacheSize = null;
private float? _frameDelay = null;
+ /// <summary>
+ /// Gets and Sets the url in the AnimatedImageVisual.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string URL
{
get
{
- if( _urls == null )
+ if( _urls != null )
{
return _urls[0];
}
}
}
+ /// <summary>
+ /// Gets and Sets the url list in the AnimatedImageVisual.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public List<string> URLS
{
get
}
}
+ /// <summary>
+ /// Gets and Sets the batch size for pre-loading images in the AnimatedImageVisual.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int BatchSize
{
get
}
}
+ /// <summary>
+ /// Gets and Sets the cache size for loading images in the AnimatedImageVisual.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public int CacheSize
{
get
UpdateVisual();
}
}
+
+ /// <summary>
+ /// Gets and Sets The number of milliseconds between each frame in the AnimatedImageVisual.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public float FrameDelay
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
if (_urls != null)
}
-
//temporary fix for TCT
+ /// <summary>
+ /// A class encapsulating the property map of the transition data.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VisualAnimator : VisualMap
{
+ /// <summary>
+ /// Create VisualAnimator object.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VisualAnimator() : base()
{
}
private string _propertyIndex = null;
private object _destinationValue = null;
+ /// <summary>
+ /// Sets and Gets the AlphaFunction of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public AlphaFunction.BuiltinFunctions AlphaFunction
{
get
}
}
+ /// <summary>
+ /// Sets and Gets the StartTime of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int StartTime
{
get
}
}
+ /// <summary>
+ /// Sets and Gets the EndTime of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int EndTime
{
get
}
}
+ /// <summary>
+ /// Sets and Gets the Target of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Target
{
get
}
}
+ /// <summary>
+ /// Sets and Gets the PropertyIndex of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PropertyIndex
{
get
}
}
+ /// <summary>
+ /// Sets and Gets the DestinationValue of this transition.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public object DestinationValue
{
get
}
}
+ /// <summary>
+ /// Compose the out visual map.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void ComposingPropertyMap()
{
PropertyMap _animator = new PropertyMap();
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
namespace Tizen.NUI
{
/// <summary>
/// You can get time(hour, minute, second, millisecond) and date(year, month, day)<br/>
/// on receiving timeTick signal.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class WatchTime : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool swigCMemOwn;
internal WatchTime(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Distructor.
+ /// </summary>
~WatchTime()
{
if (!isDisposeQueued)
/// <summary>
/// To make watch time instance be disposed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// you can override it to clean-up your own resources.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// Constructor.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public WatchTime() : this(NDalicManualPINVOKE.new_WatchTime(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Get the current hour.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Hour
{
get
/// Get the current hour24.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Hour24
{
get
/// Get the current minute.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Minute
{
get
/// Get the current second.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Second
{
get
/// Get the current millisecond.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Millisecond
{
get
/// Get the current year.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Year
{
get
/// Get the current month.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Month
{
get
/// Get the current day.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int Day
{
get
/// Get the current week.
/// </summary>
/// <remarks>The return value is always positive.The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public int DayOfWeek
{
get
/// If you want to see more information, please refer to the site :<br/>
/// https://en.wikipedia.org/wiki/List_of_tz_database_time_zones/
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
public string TimeZone
{
get
/// Get the daylight saving time status.
/// </summary>
/// <remarks>The WatchTime needs to be initialized.</remarks>
+ /// <since_tizen> 4 </since_tizen>
public bool DaylightSavingTimeStatus
{
get
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
/// <summary>
- /// The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.<br>
- /// There is a key modifier which relates to keys like alt, shift and control functions are supplied to check if they have been pressed when the wheel is being rolled.<br>
- /// We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.<br>
- /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.<br>
+ /// The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.<br />
+ /// There is a key modifier which relates to keys like Alt, Shift, and Ctrl functions are supplied to check if they have been pressed when the wheel is being rolled.<br />
+ /// We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.<br />
+ /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Wheel : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Wheel(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
+ /// <summary>
+ /// Destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Wheel()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The type dispose, it could be from user, or called by DisposeQueue.</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// The type of the wheel event
+ /// The type of the wheel event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel.WheelType Type
{
get
}
/// <summary>
- /// he direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
+ /// The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Direction
{
get
}
/// <summary>
- /// Modifier keys pressed during the event (such as shift, alt and control)
+ /// Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Modifiers
{
get
}
/// <summary>
- /// The co-ordinates of the cursor relative to the top-left of the screen
+ /// The coordinates of the cursor relative to the top-left of the screen.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Point
{
get
}
/// <summary>
- /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
+ /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Z
{
get
}
/// <summary>
- /// The time the wheel is being rolled
+ /// The time the wheel is being rolled.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint TimeStamp
{
get
}
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel() : this(NDalicPINVOKE.new_Wheel__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="type">The type of the wheel event</param>
- /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)</param>
- /// <param name="modifiers">Modifier keys pressed during the event (such as shift, alt and control)</param>
- /// <param name="point">The co-ordinates of the cursor relative to the top-left of the screen</param>
- /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)</param>
- /// <param name="timeStamp">The time the wheel is being rolled</param>
+ /// <param name="type">The type of the wheel event.</param>
+ /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).</param>
+ /// <param name="modifiers">Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).</param>
+ /// <param name="point">The coordinates of the cursor relative to the top-left of the screen.</param>
+ /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).</param>
+ /// <param name="timeStamp">The time the wheel is being rolled.</param>
+ /// <since_tizen> 3 </since_tizen>
public Wheel(Wheel.WheelType type, int direction, uint modifiers, Vector2 point, int z, uint timeStamp) : this(NDalicPINVOKE.new_Wheel__SWIG_1((int)type, direction, modifiers, Vector2.getCPtr(point), z, timeStamp), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Checks to see if Shift key modifier has been supplied.
+ /// Checks to see if the Shift key modifier has been supplied.
/// </summary>
- /// <returns>True if shift modifier</returns>
+ /// <returns>True if Shift modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsShiftModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsShiftModifier(swigCPtr);
/// <summary>
/// Checks to see if Ctrl (control) key modifier has been supplied.
/// </summary>
- /// <returns>True if ctrl modifier</returns>
+ /// <returns>True if Ctrl modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsCtrlModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsCtrlModifier(swigCPtr);
/// <summary>
/// Checks to see if Alt key modifier has been supplied.
/// </summary>
- /// <returns>True if alt modifier</returns>
+ /// <returns>True if Alt modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsAltModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsAltModifier(swigCPtr);
}
/// <summary>
- /// The type of the wheel event
+ /// The type of the wheel event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WheelType
{
+ /// <summary>
+ /// Mouse wheel event.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
MouseWheel,
+
+ /// <summary>
+ /// Custom wheel event.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
CustomWheel
}
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.Runtime.InteropServices;
+using Tizen.NUI.BaseComponents;
+using System.ComponentModel;
+using System.Collections.Generic;
namespace Tizen.NUI
{
-
- using System;
- using System.Runtime.InteropServices;
- using Tizen.NUI.BaseComponents;
-
/// <summary>
- /// The window class is used internally for drawing.<br>
- /// A Window has an orientation and indicator properties.<br>
+ /// The window class is used internally for drawing.<br />
+ /// The window has an orientation and indicator properties.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class Window : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return ret;
}
- internal static bool IsInstalled()
- {
+ internal static bool IsInstalled()
+ {
bool ret = NDalicPINVOKE.Stage_IsInstalled();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
- }
+ }
- [Obsolete("Please do not use! this will be internal method")]
+ /// <summary>
+ /// Sets whether the window accepts a focus or not.
+ /// </summary>
+ /// <param name="accept">If a focus is accepted or not. The default is true.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetAcceptFocus(bool accept)
{
NDalicPINVOKE.SetAcceptFocus(swigCPtr, accept);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be internal method")]
+ /// <summary>
+ /// Returns whether the window accepts a focus or not.
+ /// </summary>
+ /// <returns>True if the window accepts a focus, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsFocusAcceptable()
{
return NDalicPINVOKE.IsFocusAcceptable(swigCPtr);
/// <summary>
/// Shows the window if it is hidden.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Show()
{
NDalicPINVOKE.Show(swigCPtr);
/// <summary>
/// Hides the window if it is showing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Hide()
{
NDalicPINVOKE.Hide(swigCPtr);
/// <summary>
/// Retrieves whether the window is visible or not.
/// </summary>
- /// <returns>true, if the windoe is visible</returns>
+ /// <returns>True if the window is visible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsVisible()
{
bool temp = NDalicPINVOKE.IsVisible(swigCPtr);
/// Gets the count of supported auxiliary hints of the window.
/// </summary>
/// <returns>The number of supported auxiliary hints.</returns>
- public uint GetSupportedAuxiliaryHintCount() {
+ /// <since_tizen> 3 </since_tizen>
+ public uint GetSupportedAuxiliaryHintCount()
+ {
uint ret = NDalicPINVOKE.GetSupportedAuxiliaryHintCount(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="index">The index of the supported auxiliary hint lists.</param>
/// <returns>The auxiliary hint string of the index.</returns>
- public string GetSupportedAuxiliaryHint(uint index) {
+ /// <since_tizen> 3 </since_tizen>
+ public string GetSupportedAuxiliaryHint(uint index)
+ {
string ret = NDalicPINVOKE.GetSupportedAuxiliaryHint(swigCPtr, index);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// <param name="hint">The auxiliary hint string.</param>
/// <param name="value">The value string.</param>
/// <returns>The ID of created auxiliary hint, or 0 on failure.</returns>
- public uint AddAuxiliaryHint(string hint, string value) {
+ /// <since_tizen> 3 </since_tizen>
+ public uint AddAuxiliaryHint(string hint, string value)
+ {
uint ret = NDalicPINVOKE.AddAuxiliaryHint(swigCPtr, hint, value);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="id">The ID of the auxiliary hint.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
- public bool RemoveAuxiliaryHint(uint id) {
+ /// <since_tizen> 3 </since_tizen>
+ public bool RemoveAuxiliaryHint(uint id)
+ {
bool ret = NDalicPINVOKE.RemoveAuxiliaryHint(swigCPtr, id);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// <param name="id">The auxiliary hint ID.</param>
/// <param name="value">The value string to be set.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
- public bool SetAuxiliaryHintValue(uint id, string value) {
+ /// <since_tizen> 3 </since_tizen>
+ public bool SetAuxiliaryHintValue(uint id, string value)
+ {
bool ret = NDalicPINVOKE.SetAuxiliaryHintValue(swigCPtr, id, value);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="id">The auxiliary hint ID.</param>
/// <returns>The string value of the auxiliary hint ID, or an empty string if none exists.</returns>
- public string GetAuxiliaryHintValue(uint id) {
+ /// <since_tizen> 3 </since_tizen>
+ public string GetAuxiliaryHintValue(uint id)
+ {
string ret = NDalicPINVOKE.GetAuxiliaryHintValue(swigCPtr, id);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="hint">The auxiliary hint string.</param>
/// <returns>The ID of auxiliary hint string, or 0 on failure.</returns>
- public uint GetAuxiliaryHintId(string hint) {
+ /// <since_tizen> 3 </since_tizen>
+ public uint GetAuxiliaryHintId(string hint)
+ {
uint ret = NDalicPINVOKE.GetAuxiliaryHintId(swigCPtr, hint);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// Sets a region to accept input events.
/// </summary>
/// <param name="inputRegion">The region to accept input events.</param>
- public void SetInputRegion(Rectangle inputRegion) {
+ /// <since_tizen> 3 </since_tizen>
+ public void SetInputRegion(Rectangle inputRegion)
+ {
NDalicPINVOKE.SetInputRegion(swigCPtr, Rectangle.getCPtr(inputRegion));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Gets/Sets a window type.
+ /// Gets or sets a window type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public WindowType Type
{
get
/// </summary>
/// <param name="level">The notification window level.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
- public bool SetNotificationLevel(NotificationLevel level) {
+ /// <since_tizen> 3 </since_tizen>
+ public bool SetNotificationLevel(NotificationLevel level)
+ {
bool ret = NDalicPINVOKE.SetNotificationLevel(swigCPtr, (int)level);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// Gets a priority level for the specified notification window.
/// </summary>
/// <returns>The notification window level.</returns>
- public NotificationLevel GetNotificationLevel() {
+ /// <since_tizen> 3 </since_tizen>
+ public NotificationLevel GetNotificationLevel()
+ {
NotificationLevel ret = (NotificationLevel)NDalicPINVOKE.GetNotificationLevel(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// Sets a transparent window's visual state to opaque.
/// </summary>
/// <param name="opaque">Whether the window's visual state is opaque.</param>
- public void SetOpaqueState(bool opaque) {
+ /// <since_tizen> 3 </since_tizen>
+ public void SetOpaqueState(bool opaque)
+ {
NDalicPINVOKE.SetOpaqueState(swigCPtr, opaque);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// Returns whether a transparent window's visual state is opaque or not.
/// </summary>
/// <returns>True if the window's visual state is opaque, false otherwise.</returns>
- public bool IsOpaqueState() {
+ /// <since_tizen> 3 </since_tizen>
+ public bool IsOpaqueState()
+ {
bool ret = NDalicPINVOKE.IsOpaqueState(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="screenOffMode">The screen mode.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
- public bool SetScreenOffMode(ScreenOffMode screenOffMode) {
+ /// <since_tizen> 4 </since_tizen>
+ public bool SetScreenOffMode(ScreenOffMode screenOffMode)
+ {
bool ret = NDalicPINVOKE.SetScreenOffMode(swigCPtr, (int)screenOffMode);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// <summary>
- /// Gets a screen off mode of the window.
+ /// Gets the screen mode of the window.
/// </summary>
/// <returns>The screen off mode.</returns>
- public ScreenOffMode GetScreenOffMode() {
+ /// <since_tizen> 4 </since_tizen>
+ public ScreenOffMode GetScreenOffMode()
+ {
ScreenOffMode ret = (ScreenOffMode)NDalicPINVOKE.GetScreenOffMode(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
/// </summary>
/// <param name="brightness">The preferred brightness (0 to 100).</param>
/// <returns>True if no error occurred, false otherwise.</returns>
- public bool SetBrightness(int brightness) {
+ /// <since_tizen> 3 </since_tizen>
+ public bool SetBrightness(int brightness)
+ {
bool ret = NDalicPINVOKE.SetBrightness(swigCPtr, brightness);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// <summary>
- /// Gets preffered brightness of the window.
+ /// Gets the preferred brightness of the window.
/// </summary>
- /// <returns>The preffered brightness.</returns>
- public int GetBrightness() {
+ /// <returns>The preferred brightness.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ public int GetBrightness()
+ {
int ret = NDalicPINVOKE.GetBrightness(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// The focus changed event argument.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class FocusChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// FocusGained flag.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGained
{
get;
private delegate void WindowFocusChangedEventCallbackType(bool focusGained);
private event EventHandler<FocusChangedEventArgs> _windowFocusChangedEventHandler;
+ /// <summary>
+ /// FocusChanged event.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<FocusChangedEventArgs> FocusChanged
{
add
/// <summary>
/// Gets/Sets a window title.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Title
{
get
set
{
_windowTitle = value;
- SetClass( _windowTitle, "" );
+ SetClass(_windowTitle, "");
}
}
}
/// <summary>
- /// Raises window to the top of Window stack.
+ /// Raises the window to the top of the window stack.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Raise()
{
NDalicPINVOKE.Window_Raise(swigCPtr);
}
/// <summary>
- /// Lowers window to the bottom of Window stack.
+ /// Lowers the window to the bottom of the window stack.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Lower()
{
NDalicPINVOKE.Window_Lower(swigCPtr);
}
/// <summary>
- /// Activates window to the top of Window stack even it is iconified.
+ /// Activates the window to the top of the window stack even it is iconified.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Activate()
{
NDalicPINVOKE.Window_Activate(swigCPtr);
}
/// <summary>
- /// Get default ( root ) layer.
+ /// Gets the default ( root ) layer.
/// </summary>
- /// <returns>The root layer</returns>
+ /// <returns>The root layer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Layer GetDefaultLayer()
{
return this.GetRootLayer();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Add a child view to window.
+ /// </summary>
+ /// <param name="view">the child should be added to the window.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(View view)
{
GetRootLayer()?.Add(view);
}
+ /// <summary>
+ /// Remove a child view from window.
+ /// </summary>
+ /// <param name="view">the child to be removed.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Remove(View view)
{
GetRootLayer()?.Remove(view);
return ret;
}
+ /// <summary>
+ /// Retrieves the layer at a specified depth.
+ /// </summary>
+ /// <param name="depth">The layer's depth index.</param>
+ /// <returns>The layer found at the given depth.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Layer GetLayer(uint depth)
{
IntPtr cPtr = NDalicPINVOKE.Stage_GetLayer(stageCPtr, depth);
/// <summary>
/// Keep rendering for at least the given amount of time.
/// </summary>
- /// <param name="durationSeconds">Time to keep rendering, 0 means render at least one more frame</param>
+ /// <param name="durationSeconds">Time to keep rendering, 0 means render at least one more frame.</param>
+ /// <since_tizen> 3 </since_tizen>
public void KeepRendering(float durationSeconds)
{
NDalicPINVOKE.Stage_KeepRendering(stageCPtr, durationSeconds);
private static readonly Window instance = Application.Instance.GetWindow();
/// <summary>
- /// Stage instance property (read-only).<br>
- /// Gets the current Window.<br>
+ /// The stage instance property (read-only).<br />
+ /// Gets the current window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Window Instance
{
get
}
/// <summary>
- /// Grabs the key specified by a key for a window only when a window is the topmost window. <br>
- /// This function can be used for following example scenarios: <br>
- /// - Mobile - Using volume up/down as zoom up/down in camera apps. <br>
+ /// Grabs the key specified by a key for a window only when a window is the topmost window.<br />
+ /// This function can be used for following example scenarios: <br />
+ /// - Mobile - Using volume up or down as zoom up or down in camera apps.<br />
/// </summary>
- /// <param name="DaliKey">The key code to grab</param>
- /// <returns>true if the grab succeeds</returns>
+ /// <param name="DaliKey">The key code to grab.</param>
+ /// <returns>True if the grab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GrabKeyTopmost(int DaliKey)
{
bool ret = NDalicManualPINVOKE.GrabKeyTopmost(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
}
/// <summary>
- /// Ungrabs the key specified by a key for a window. <br>
- /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.<br>
+ /// Ungrabs the key specified by a key for the window.<br />
+ /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.<br />
/// </summary>
- /// <param name="DaliKey">The key code to ungrab</param>
- /// <returns>true if the ungrab succeeds</returns>
+ /// <param name="DaliKey">The key code to ungrab.</param>
+ /// <returns>True if the ungrab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool UngrabKeyTopmost(int DaliKey)
{
bool ret = NDalicManualPINVOKE.UngrabKeyTopmost(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
}
/// <summary>
- /// Grabs the key specified by a key for a window in a GrabMode. <br>
- /// Details: This function can be used for following example scenarios: <br>
- /// - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. <br>
- /// - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app. <br>
- /// - Mobile - Using volume up/down as zoom up/down in camera apps. <br>
+ /// Grabs the key specified by a key for a window in a GrabMode. <br />
+ /// Details: This function can be used for following example scenarios: <br />
+ /// - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. <br />
+ /// - Mobile - When a user presses the Home key, the homescreen appears regardless of the current foreground app. <br />
+ /// - Mobile - Using the volume up or down as zoom up or down in camera apps. <br />
/// </summary>
- /// <param name="DaliKey">The key code to grab</param>
- /// <param name="GrabMode">The grab mode for the key</param>
- /// <returns>true if the grab succeeds</returns>
+ /// <param name="DaliKey">The key code to grab.</param>
+ /// <param name="GrabMode">The grab mode for the key.</param>
+ /// <returns>True if the grab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GrabKey(int DaliKey, KeyGrabMode GrabMode)
{
bool ret = NDalicManualPINVOKE.GrabKey(HandleRef.ToIntPtr(this.swigCPtr), DaliKey, (int)GrabMode);
}
/// <summary>
- /// Ungrabs the key specified by a key for a window. <br>
- /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event. <br>
+ /// Ungrabs the key specified by a key for a window.<br />
+ /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event. <br />
/// </summary>
- /// <param name="DaliKey">The key code to ungrab</param>
- /// <returns>true if the ungrab succeeds</returns>
+ /// <param name="DaliKey">The key code to ungrab.</param>
+ /// <returns>True if the ungrab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool UngrabKey(int DaliKey)
{
bool ret = NDalicManualPINVOKE.UngrabKey(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
/// <summary>
/// Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WindowOrientation
{
+ /// <summary>
+ /// Portrait orientation. The height of the display area is greater than the width.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Portrait = 0,
+ /// <summary>
+ /// Landscape orientation. A wide view area is needed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Landscape = 90,
+ /// <summary>
+ /// Portrait inverse orientation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PortraitInverse = 180,
+ /// <summary>
+ /// Landscape inverse orientation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LandscapeInverse = 270
}
/// <summary>
- /// Enumeration for key grab mode for platform-level APIs.
+ /// Enumeration for the key grab mode for platform-level APIs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum KeyGrabMode
{
/// <summary>
- /// Grab a key only when on the top of the grabbing-window stack mode.
+ /// Grabs a key only when on the top of the grabbing-window stack mode.
/// </summary>
Topmost = 0,
/// <summary>
- /// Grab a key together with the other client window(s) mode.
+ /// Grabs a key together with the other client window(s) mode.
/// </summary>
Shared,
/// <summary>
- /// Grab a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode.
+ /// Grabs a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode.
/// </summary>
OverrideExclusive,
/// <summary>
- /// Grab a key exclusively regardless of the grabbing-window's position on the window stack mode.
+ /// Grabs a key exclusively regardless of the grabbing-window's position on the window stack mode.
/// </summary>
Exclusive
};
}
/// <summary>
- /// Touch event argument.
+ /// The touch event argument.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class TouchEventArgs : EventArgs
{
private Touch _touch;
/// <summary>
/// Touch.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Touch Touch
{
get
private EventCallbackDelegateType1 _stageTouchCallbackDelegate;
/// <summary>
- /// This is emitted when the screen is touched and when the touch ends.<br>
+ /// This event is emitted when the screen is touched and when the touch ends.<br />
/// If there are multiple touch points, then this will be emitted when the first touch occurs and
- /// then when the last finger is lifted.<br>
- /// An interrupted event will also be emitted (if it occurs).<br>
+ /// then when the last finger is lifted.<br />
+ /// An interrupted event will also be emitted (if it occurs).<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<TouchEventArgs> TouchEvent
{
add
/// <summary>
/// Wheel event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class WheelEventArgs : EventArgs
{
private Wheel _wheel;
/// <summary>
/// Wheel.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel Wheel
{
get
private EventCallbackDelegateType1 _stageWheelCallbackDelegate;
/// <summary>
- /// Event emitted when wheel event is received.
+ /// This event is emitted when the wheel event is received.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<WheelEventArgs> WheelEvent
{
add
/// <summary>
/// Key event arguments.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class KeyEventArgs : EventArgs
{
private Key _key;
/// <summary>
- /// Key
+ /// Key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Key Key
{
get
private EventCallbackDelegateType1 _stageKeyCallbackDelegate;
/// <summary>
- /// Event emitted when key event is received.
+ /// This event is emitted when the key event is received.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<KeyEventArgs> KeyEvent
{
add
}
}
+ /// <summary>
+ /// This resized event arguments.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ResizedEventArgs : EventArgs
{
Size2D _windowSize;
+ /// <summary>
+ /// This window size.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Size2D WindowSize
{
get
private delegate void WindowResizedEventCallbackType(IntPtr windowSize);
private event EventHandler<ResizedEventArgs> _windowResizedEventHandler;
+ /// <summary>
+ /// This event is emitted when the window resized.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ResizedEventArgs> Resized
{
add
internal void SetPosition(Position2D position)
{
- var val = new Uint16Pair( (uint)position.X, (uint)position.Y );
+ var val = new Uint16Pair((uint)position.X, (uint)position.Y);
NDalicManualPINVOKE.SetPosition(swigCPtr, Uint16Pair.getCPtr(val));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Window size property (read-only).
+ /// The window size property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D Size
{
get
}
/// <summary>
- /// Background color property.
+ /// The background color property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color BackgroundColor
{
set
}
/// <summary>
- /// Dpi property (read-only).<br>
- /// Retrieves the DPI of the display device to which the Window is connected.<br>
+ /// The DPI property (read-only).<br />
+ /// Retrieves the DPI of the display device to which the Window is connected.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Dpi
{
get
}
/// <summary>
- /// Layer count property (read-only).<br>
- /// Queries the number of on-Window layers.<br>
+ /// The layer count property (read-only).<br />
+ /// Queries the number of on-Window layers.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint LayerCount
{
get
/// <summary>
- /// Add layer to the Stage.
+ /// Adds a layer to the stage.
/// </summary>
- /// <param name="layer">Layer to add</param>
+ /// <param name="layer">Layer to add.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddLayer(Layer layer)
{
NDalicPINVOKE.Stage_Add(stageCPtr, Layer.getCPtr(layer));
}
/// <summary>
- /// Remove layer from the Stage.
+ /// Removes a layer from the stage.
/// </summary>
- /// <param name="layer">Layer to remove</param>
+ /// <param name="layer">Layer to remove.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveLayer(Layer layer)
{
NDalicPINVOKE.Stage_Remove(stageCPtr, Layer.getCPtr(layer));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use FocusChangedEventArgs instead! " +
+ "Like: " +
+ "Window.Instance.FocusChanged = OnFocusChanged; " +
+ "private void OnFocusChanged(object source, Window.FocusChangedEventArgs args) {...}")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class WindowFocusChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGained
{
get;
private delegate void WindowFocusChangedEventCallbackType2(bool focusGained);
private event EventHandler<WindowFocusChangedEventArgs> _windowFocusChangedEventHandler2;
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated. Please use 'FocusChanged' event instead.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use FocusChanged.
+ [Obsolete("Please do not use! This will be deprecated! Please use FocusChanged instead! " +
+ "Like: " +
+ "Window.Instance.FocusChanged = OnFocusChanged; " +
+ "private void OnFocusChanged(object source, Window.FocusChangedEventArgs args) {...}")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler<WindowFocusChangedEventArgs> WindowFocusChanged
{
add
}
/// <summary>
- /// Gets/Sets a size of the window.
+ /// Gets or sets a size of the window.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Size2D WindowSize
{
get
}
/// <summary>
- /// Gets/Sets a position of the window.
+ /// Gets or sets a position of the window.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Position2D WindowPosition
{
get
/// <summary>
/// Feed a key-event into the window.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static void FeedKeyEvent(Key keyEvent)
{
NDalicManualPINVOKE.Window_FeedKeyEvent(Key.getCPtr(keyEvent));
/// Allows at least one more render, even when paused.
/// The window should be shown, not minimised.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void RenderOnce()
{
NDalicManualPINVOKE.Window_RenderOnce(swigCPtr);
projects / platform / core / csapi / tizenfx.git / commitdiff