File: LogCore.xml

package info (click to toggle)
banshee 0.11.2%2Bdfsg-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 11,976 kB
  • ctags: 9,958
  • sloc: cs: 54,529; xml: 21,240; sh: 8,835; ansic: 2,040; makefile: 1,248
file content (254 lines) | stat: -rw-r--r-- 10,754 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<Type Name="LogCore" FullName="Banshee.Base.LogCore">
  <TypeSignature Language="C#" Value="public class LogCore : System.Collections.IEnumerable" />
  <AssemblyInfo>
    <AssemblyName>Banshee.Base</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Collections.IEnumerable</InterfaceName>
    </Interface>
  </Interfaces>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected LogCore ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Updated">
      <MemberSignature Language="C#" Value="public event Banshee.Base.LogCoreUpdatedHandler Updated;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogCoreUpdatedHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PrintEntries">
      <MemberSignature Language="C#" Value="public static bool PrintEntries;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Whether or not logged messages are printed to stdout.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushError">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushError (string shortMessage, string details);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushError">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushError (string shortMessage, string details, bool showUser);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
        <Parameter Name="showUser" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <param name="showUser">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushWarning">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushWarning (string shortMessage, string details);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushWarning">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushWarning (string shortMessage, string details, bool showUser);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
        <Parameter Name="showUser" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <param name="showUser">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushInformation">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushInformation (string shortMessage, string details);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushInformation">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushInformation (string shortMessage, string details, bool showUser);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
        <Parameter Name="showUser" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <param name="showUser">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushDebug">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushDebug (string shortMessage, string details);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PushDebug">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry PushDebug (string shortMessage, string details, bool showUser);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="shortMessage" Type="System.String" />
        <Parameter Name="details" Type="System.String" />
        <Parameter Name="showUser" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="shortMessage">To be added.</param>
        <param name="details">To be added.</param>
        <param name="showUser">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Push">
      <MemberSignature Language="C#" Value="public Banshee.Base.LogEntry Push (Banshee.Base.LogEntry entry);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogEntry</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="entry" Type="Banshee.Base.LogEntry" />
      </Parameters>
      <Docs>
        <param name="entry">The entry that should be added to the message log. Will be shown to the user if needed.</param>
        <summary>Add a <see cref="T:Banshee.Base.LogEntry" /> to the message log.</summary>
        <returns>The <see cref="T:Banshee.Base.LogEntry" /> given as the parameter.</returns>
        <remarks>When using one of the static methods on <see cref="T:Banshee.Base.LogCore" /> (PushError, PushWarning, PushInformation or PushDebug), Push will be invoked automatically on the newly created <see cref="T:Banshee.Base.LogEntry" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetEnumerator">
      <MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>An enumeration of all pushed log messages.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Instance">
      <MemberSignature Language="C#" Value="public static Banshee.Base.LogCore Instance { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Banshee.Base.LogCore</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The LogCore instance.</summary>
        <value>The only possible LogCore instance.</value>
        <remarks>LogCore is modelled as a singleton: There can only be one instance of the LogCore class. To obtain this behavior, LogCore has a protected (thus inaccessible) constructor. Retrieving the LogCore instance can be done using this property. For examples on how to use the LogCore, see the general LogCore information: <see cref="T:Banshee.Base.LogCore" />.</remarks>
      </Docs>
    </Member>
  </Members>
  <Docs>
    <summary>LogCore provides internal logging functions, used for error messages and debugging purposes.</summary>
    <remarks>LogCore is modelled as a singleton. To retreive the LogCore, use the Instance field.
<example>
        <code lang="C#">
// Simple invokation, adds an information message to 
// the log and shows it to the user.
LogCore.Instance.PushInformation("Important information", 
					"Showing lot's of information boxes can be annoying", 
					true);
</code>
      </example></remarks>
  </Docs>
</Type>