← Back to branch summary

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

« back to all changes in this revision

Viewing changes to external/mono-addins/docs/Mono.Addins/IProgressStatus.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:
external/mono-addins/docs/Mono.Addins/IProgressStatus.xml
 
1
<Type Name="IProgressStatus" FullName="Mono.Addins.IProgressStatus">
 
2
  <TypeSignature Language="C#" Value="public interface IProgressStatus" />
 
3
  <AssemblyInfo>
 
4
    <AssemblyName>Mono.Addins</AssemblyName>
 
5
    <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
6
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Interfaces />
 
9
  <Docs>
 
10
    <summary>Progress status listener.</summary>
 
11
    <remarks>This interface is used by several add-in operations for progress reporting.</remarks>
 
12
  </Docs>
 
13
  <Members>
 
14
    <Member MemberName="Cancel">
 
15
      <MemberSignature Language="C#" Value="public void Cancel ();" />
 
16
      <MemberType>Method</MemberType>
 
17
      <ReturnValue>
 
18
        <ReturnType>System.Void</ReturnType>
 
19
      </ReturnValue>
 
20
      <Parameters />
 
21
      <Docs>
 
22
        <summary>Cancels the operation being montorized.</summary>
 
23
        <remarks />
 
24
      </Docs>
 
25
      <AssemblyInfo>
 
26
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
27
      </AssemblyInfo>
 
28
    </Member>
 
29
    <Member MemberName="IsCanceled">
 
30
      <MemberSignature Language="C#" Value="public bool IsCanceled { get; }" />
 
31
      <MemberType>Property</MemberType>
 
32
      <ReturnValue>
 
33
        <ReturnType>System.Boolean</ReturnType>
 
34
      </ReturnValue>
 
35
      <Docs>
 
36
        <summary>To be added.</summary>
 
37
        <value>To be added.</value>
 
38
        <remarks>To be added.</remarks>
 
39
      </Docs>
 
40
      <AssemblyInfo>
 
41
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
42
      </AssemblyInfo>
 
43
    </Member>
 
44
    <Member MemberName="Log">
 
45
      <MemberSignature Language="C#" Value="public void Log (string msg);" />
 
46
      <MemberType>Method</MemberType>
 
47
      <ReturnValue>
 
48
        <ReturnType>System.Void</ReturnType>
 
49
      </ReturnValue>
 
50
      <Parameters>
 
51
        <Parameter Name="msg" Type="System.String" />
 
52
      </Parameters>
 
53
      <Docs>
 
54
        <param name="msg">Message to write.</param>
 
55
        <summary>Writes text to the log.</summary>
 
56
        <remarks />
 
57
      </Docs>
 
58
      <AssemblyInfo>
 
59
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
60
      </AssemblyInfo>
 
61
    </Member>
 
62
    <Member MemberName="LogLevel">
 
63
      <MemberSignature Language="C#" Value="public int LogLevel { get; }" />
 
64
      <MemberType>Property</MemberType>
 
65
      <AssemblyInfo>
 
66
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
67
      </AssemblyInfo>
 
68
      <ReturnValue>
 
69
        <ReturnType>System.Int32</ReturnType>
 
70
      </ReturnValue>
 
71
      <Docs>
 
72
        <summary>To be added.</summary>
 
73
        <value>To be added.</value>
 
74
        <remarks>To be added.</remarks>
 
75
      </Docs>
 
76
    </Member>
 
77
    <Member MemberName="ReportError">
 
78
      <MemberSignature Language="C#" Value="public void ReportError (string message, Exception exception);" />
 
79
      <MemberType>Method</MemberType>
 
80
      <ReturnValue>
 
81
        <ReturnType>System.Void</ReturnType>
 
82
      </ReturnValue>
 
83
      <Parameters>
 
84
        <Parameter Name="message" Type="System.String" />
 
85
        <Parameter Name="exception" Type="System.Exception" />
 
86
      </Parameters>
 
87
      <Docs>
 
88
        <param name="message">Error message (may be null).</param>
 
89
        <param name="exception">Exception that originated the error (may be null).</param>
 
90
        <summary>Reports and error.</summary>
 
91
        <remarks>This method is called by the add-in engine to report an error occurred while executing the operation being monitorized.</remarks>
 
92
      </Docs>
 
93
      <AssemblyInfo>
 
94
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
95
      </AssemblyInfo>
 
96
    </Member>
 
97
    <Member MemberName="ReportWarning">
 
98
      <MemberSignature Language="C#" Value="public void ReportWarning (string message);" />
 
99
      <MemberType>Method</MemberType>
 
100
      <ReturnValue>
 
101
        <ReturnType>System.Void</ReturnType>
 
102
      </ReturnValue>
 
103
      <Parameters>
 
104
        <Parameter Name="message" Type="System.String" />
 
105
      </Parameters>
 
106
      <Docs>
 
107
        <param name="message">Warning message.</param>
 
108
        <summary>Reports a warning.</summary>
 
109
        <remarks>This method is called by the add-in engine to report a warning in the operation being monitorized.</remarks>
 
110
      </Docs>
 
111
      <AssemblyInfo>
 
112
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
113
      </AssemblyInfo>
 
114
    </Member>
 
115
    <Member MemberName="SetMessage">
 
116
      <MemberSignature Language="C#" Value="public void SetMessage (string msg);" />
 
117
      <MemberType>Method</MemberType>
 
118
      <ReturnValue>
 
119
        <ReturnType>System.Void</ReturnType>
 
120
      </ReturnValue>
 
121
      <Parameters>
 
122
        <Parameter Name="msg" Type="System.String" />
 
123
      </Parameters>
 
124
      <Docs>
 
125
        <param name="msg">A message.</param>
 
126
        <summary>Sets the description of the current operation.</summary>
 
127
        <remarks>This method is called by the add-in engine to show a description of the operation being monitorized.</remarks>
 
128
      </Docs>
 
129
      <AssemblyInfo>
 
130
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
131
      </AssemblyInfo>
 
132
    </Member>
 
133
    <Member MemberName="SetProgress">
 
134
      <MemberSignature Language="C#" Value="public void SetProgress (double progress);" />
 
135
      <MemberType>Method</MemberType>
 
136
      <ReturnValue>
 
137
        <ReturnType>System.Void</ReturnType>
 
138
      </ReturnValue>
 
139
      <Parameters>
 
140
        <Parameter Name="progress" Type="System.Double" />
 
141
      </Parameters>
 
142
      <Docs>
 
143
        <param name="progress">A number between 0 and 1. 0 means no progress, 1 means operation completed.</param>
 
144
        <summary>Sets the progress of the operation.</summary>
 
145
        <remarks>This method is called by the add-in engine to show the progress of the operation being monitorized.</remarks>
 
146
      </Docs>
 
147
      <AssemblyInfo>
 
148
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
149
      </AssemblyInfo>
 
150
    </Member>
 
151
  </Members>
 
152
</Type>