X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FCustomViewRegistry.cs;h=46a3c933d9eb7a99b80cad947840b3ef9332076d;hb=ea5625aa453488271b0a52ee4e25fbb29feb6484;hp=99aeb91b3c10b17f5e74781c09c987f07dbee63a;hpb=ff57cbb1221d9f6b9f5fe7a41b6a15f6e92cfc7b;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/src/Tizen.NUI/src/public/CustomViewRegistry.cs b/src/Tizen.NUI/src/public/CustomViewRegistry.cs index 99aeb91..46a3c93 100755 --- a/src/Tizen.NUI/src/public/CustomViewRegistry.cs +++ b/src/Tizen.NUI/src/public/CustomViewRegistry.cs @@ -8,7 +8,7 @@ using Tizen.NUI.BaseComponents; namespace Tizen.NUI { /// - /// 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. /// /// /// Example: @@ -31,13 +31,13 @@ namespace Tizen.NUI /// /// 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 /// { @@ -87,8 +87,8 @@ namespace Tizen.NUI } /// - /// 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++ /// @@ -97,15 +97,15 @@ namespace Tizen.NUI /// 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(); @@ -123,7 +123,7 @@ namespace Tizen.NUI public sealed class CustomViewRegistry { /// - /// ViewRegistry is a singleton + /// ViewRegistry is a singleton. /// private static CustomViewRegistry instance = null; @@ -143,12 +143,12 @@ namespace Tizen.NUI /// // 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. + /// For example, given a string "Spin", we can get a function used to create the Spin View. /// private Dictionary> _constructorMap; /// - /// 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. /// private static readonly Dictionary _daliPropertyTypeLookup = new Dictionary @@ -201,10 +201,10 @@ namespace Tizen.NUI } /// - /// 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. /// - /// Pointer to the Control (Views) handle - /// C pointer to the Control (View) name + /// Pointer to the control (views) handle. + /// C pointer to the control (view) name. private static IntPtr CreateControl(IntPtr cPtrControlName) { string controlName = System.Runtime.InteropServices.Marshal.PtrToStringAnsi(cPtrControlName); @@ -255,12 +255,12 @@ namespace Tizen.NUI } /// - /// 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 @@ -316,7 +316,7 @@ namespace Tizen.NUI } /// - /// Get a property value from a View + /// Gets a property value from a view. /// /// private IntPtr GetPropertyValue(IntPtr refObjectPtr, string propertyName) @@ -339,7 +339,7 @@ namespace Tizen.NUI } /// - /// Set a property value on a View + /// Sets a property value on a view. /// /// private void SetPropertyValue(IntPtr refObjectPtr, string propertyName, IntPtr propertyValuePtr)