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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.AppKit/NSPasteboard.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>
324
325
        <param name="disposing">
325
326
          <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>
326
327
        </param>
327
 
        <summary>Releases the resourced used by the NSPasteboard object.</summary>
 
328
        <summary>Releases the resources used by the NSPasteboard object.</summary>
328
329
        <remarks>
329
330
          <para>This Dispose method releases the resources used by the NSPasteboard class.</para>
330
331
          <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>
536
537
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
537
538
      </ReturnValue>
538
539
      <Docs>
539
 
        <summary>To be added.</summary>
540
 
        <value>To be added.</value>
 
540
        <summary>Represents the value associated with the constant NSColorPboardType</summary>
 
541
        <value>
 
542
        </value>
541
543
        <remarks>To be added.</remarks>
542
544
      </Docs>
543
545
    </Member>
552
554
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
553
555
      </ReturnValue>
554
556
      <Docs>
555
 
        <summary>To be added.</summary>
556
 
        <value>To be added.</value>
 
557
        <summary>Represents the value associated with the constant NSDragPboard</summary>
 
558
        <value>
 
559
        </value>
557
560
        <remarks>To be added.</remarks>
558
561
      </Docs>
559
562
    </Member>
568
571
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
569
572
      </ReturnValue>
570
573
      <Docs>
571
 
        <summary>To be added.</summary>
572
 
        <value>To be added.</value>
 
574
        <summary>Represents the value associated with the constant NSFileContentsPboardType</summary>
 
575
        <value>
 
576
        </value>
573
577
        <remarks>To be added.</remarks>
574
578
      </Docs>
575
579
    </Member>
584
588
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
585
589
      </ReturnValue>
586
590
      <Docs>
587
 
        <summary>To be added.</summary>
588
 
        <value>To be added.</value>
 
591
        <summary>Represents the value associated with the constant NSFilenamesPboardType</summary>
 
592
        <value>
 
593
        </value>
589
594
        <remarks>To be added.</remarks>
590
595
      </Docs>
591
596
    </Member>
600
605
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
601
606
      </ReturnValue>
602
607
      <Docs>
603
 
        <summary>To be added.</summary>
604
 
        <value>To be added.</value>
 
608
        <summary>Represents the value associated with the constant NSFilesPromisePboardType</summary>
 
609
        <value>
 
610
        </value>
605
611
        <remarks>To be added.</remarks>
606
612
      </Docs>
607
613
    </Member>
616
622
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
617
623
      </ReturnValue>
618
624
      <Docs>
619
 
        <summary>To be added.</summary>
620
 
        <value>To be added.</value>
 
625
        <summary>Represents the value associated with the constant NSFindPboard</summary>
 
626
        <value>
 
627
        </value>
621
628
        <remarks>To be added.</remarks>
622
629
      </Docs>
623
630
    </Member>
632
639
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
633
640
      </ReturnValue>
634
641
      <Docs>
635
 
        <summary>To be added.</summary>
636
 
        <value>To be added.</value>
 
642
        <summary>Represents the value associated with the constant NSFontPboard</summary>
 
643
        <value>
 
644
        </value>
637
645
        <remarks>To be added.</remarks>
638
646
      </Docs>
639
647
    </Member>
648
656
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
649
657
      </ReturnValue>
650
658
      <Docs>
651
 
        <summary>To be added.</summary>
652
 
        <value>To be added.</value>
 
659
        <summary>Represents the value associated with the constant NSFontPboardType</summary>
 
660
        <value>
 
661
        </value>
653
662
        <remarks>To be added.</remarks>
654
663
      </Docs>
655
664
    </Member>
664
673
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
665
674
      </ReturnValue>
666
675
      <Docs>
667
 
        <summary>To be added.</summary>
668
 
        <value>To be added.</value>
 
676
        <summary>Represents the value associated with the constant NSGeneralPboard</summary>
 
677
        <value>
 
678
        </value>
669
679
        <remarks>To be added.</remarks>
670
680
      </Docs>
671
681
    </Member>
680
690
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
681
691
      </ReturnValue>
682
692
      <Docs>
683
 
        <summary>To be added.</summary>
684
 
        <value>To be added.</value>
 
693
        <summary>Represents the value associated with the constant NSHTMLPboardType</summary>
 
694
        <value>
 
695
        </value>
685
696
        <remarks>To be added.</remarks>
686
697
      </Docs>
687
698
    </Member>
696
707
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
697
708
      </ReturnValue>
698
709
      <Docs>
699
 
        <summary>To be added.</summary>
700
 
        <value>To be added.</value>
 
710
        <summary>Represents the value associated with the constant NSMultipleTextSelectionPboardType</summary>
 
711
        <value>
 
712
        </value>
701
713
        <remarks>To be added.</remarks>
702
714
      </Docs>
703
715
    </Member>
712
724
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
713
725
      </ReturnValue>
714
726
      <Docs>
715
 
        <summary>To be added.</summary>
716
 
        <value>To be added.</value>
 
727
        <summary>Represents the value associated with the constant NSPDFPboardType</summary>
 
728
        <value>
 
729
        </value>
717
730
        <remarks>To be added.</remarks>
718
731
      </Docs>
719
732
    </Member>
728
741
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
729
742
      </ReturnValue>
730
743
      <Docs>
731
 
        <summary>To be added.</summary>
732
 
        <value>To be added.</value>
 
744
        <summary>Represents the value associated with the constant NSPICTPboardType</summary>
 
745
        <value>
 
746
        </value>
733
747
        <remarks>To be added.</remarks>
734
748
      </Docs>
735
749
    </Member>
744
758
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
745
759
      </ReturnValue>
746
760
      <Docs>
747
 
        <summary>To be added.</summary>
748
 
        <value>To be added.</value>
 
761
        <summary>Represents the value associated with the constant NSPostScriptPboardType</summary>
 
762
        <value>
 
763
        </value>
749
764
        <remarks>To be added.</remarks>
750
765
      </Docs>
751
766
    </Member>
760
775
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
761
776
      </ReturnValue>
762
777
      <Docs>
763
 
        <summary>To be added.</summary>
764
 
        <value>To be added.</value>
 
778
        <summary>Represents the value associated with the constant NSRTFDPboardType</summary>
 
779
        <value>
 
780
        </value>
765
781
        <remarks>To be added.</remarks>
766
782
      </Docs>
767
783
    </Member>
776
792
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
777
793
      </ReturnValue>
778
794
      <Docs>
779
 
        <summary>To be added.</summary>
780
 
        <value>To be added.</value>
 
795
        <summary>Represents the value associated with the constant NSRTFPboardType</summary>
 
796
        <value>
 
797
        </value>
781
798
        <remarks>To be added.</remarks>
782
799
      </Docs>
783
800
    </Member>
792
809
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
793
810
      </ReturnValue>
794
811
      <Docs>
795
 
        <summary>To be added.</summary>
796
 
        <value>To be added.</value>
 
812
        <summary>Represents the value associated with the constant NSRulerPboard</summary>
 
813
        <value>
 
814
        </value>
797
815
        <remarks>To be added.</remarks>
798
816
      </Docs>
799
817
    </Member>
808
826
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
809
827
      </ReturnValue>
810
828
      <Docs>
811
 
        <summary>To be added.</summary>
812
 
        <value>To be added.</value>
 
829
        <summary>Represents the value associated with the constant NSRulerPboardType</summary>
 
830
        <value>
 
831
        </value>
813
832
        <remarks>To be added.</remarks>
814
833
      </Docs>
815
834
    </Member>
824
843
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
825
844
      </ReturnValue>
826
845
      <Docs>
827
 
        <summary>To be added.</summary>
828
 
        <value>To be added.</value>
 
846
        <summary>Represents the value associated with the constant NSStringPboardType</summary>
 
847
        <value>
 
848
        </value>
829
849
        <remarks>To be added.</remarks>
830
850
      </Docs>
831
851
    </Member>
840
860
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
841
861
      </ReturnValue>
842
862
      <Docs>
843
 
        <summary>To be added.</summary>
844
 
        <value>To be added.</value>
 
863
        <summary>Represents the value associated with the constant NSTabularTextPboardType</summary>
 
864
        <value>
 
865
        </value>
845
866
        <remarks>To be added.</remarks>
846
867
      </Docs>
847
868
    </Member>
856
877
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
857
878
      </ReturnValue>
858
879
      <Docs>
859
 
        <summary>To be added.</summary>
860
 
        <value>To be added.</value>
 
880
        <summary>Represents the value associated with the constant NSTIFFPboardType</summary>
 
881
        <value>
 
882
        </value>
861
883
        <remarks>To be added.</remarks>
862
884
      </Docs>
863
885
    </Member>
872
894
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
873
895
      </ReturnValue>
874
896
      <Docs>
875
 
        <summary>To be added.</summary>
876
 
        <value>To be added.</value>
 
897
        <summary>Represents the value associated with the constant NSURLPboardType</summary>
 
898
        <value>
 
899
        </value>
877
900
        <remarks>To be added.</remarks>
878
901
      </Docs>
879
902
    </Member>
888
911
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
889
912
      </ReturnValue>
890
913
      <Docs>
891
 
        <summary>To be added.</summary>
892
 
        <value>To be added.</value>
 
914
        <summary>Represents the value associated with the constant NSVCardPboardType</summary>
 
915
        <value>
 
916
        </value>
893
917
        <remarks>To be added.</remarks>
894
918
      </Docs>
895
919
    </Member>