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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.WebKit/WebView.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>
49
52
        <Attribute>
50
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
52
58
      </Attributes>
53
59
      <Parameters>
54
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
72
      <AssemblyInfo>
67
73
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
74
      </AssemblyInfo>
 
75
      <Attributes>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
 
79
      </Attributes>
69
80
      <Parameters>
70
81
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
82
      </Parameters>
72
83
      <Docs>
73
84
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
74
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
85
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
86
        <remarks>
76
 
          <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>
77
 
          <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>
78
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
79
 
          <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>
80
 
          <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>
 
87
          <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>
81
88
          <example>
82
89
            <code lang="C#">
83
 
//
84
 
// The NSObjectFlag merely allocates the object and registers the
85
 
// C# class with the Objective-C runtime if necessary, but no actual
86
 
// initXxx method is invoked, that is done later in the constructor
87
 
//
88
 
// This is taken from MonoMac's source code:
89
 
//
90
 
[Export ("initWithFrame:")]
91
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
92
 
{
93
 
// Invoke the init method now.
94
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
95
 
        if (IsDirectBinding)
96
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
97
 
        else
98
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
99
 
}
 
90
public class MyClass : BaseClass {
 
91
    [Export ("initWithFoo:")]
 
92
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
93
    {
 
94
        ...
 
95
    }
100
96
</code>
101
97
          </example>
102
98
        </remarks>
109
105
      <AssemblyInfo>
110
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
107
      </AssemblyInfo>
 
108
      <Attributes>
 
109
        <Attribute>
 
110
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
111
        </Attribute>
 
112
      </Attributes>
112
113
      <Parameters>
113
114
        <Parameter Name="handle" Type="System.IntPtr" />
114
115
      </Parameters>
865
866
      </Docs>
866
867
    </Member>
867
868
    <Member MemberName="DecidePolicyForNavigation">
868
 
      <MemberSignature Language="C#" Value="public event EventHandler&lt;MonoMac.WebKit.WebNavigatioPolicyEventArgs&gt; DecidePolicyForNavigation;" />
869
 
      <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class MonoMac.WebKit.WebNavigatioPolicyEventArgs&gt; DecidePolicyForNavigation" />
 
869
      <MemberSignature Language="C#" Value="public event EventHandler&lt;MonoMac.WebKit.WebNavigationPolicyEventArgs&gt; DecidePolicyForNavigation;" />
 
870
      <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class MonoMac.WebKit.WebNavigationPolicyEventArgs&gt; DecidePolicyForNavigation" />
870
871
      <MemberType>Event</MemberType>
871
872
      <AssemblyInfo>
872
873
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
873
874
      </AssemblyInfo>
874
875
      <ReturnValue>
875
 
        <ReturnType>System.EventHandler&lt;MonoMac.WebKit.WebNavigatioPolicyEventArgs&gt;</ReturnType>
 
876
        <ReturnType>System.EventHandler&lt;MonoMac.WebKit.WebNavigationPolicyEventArgs&gt;</ReturnType>
876
877
      </ReturnValue>
877
878
      <Docs>
878
879
        <summary>Event raised by the object.</summary>
977
978
        <param name="disposing">
978
979
          <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>
979
980
        </param>
980
 
        <summary>Releases the resourced used by the WebView object.</summary>
 
981
        <summary>Releases the resources used by the WebView object.</summary>
981
982
        <remarks>
982
983
          <para>This Dispose method releases the resources used by the WebView class.</para>
983
984
          <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>
998
999
      </ReturnValue>
999
1000
      <Docs>
1000
1001
        <summary>To be added.</summary>
1001
 
        <value>To be added.</value>
 
1002
        <value>
 
1003
          <para>(More documentation for this node is coming)</para>
 
1004
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
1005
        </value>
1002
1006
        <remarks>To be added.</remarks>
1003
1007
      </Docs>
1004
1008
    </Member>
1177
1181
      </ReturnValue>
1178
1182
      <Docs>
1179
1183
        <summary>To be added.</summary>
1180
 
        <value>To be added.</value>
 
1184
        <value>
 
1185
          <para>(More documentation for this node is coming)</para>
 
1186
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
1187
        </value>
1181
1188
        <remarks>To be added.</remarks>
1182
1189
      </Docs>
1183
1190
    </Member>
2019
2026
      </ReturnValue>
2020
2027
      <Docs>
2021
2028
        <summary>To be added.</summary>
2022
 
        <value>To be added.</value>
 
2029
        <value>
 
2030
          <para>(More documentation for this node is coming)</para>
 
2031
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
2032
        </value>
2023
2033
        <remarks>To be added.</remarks>
2024
2034
      </Docs>
2025
2035
    </Member>
2297
2307
      </ReturnValue>
2298
2308
      <Docs>
2299
2309
        <summary>To be added.</summary>
2300
 
        <value>To be added.</value>
 
2310
        <value>
 
2311
          <para>(More documentation for this node is coming)</para>
 
2312
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
2313
        </value>
2301
2314
        <remarks>To be added.</remarks>
2302
2315
      </Docs>
2303
2316
    </Member>
2841
2854
      </ReturnValue>
2842
2855
      <Docs>
2843
2856
        <summary>To be added.</summary>
2844
 
        <value>To be added.</value>
 
2857
        <value>
 
2858
          <para>(More documentation for this node is coming)</para>
 
2859
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
2860
        </value>
2845
2861
        <remarks>To be added.</remarks>
2846
2862
      </Docs>
2847
2863
    </Member>
3588
3604
      </ReturnValue>
3589
3605
      <Docs>
3590
3606
        <summary>To be added.</summary>
3591
 
        <value>To be added.</value>
 
3607
        <value>
 
3608
          <para>(More documentation for this node is coming)</para>
 
3609
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
3610
        </value>
3592
3611
        <remarks>To be added.</remarks>
3593
3612
      </Docs>
3594
3613
    </Member>
3612
3631
      </ReturnValue>
3613
3632
      <Docs>
3614
3633
        <summary>To be added.</summary>
3615
 
        <value>To be added.</value>
 
3634
        <value>
 
3635
          <para>(More documentation for this node is coming)</para>
 
3636
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
3637
        </value>
3616
3638
        <remarks>To be added.</remarks>
3617
3639
      </Docs>
3618
3640
    </Member>
3636
3658
      </ReturnValue>
3637
3659
      <Docs>
3638
3660
        <summary>To be added.</summary>
3639
 
        <value>To be added.</value>
 
3661
        <value>
 
3662
          <para>(More documentation for this node is coming)</para>
 
3663
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
3664
        </value>
3640
3665
        <remarks>To be added.</remarks>
3641
3666
      </Docs>
3642
3667
    </Member>
3660
3685
      </ReturnValue>
3661
3686
      <Docs>
3662
3687
        <summary>To be added.</summary>
3663
 
        <value>To be added.</value>
 
3688
        <value>
 
3689
          <para>(More documentation for this node is coming)</para>
 
3690
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
3691
        </value>
3664
3692
        <remarks>To be added.</remarks>
3665
3693
      </Docs>
3666
3694
    </Member>
3684
3712
      </ReturnValue>
3685
3713
      <Docs>
3686
3714
        <summary>To be added.</summary>
3687
 
        <value>To be added.</value>
 
3715
        <value>
 
3716
          <para>(More documentation for this node is coming)</para>
 
3717
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
3718
        </value>
3688
3719
        <remarks>To be added.</remarks>
3689
3720
      </Docs>
3690
3721
    </Member>