summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno da Silva Belo <brunodasilvabelo@gmail.com>2019-10-14 18:27:49 -0300
committerLauro Moura <lauromoura@expertisesolutions.com.br>2019-10-14 18:30:16 -0300
commit53e1d3ad08cda904bd52e1e1fc187bc8315f3693 (patch)
tree846b63ea2257a7e89d1cab1b3057e3f6c067fd3a
parent902ea935e4df7115a5b0577053045a8581b56e5e (diff)
csharp: updating Bind docs and hide api.
Summary: ref T8345 Reviewers: lauromoura, felipealmeida, segfaultxavi, woohyun Reviewed By: lauromoura Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8345 Differential Revision: https://phab.enlightenment.org/D10374
-rw-r--r--src/bindings/mono/efl_mono/Bind.cs59
1 files changed, 43 insertions, 16 deletions
diff --git a/src/bindings/mono/efl_mono/Bind.cs b/src/bindings/mono/efl_mono/Bind.cs
index c4aec5b5e1..2a4fcbded5 100644
--- a/src/bindings/mono/efl_mono/Bind.cs
+++ b/src/bindings/mono/efl_mono/Bind.cs
@@ -12,13 +12,15 @@ namespace Efl {
12/// <summary>Represents a bindable property as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances. 12/// <summary>Represents a bindable property as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances.
13/// 13///
14/// <para>It is internally instantiated and returned by generated extension methods.</para> 14/// <para>It is internally instantiated and returned by generated extension methods.</para>
15///
16/// Since EFL 1.23.
17/// </summary> 15/// </summary>
18public class BindableProperty<T> 16public class BindableProperty<T>
19{ 17{
20 18
21 /// <summary>Creates a new bindable property with the source name <c>name</c>.</summary> 19 /// <summary>Creates a new bindable property with the source name
20 /// <c>name</c>.
21 /// </summary>
22 /// <param name="name">The property name of the bind.</param>
23 /// <param name="binder">The binder that will be used to bind the properties.</param>
22 public BindableProperty(string name, Efl.Ui.IPropertyBind binder) 24 public BindableProperty(string name, Efl.Ui.IPropertyBind binder)
23 { 25 {
24 this.propertyName = name; 26 this.propertyName = name;
@@ -26,7 +28,11 @@ public class BindableProperty<T>
26 this.binder = binder; 28 this.binder = binder;
27 } 29 }
28 30
29 /// <summary>Creates a new bindable property for part <c>part</c>.</summary> 31 /// <summary>Creates a new bindable property for part <c>part</c>.
32 /// </summary>
33 /// <param name="partName">The name of the part this instance wraps.</param>
34 /// <param name="partProperty">The property name of the bind.</param>
35 /// <param name="binder">Yhe binder that will be used to bind the properties.</param>
30 public BindableProperty(string partName, string partProperty, Efl.Ui.IPropertyBind binder) 36 public BindableProperty(string partName, string partProperty, Efl.Ui.IPropertyBind binder)
31 { 37 {
32 this.partName = partName; 38 this.partName = partName;
@@ -34,7 +40,10 @@ public class BindableProperty<T>
34 this.binder = binder; 40 this.binder = binder;
35 } 41 }
36 42
37 /// <summary>Binds the model property <c>modelProperty</c> to the property <c>name</c> set in the constructor.</summary> 43 /// <summary>Binds the model property <c>modelProperty</c> to the property
44 /// <c>name</c> set in the constructor.
45 /// </summary>
46 /// <param name="modelProperty">The model property</param>
38 public Eina.Error Bind(string modelProperty) 47 public Eina.Error Bind(string modelProperty)
39 { 48 {
40 if (this.partName == null) 49 if (this.partName == null)
@@ -70,52 +79,69 @@ public class BindableProperty<T>
70 } 79 }
71 } 80 }
72 81
82 /// <summary>
83 /// The property name of the bind.
84 /// </summary>
73 string propertyName; 85 string propertyName;
86 /// <summary>
87 /// The name of the part this instance wraps.
88 /// </summary>
74 string partName; 89 string partName;
90 /// <summary>
91 /// The binder that will be used to bind the properties.
92 /// </summary>
75 Efl.Ui.IPropertyBind binder; 93 Efl.Ui.IPropertyBind binder;
76} 94}
77 95
78/// <summary>Represents bindable parts as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances. 96/// <summary>Represents bindable parts as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances.
79/// 97///
80/// <para>It is internally instantiated and returned by generated extension methods.</para> 98/// <para>It is internally instantiated and returned by generated extension methods.</para>
81///
82/// Since EFL 1.23.
83/// </summary> 99/// </summary>
84public class BindablePart<T> 100public class BindablePart<T>
85{ 101{
86 /// <summary>Creates a new bindable property with the binder <c>binder</c>.</summary> 102 /// <summary>Creates a new bindable property with the binder <c>binder</c>.
103 ///</summary>
104 /// <param name="partName">The name of the part this instance wraps.</param>
105 /// <param name="binder">Yhe binder that will be used to bind the properties.</param>
87 public BindablePart(string partName, Efl.Ui.IPropertyBind binder) 106 public BindablePart(string partName, Efl.Ui.IPropertyBind binder)
88 { 107 {
89 this.PartName = partName; 108 this.PartName = partName;
90 this.Binder = binder; 109 this.Binder = binder;
91 } 110 }
92 111
93 /// <summary>The name of the part this instance wraps.</summary> 112 /// <summary>The name of the part this instance wraps.
113 /// </summary>
94 public string PartName { get; private set; } 114 public string PartName { get; private set; }
95 /// <summary>The binder that will be used to bind the properties.</summary> 115 /// <summary>The binder that will be used to bind the properties.
116 /// </summary>
96 public Efl.Ui.IPropertyBind Binder { get; private set; } 117 public Efl.Ui.IPropertyBind Binder { get; private set; }
97 118
98} 119}
99 120
100/// <summary>Represents bindable factory parts as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances. 121/// <summary>Represents bindable factory parts as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances.
101///
102/// Since EFL 1.23.
103/// </summary> 122/// </summary>
104public class BindableFactoryPart<T> 123public class BindableFactoryPart<T>
105{ 124{
106 /// <summary>Creates a new bindable factory part with the binder <c>binder</c>.</summary> 125 /// <summary>Creates a new bindable factory part with the binder <c>binder</c>.
126 /// </summary>
127 /// <param name="partName">The name of the part this instance wraps.</param>
128 /// <param name="binder">Yhe binder that will be used to bind the properties.</param>
107 public BindableFactoryPart(string partName, Efl.Ui.IFactoryBind binder) 129 public BindableFactoryPart(string partName, Efl.Ui.IFactoryBind binder)
108 { 130 {
109 this.PartName = partName; 131 this.PartName = partName;
110 this.Binder = binder; 132 this.Binder = binder;
111 } 133 }
112 134
113 /// <summary>The name of the part this instance wraps.</summary> 135 /// <summary>The name of the part this instance wraps.
136 /// </summary>
114 public string PartName { get; private set; } 137 public string PartName { get; private set; }
115 /// <summary>The binder that will be used to bind the properties.</summary> 138 /// <summary>The binder that will be used to bind the properties.
139 /// </summary>
116 public Efl.Ui.IFactoryBind Binder { get; private set; } 140 public Efl.Ui.IFactoryBind Binder { get; private set; }
117 141
118 /// <summary>Binds the given factory to this part.</summary> 142 /// <summary>Binds the given factory to this part.
143 /// </summary>
144 /// <param name="factory">The factory to be used.</param>
119 public Eina.Error BindFactory(Efl.Ui.IFactory factory) 145 public Eina.Error BindFactory(Efl.Ui.IFactory factory)
120 { 146 {
121 return this.Binder.BindFactory(this.PartName, factory); 147 return this.Binder.BindFactory(this.PartName, factory);
@@ -128,6 +154,7 @@ namespace Csharp
128/// <summary>Helper class to differentiate between factory extension methods. 154/// <summary>Helper class to differentiate between factory extension methods.
129/// 155///
130/// For internal use only.</summary> 156/// For internal use only.</summary>
157[EditorBrowsable(EditorBrowsableState.Never)]
131public class ExtensionTag<TBase, TInherited> 158public class ExtensionTag<TBase, TInherited>
132 where TInherited : TBase 159 where TInherited : TBase
133{ 160{