GtkSharp/doc/en/Pango/ScriptIter.xml
Dan Winship 0fa85fccbd * parser/gapi2xml.pl (addParamsElem): deal with G_CONST_RETURN in
params... some functions use that to mark const "out" params. In
	fact, let's use it as a hint to mark them pass_as="out" too...

	* pango/pango-api-2.4.raw: 
	* pango/pango-api-2.6.raw: 
	* gtk/gtk-api-2.6.raw: Regen, fixing pango_script_iter_get_range
	and gtk_image_get_icon_name.

	* pango/Pango.metadata: 
	* pango/ScriptIter.cs: Alas, exposing GetRange makes it clear that
	PangoScriptIter is really weird and we weren't wrapping it
	correctly before anyway, so mark the whole thing hidden and wrap
	it by hand.

svn path=/trunk/gtk-sharp/; revision=47748
2005-07-27 13:21:15 +00:00

96 lines
4.3 KiB
XML

<Type Name="ScriptIter" FullName="Pango.ScriptIter">
<TypeSignature Language="C#" Maintainer="auto" Value="public class ScriptIter : GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.6.0.0</AssemblyVersion>
</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>Used to iterate through a string and identify ranges in different scripts.</summary>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete. Do not use</summary>
<remarks>
<see cref="T:Pango.ScriptIter" /> is properly garbage-collected now. You do not need to manually free it.
</remarks>
</Docs>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public bool Next ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Advances a <see cref="T:Pango.ScriptIter" /> to the next range.</summary>
<returns>a <see cref="T:System.Boolean" />, <see langword="true" /> if the iter was succesfully advanced.</returns>
<remarks>If the iter is already at the end, it is left unchanged and <see langword="false" /> is returned.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ScriptIter (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ScriptIter (string text);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Pango.ScriptIter" /> from <paramref name="text" />.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="GetRange">
<MemberSignature Language="C#" Value="public void GetRange (out int start, out int len, out Pango.Script script);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="len" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="script" Type="Pango.Script&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="start">On return, contains the index of the start of the current range.</param>
<param name="len">On return, contains the length of the current range.</param>
<param name="script">On return, contains the script type of the current range.</param>
<summary>Gets the bounds and script type of the current range.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>