~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreData/NSPersistentStoreCoordinator.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
ImportĀ upstreamĀ versionĀ 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
30
30
        <Attribute>
31
31
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
33
36
      </Attributes>
34
37
      <Parameters />
35
38
      <Docs>
70
73
        <Attribute>
71
74
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
72
75
        </Attribute>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
73
79
      </Attributes>
74
80
      <Parameters>
75
81
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
87
93
      <AssemblyInfo>
88
94
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
89
95
      </AssemblyInfo>
 
96
      <Attributes>
 
97
        <Attribute>
 
98
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
99
        </Attribute>
 
100
      </Attributes>
90
101
      <Parameters>
91
102
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
92
103
      </Parameters>
93
104
      <Docs>
94
105
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
95
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
106
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
96
107
        <remarks>
97
 
          <para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject.   This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object.   When you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together.    The actual initialization of the object is up to you.</para>
98
 
          <para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place.   Once the allocation has taken place, the constructor has to initialize the object.   With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
99
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
100
 
          <para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method.   If this is not the case, you should instead chain to the proper constructor in your class. </para>
101
 
          <para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration.  Typically the chaining would look like this:</para>
 
108
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
102
109
          <example>
103
110
            <code lang="C#">
104
 
//
105
 
// The NSObjectFlag merely allocates the object and registers the
106
 
// C# class with the Objective-C runtime if necessary, but no actual
107
 
// initXxx method is invoked, that is done later in the constructor
108
 
//
109
 
// This is taken from MonoMac's source code:
110
 
//
111
 
[Export ("initWithFrame:")]
112
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
113
 
{
114
 
// Invoke the init method now.
115
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
116
 
        if (IsDirectBinding)
117
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
118
 
        else
119
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
120
 
}
 
111
public class MyClass : BaseClass {
 
112
    [Export ("initWithFoo:")]
 
113
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
114
    {
 
115
        ...
 
116
    }
121
117
</code>
122
118
          </example>
123
119
        </remarks>
130
126
      <AssemblyInfo>
131
127
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
132
128
      </AssemblyInfo>
 
129
      <Attributes>
 
130
        <Attribute>
 
131
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
132
        </Attribute>
 
133
      </Attributes>
133
134
      <Parameters>
134
135
        <Parameter Name="handle" Type="System.IntPtr" />
135
136
      </Parameters>
152
153
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
153
154
      </ReturnValue>
154
155
      <Docs>
155
 
        <summary>To be added.</summary>
156
 
        <value>To be added.</value>
 
156
        <summary>Represents the value associated with the constant NSAddedPersistentStoresKey</summary>
 
157
        <value>
 
158
        </value>
157
159
        <remarks>To be added.</remarks>
158
160
      </Docs>
159
161
    </Member>
181
183
      </Parameters>
182
184
      <Docs>
183
185
        <param name="storeType">To be added.</param>
184
 
        <param name="configuration">To be added.</param>
 
186
        <param name="configuration">
 
187
          <para>To be added.</para>
 
188
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
189
        </param>
185
190
        <param name="storeURL">To be added.</param>
186
 
        <param name="options">To be added.</param>
 
191
        <param name="options">
 
192
          <para>To be added.</para>
 
193
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
194
        </param>
187
195
        <param name="error">To be added.</param>
188
196
        <summary>To be added.</summary>
189
197
        <returns>To be added.</returns>
201
209
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
202
210
      </ReturnValue>
203
211
      <Docs>
204
 
        <summary>To be added.</summary>
205
 
        <value>To be added.</value>
 
212
        <summary>Represents the value associated with the constant NSBinaryStoreType</summary>
 
213
        <value>
 
214
        </value>
206
215
        <remarks>To be added.</remarks>
207
216
      </Docs>
208
217
    </Member>
274
283
        <param name="disposing">
275
284
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
276
285
        </param>
277
 
        <summary>Releases the resourced used by the NSPersistentStoreCoordinator object.</summary>
 
286
        <summary>Releases the resources used by the NSPersistentStoreCoordinator object.</summary>
278
287
        <remarks>
279
288
          <para>This Dispose method releases the resources used by the NSPersistentStoreCoordinator class.</para>
280
289
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
323
332
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
324
333
      </ReturnValue>
325
334
      <Docs>
326
 
        <summary>To be added.</summary>
327
 
        <value>To be added.</value>
 
335
        <summary>Represents the value associated with the constant NSIgnorePersistentStoreVersioningOption</summary>
 
336
        <value>
 
337
        </value>
328
338
        <remarks>To be added.</remarks>
329
339
      </Docs>
330
340
    </Member>
339
349
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
340
350
      </ReturnValue>
341
351
      <Docs>
342
 
        <summary>To be added.</summary>
343
 
        <value>To be added.</value>
 
352
        <summary>Represents the value associated with the constant NSInferMappingModelAutomaticallyOption</summary>
 
353
        <value>
 
354
        </value>
344
355
        <remarks>To be added.</remarks>
345
356
      </Docs>
346
357
    </Member>
355
366
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
356
367
      </ReturnValue>
357
368
      <Docs>
358
 
        <summary>To be added.</summary>
359
 
        <value>To be added.</value>
 
369
        <summary>Represents the value associated with the constant NSInMemoryStoreType</summary>
 
370
        <value>
 
371
        </value>
360
372
        <remarks>To be added.</remarks>
361
373
      </Docs>
362
374
    </Member>
555
567
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
556
568
      </ReturnValue>
557
569
      <Docs>
558
 
        <summary>To be added.</summary>
559
 
        <value>To be added.</value>
 
570
        <summary>Represents the value associated with the constant NSMigratePersistentStoresAutomaticallyOption</summary>
 
571
        <value>
 
572
        </value>
560
573
        <remarks>To be added.</remarks>
561
574
      </Docs>
562
575
    </Member>
571
584
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
572
585
      </ReturnValue>
573
586
      <Docs>
574
 
        <summary>To be added.</summary>
575
 
        <value>To be added.</value>
 
587
        <summary>Represents the value associated with the constant NSPersistentStoreFileProtectionKey</summary>
 
588
        <value>
 
589
        </value>
576
590
        <remarks>To be added.</remarks>
577
591
      </Docs>
578
592
    </Member>
612
626
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
613
627
      </ReturnValue>
614
628
      <Docs>
615
 
        <summary>To be added.</summary>
616
 
        <value>To be added.</value>
 
629
        <summary>Represents the value associated with the constant NSPersistentStoreOSCompatibility</summary>
 
630
        <value>
 
631
        </value>
617
632
        <remarks>To be added.</remarks>
618
633
      </Docs>
619
634
    </Member>
649
664
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
650
665
      </ReturnValue>
651
666
      <Docs>
652
 
        <summary>To be added.</summary>
653
 
        <value>To be added.</value>
 
667
        <summary>Represents the value associated with the constant NSPersistentStoreTimeoutOption</summary>
 
668
        <value>
 
669
        </value>
654
670
        <remarks>To be added.</remarks>
655
671
      </Docs>
656
672
    </Member>
665
681
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
666
682
      </ReturnValue>
667
683
      <Docs>
668
 
        <summary>To be added.</summary>
669
 
        <value>To be added.</value>
 
684
        <summary>Represents the value associated with the constant NSPersistentStoreUbiquitousContentNameKey</summary>
 
685
        <value>
 
686
        </value>
670
687
        <remarks>To be added.</remarks>
671
688
      </Docs>
672
689
    </Member>
681
698
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
682
699
      </ReturnValue>
683
700
      <Docs>
684
 
        <summary>To be added.</summary>
685
 
        <value>To be added.</value>
 
701
        <summary>Represents the value associated with the constant NSPersistentStoreUbiquitousContentURLKey</summary>
 
702
        <value>
 
703
        </value>
686
704
        <remarks>To be added.</remarks>
687
705
      </Docs>
688
706
    </Member>
697
715
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
698
716
      </ReturnValue>
699
717
      <Docs>
700
 
        <summary>To be added.</summary>
701
 
        <value>To be added.</value>
 
718
        <summary>Represents the value associated with the constant NSReadOnlyPersistentStoreOption</summary>
 
719
        <value>
 
720
        </value>
702
721
        <remarks>To be added.</remarks>
703
722
      </Docs>
704
723
    </Member>
760
779
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
761
780
      </ReturnValue>
762
781
      <Docs>
763
 
        <summary>To be added.</summary>
764
 
        <value>To be added.</value>
 
782
        <summary>Represents the value associated with the constant NSRemovedPersistentStoresKey</summary>
 
783
        <value>
 
784
        </value>
765
785
        <remarks>To be added.</remarks>
766
786
      </Docs>
767
787
    </Member>
887
907
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
888
908
      </ReturnValue>
889
909
      <Docs>
890
 
        <summary>To be added.</summary>
891
 
        <value>To be added.</value>
 
910
        <summary>Represents the value associated with the constant NSSQLiteAnalyzeOption</summary>
 
911
        <value>
 
912
        </value>
892
913
        <remarks>To be added.</remarks>
893
914
      </Docs>
894
915
    </Member>
903
924
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
904
925
      </ReturnValue>
905
926
      <Docs>
906
 
        <summary>To be added.</summary>
907
 
        <value>To be added.</value>
 
927
        <summary>Represents the value associated with the constant NSSQLiteManualVacuumOption</summary>
 
928
        <value>
 
929
        </value>
908
930
        <remarks>To be added.</remarks>
909
931
      </Docs>
910
932
    </Member>
919
941
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
920
942
      </ReturnValue>
921
943
      <Docs>
922
 
        <summary>To be added.</summary>
923
 
        <value>To be added.</value>
 
944
        <summary>Represents the value associated with the constant NSSQLitePragmasOption</summary>
 
945
        <value>
 
946
        </value>
924
947
        <remarks>To be added.</remarks>
925
948
      </Docs>
926
949
    </Member>
935
958
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
936
959
      </ReturnValue>
937
960
      <Docs>
938
 
        <summary>To be added.</summary>
939
 
        <value>To be added.</value>
 
961
        <summary>Represents the value associated with the constant NSSQLiteStoreType</summary>
 
962
        <value>
 
963
        </value>
940
964
        <remarks>To be added.</remarks>
941
965
      </Docs>
942
966
    </Member>
951
975
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
952
976
      </ReturnValue>
953
977
      <Docs>
954
 
        <summary>To be added.</summary>
955
 
        <value>To be added.</value>
 
978
        <summary>Represents the value associated with the constant NSStoreModelVersionHashesKey</summary>
 
979
        <value>
 
980
        </value>
956
981
        <remarks>To be added.</remarks>
957
982
      </Docs>
958
983
    </Member>
967
992
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
968
993
      </ReturnValue>
969
994
      <Docs>
970
 
        <summary>To be added.</summary>
971
 
        <value>To be added.</value>
 
995
        <summary>Represents the value associated with the constant NSStoreModelVersionIdentifiersKey</summary>
 
996
        <value>
 
997
        </value>
972
998
        <remarks>To be added.</remarks>
973
999
      </Docs>
974
1000
    </Member>
1018
1044
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
1019
1045
      </ReturnValue>
1020
1046
      <Docs>
1021
 
        <summary>To be added.</summary>
1022
 
        <value>To be added.</value>
 
1047
        <summary>Represents the value associated with the constant NSStoreTypeKey</summary>
 
1048
        <value>
 
1049
        </value>
1023
1050
        <remarks>To be added.</remarks>
1024
1051
      </Docs>
1025
1052
    </Member>
1034
1061
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
1035
1062
      </ReturnValue>
1036
1063
      <Docs>
1037
 
        <summary>To be added.</summary>
1038
 
        <value>To be added.</value>
 
1064
        <summary>Represents the value associated with the constant NSStoreUUIDKey</summary>
 
1065
        <value>
 
1066
        </value>
1039
1067
        <remarks>To be added.</remarks>
1040
1068
      </Docs>
1041
1069
    </Member>
1117
1145
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
1118
1146
      </ReturnValue>
1119
1147
      <Docs>
1120
 
        <summary>To be added.</summary>
1121
 
        <value>To be added.</value>
 
1148
        <summary>Represents the value associated with the constant NSUUIDChangedPersistentStoresKey</summary>
 
1149
        <value>
 
1150
        </value>
1122
1151
        <remarks>To be added.</remarks>
1123
1152
      </Docs>
1124
1153
    </Member>