Update docs for GLib.
svn path=/trunk/gtk-sharp/; revision=12565
This commit is contained in:
parent
c1444f3883
commit
3082a2d362
5 changed files with 68 additions and 35 deletions
|
@ -35,27 +35,25 @@
|
||||||
<param name="hndlr">The delegate method that will be invoked.</param>
|
<param name="hndlr">The delegate method that will be invoked.</param>
|
||||||
<returns>The handler code assigned to this idle handler.</returns>
|
<returns>The handler code assigned to this idle handler.</returns>
|
||||||
<remarks>
|
<remarks>
|
||||||
<para>
|
<para>
|
||||||
This function installs the <paramref name="hndlr"/> as a
|
This function installs the <paramref name="hndlr" /> as a
|
||||||
handler to be invoked when the GLib mainloop is idle. If
|
handler to be invoked when the GLib mainloop is idle. If
|
||||||
the handler returns <see langword="true"/> the handler is
|
the handler returns <see langword="true" /> the handler is
|
||||||
kept for another round of Idle execution, if <see
|
kept for another round of Idle execution, if <see langword="false" /> is returned, the handler is removed.
|
||||||
langword="false"/> is returned, the handler is removed.
|
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
This method can be invoked from a differen thread than the
|
This method can be invoked from a differen thread than the
|
||||||
one running the Gtk main loop. The delegate will be
|
one running the Gtk main loop. The delegate will be
|
||||||
invoked within the context of the Gtk main loop.
|
invoked within the context of the Gtk main loop.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
The thread-safety of this routine can be used to queue
|
The thread-safety of this routine can be used to queue
|
||||||
work by a thread to be performed in the context of the
|
work by a thread to be performed in the context of the
|
||||||
main Gtk thread. Gtk# is thread aware, but not thread
|
main Gtk thread. Gtk# is thread aware, but not thread
|
||||||
safe; See the <link
|
safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread
|
||||||
location="node:gtk-sharp/programming/threads">Gtk# Thread
|
|
||||||
Programming</link> for details.
|
Programming</link> for details.
|
||||||
</para>
|
</para>
|
||||||
</remarks>
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
</Members>
|
</Members>
|
||||||
|
|
|
@ -11,9 +11,8 @@
|
||||||
<remarks>
|
<remarks>
|
||||||
<para>
|
<para>
|
||||||
The handler specified by the delegate will be invoked during
|
The handler specified by the delegate will be invoked during
|
||||||
the GLib main loop execution. If the handler returns <see
|
the GLib main loop execution. If the handler returns <see langword="true" /> the handler is kept for another round of
|
||||||
langword="true"/> the handler is kept for another round of
|
Idle execution, if <see langword="false" /> is returned, the
|
||||||
Idle execution, if <see langword="false"/> is returned, the
|
|
||||||
handler is removed.
|
handler is removed.
|
||||||
</para>
|
</para>
|
||||||
</remarks>
|
</remarks>
|
||||||
|
|
|
@ -19,11 +19,11 @@
|
||||||
unmanaged resources.
|
unmanaged resources.
|
||||||
</para>
|
</para>
|
||||||
<example>
|
<example>
|
||||||
<para>
|
<para>
|
||||||
For example to create a list of widgets, you would use the
|
For example to create a list of widgets, you would use the
|
||||||
following sample:
|
following sample:
|
||||||
</para>
|
</para>
|
||||||
<code lang="c#">
|
<code lang="c#">
|
||||||
GLib.List MakeList (Gtk.Widget a, Gtk.Widget b)
|
GLib.List MakeList (Gtk.Widget a, Gtk.Widget b)
|
||||||
{
|
{
|
||||||
GLib.List l = new GLib.List ((IntPtr) 0, typeof (Gtk.Widget));
|
GLib.List l = new GLib.List ((IntPtr) 0, typeof (Gtk.Widget));
|
||||||
|
@ -31,8 +31,8 @@
|
||||||
l.Append (b.Handle);
|
l.Append (b.Handle);
|
||||||
}
|
}
|
||||||
</code>
|
</code>
|
||||||
<para>
|
<para>
|
||||||
The <see cref="T:System.Type"/> argument to the GLib.List
|
The <see cref="T:System.Type" /> argument to the GLib.List
|
||||||
constructor, allows the list enumerator code to return
|
constructor, allows the list enumerator code to return
|
||||||
properly wrapped or demarshalled objects from the unmanaged
|
properly wrapped or demarshalled objects from the unmanaged
|
||||||
world into the managed world.
|
world into the managed world.
|
||||||
|
@ -73,11 +73,11 @@
|
||||||
<summary>Duplicates the list, shallow copy.</summary>
|
<summary>Duplicates the list, shallow copy.</summary>
|
||||||
<returns>The duplicated list</returns>
|
<returns>The duplicated list</returns>
|
||||||
<remarks>
|
<remarks>
|
||||||
<para>
|
<para>
|
||||||
Makes a new copy of the list. The individual elements on
|
Makes a new copy of the list. The individual elements on
|
||||||
the list are not duplicated.
|
the list are not duplicated.
|
||||||
</para>
|
</para>
|
||||||
</remarks>
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
|
@ -97,11 +97,10 @@
|
||||||
reference to an existing GLib.List, or they can use
|
reference to an existing GLib.List, or they can use
|
||||||
"(IntPtr) 0" as an initial value.
|
"(IntPtr) 0" as an initial value.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Using this constructor will not track the type information
|
Using this constructor will not track the type information
|
||||||
of the classes or structures kept in the list. If you
|
of the classes or structures kept in the list. If you
|
||||||
plan on tracking the type information, use the <see
|
plan on tracking the type information, use the <see cref="M:GLib.List.List(IntPtr,Type)" /> method.
|
||||||
cref="M:GLib.List.List(IntPtr,Type)"/> method.
|
|
||||||
</para>
|
</para>
|
||||||
</remarks>
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
|
@ -124,7 +123,7 @@
|
||||||
reference to an existing GLib.List, or they can use
|
reference to an existing GLib.List, or they can use
|
||||||
"(IntPtr) 0" as an initial value.
|
"(IntPtr) 0" as an initial value.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Using this constructor will track the type information
|
Using this constructor will track the type information
|
||||||
of the classes or structures kept in the list. This
|
of the classes or structures kept in the list. This
|
||||||
information is used by the List enumerator when returning
|
information is used by the List enumerator when returning
|
||||||
|
|
49
doc/en/GLib/Markup.xml
Normal file
49
doc/en/GLib/Markup.xml
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
<Type Name="Markup" FullName="GLib.Markup">
|
||||||
|
<TypeSignature Language="C#" Value="public class Markup" Maintainer="auto" />
|
||||||
|
<AssemblyInfo>
|
||||||
|
<AssemblyName>glib-sharp</AssemblyName>
|
||||||
|
<AssemblyPublicKey />
|
||||||
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||||
|
<AssemblyCulture>neutral</AssemblyCulture>
|
||||||
|
<Attributes />
|
||||||
|
</AssemblyInfo>
|
||||||
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
||||||
|
<Docs>
|
||||||
|
<summary>To be added</summary>
|
||||||
|
<remarks>To be added</remarks>
|
||||||
|
</Docs>
|
||||||
|
<Base>
|
||||||
|
<BaseTypeName>System.Object</BaseTypeName>
|
||||||
|
</Base>
|
||||||
|
<Interfaces />
|
||||||
|
<Attributes />
|
||||||
|
<Members>
|
||||||
|
<Member MemberName="EscapeText">
|
||||||
|
<MemberSignature Language="C#" Value="public static string EscapeText (string s);" />
|
||||||
|
<MemberType>Method</MemberType>
|
||||||
|
<ReturnValue>
|
||||||
|
<ReturnType>System.String</ReturnType>
|
||||||
|
</ReturnValue>
|
||||||
|
<Parameters>
|
||||||
|
<Parameter Name="s" Type="System.String" />
|
||||||
|
</Parameters>
|
||||||
|
<Docs>
|
||||||
|
<summary>To be added</summary>
|
||||||
|
<param name="s">To be added: an object of type 'string'</param>
|
||||||
|
<returns>To be added: an object of type 'string'</returns>
|
||||||
|
<remarks>To be added</remarks>
|
||||||
|
</Docs>
|
||||||
|
</Member>
|
||||||
|
<Member MemberName=".ctor">
|
||||||
|
<MemberSignature Language="C#" Value="public Markup ();" />
|
||||||
|
<MemberType>Constructor</MemberType>
|
||||||
|
<ReturnValue />
|
||||||
|
<Parameters />
|
||||||
|
<Docs>
|
||||||
|
<summary>To be added</summary>
|
||||||
|
<returns>To be added: an object of type 'GLib.Markup'</returns>
|
||||||
|
<remarks>To be added</remarks>
|
||||||
|
</Docs>
|
||||||
|
</Member>
|
||||||
|
</Members>
|
||||||
|
</Type>
|
|
@ -168,18 +168,6 @@
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="DisposeNative">
|
|
||||||
<MemberSignature Language="C#" Value="protected virtual void DisposeNative ();" />
|
|
||||||
<MemberType>Method</MemberType>
|
|
||||||
<ReturnValue>
|
|
||||||
<ReturnType>System.Void</ReturnType>
|
|
||||||
</ReturnValue>
|
|
||||||
<Parameters />
|
|
||||||
<Docs>
|
|
||||||
<summary>To be added</summary>
|
|
||||||
<remarks>To be added</remarks>
|
|
||||||
</Docs>
|
|
||||||
</Member>
|
|
||||||
<Member MemberName="Dispose">
|
<Member MemberName="Dispose">
|
||||||
<MemberSignature Language="C#" Value="public virtual void Dispose ();" />
|
<MemberSignature Language="C#" Value="public virtual void Dispose ();" />
|
||||||
<MemberType>Method</MemberType>
|
<MemberType>Method</MemberType>
|
||||||
|
|
Loading…
Add table
Reference in a new issue