ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

more pango docs

Browse source 
svn path=/trunk/gtk-sharp/; revision=31262
This commit is contained in:
John Luke 2004-07-17 17:24:02 +00:00
parent 0bf3897a25
commit 38b2f0fd39
24 changed files with 238 additions and 217 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/en/Pango/Attr.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Static methods for attributes.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>

8
doc/en/Pango/AttrClass.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Stores the type and operations for a particular type of attribute.</summary>
<remarks>To be added</remarks> <remarks>The functions in this structure should not be called directly. Instead, one should use the wrapper functions provided for <see cref="T:Pango.Attribute" />.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the type ID for this attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

12
doc/en/Pango/AttrColor.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes that are colors.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Color"> <Member MemberName="Color">
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the PangoColor which is the value of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

4
doc/en/Pango/AttrFilterFunc.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>used by <see cref="M:Pango.AttrList.Filter()" /> to filter out a subset of attributes for a list.</summary>
<remarks>To be added</remarks> <remarks>Returns <see langword="true" /> if the attribute should be filtered out</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

10
doc/en/Pango/AttrFloat.xml
View file

@ -10,7 +10,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes with a float or double value.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Value"> <Member MemberName="Value">
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the value of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

24
doc/en/Pango/AttrFontDesc.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to store an attribute that sets all aspects of the font description at once.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -41,10 +41,10 @@
<Parameter Name="desc" Type="Pango.FontDescription" /> <Parameter Name="desc" Type="Pango.FontDescription" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new <see cref="T:Pango.AttrFontDesc" /> from the provided <see cref="T:Pango.FontDescription" />.</summary>
<param name="desc">To be added: an object of type 'Pango.FontDescription'</param> <param name="desc">a <see cref="T:Pango.FontDescription" /></param>
<returns>To be added: an object of type 'Pango.AttrFontDesc'</returns> <returns>a new <see cref="T:Pango.AttrFontDesc" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -72,10 +72,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the font description which is the value of this attribute</summary>
<param name="value">To be added: an object of type 'Pango.FontDescription'</param> <param name="value">a <see cref="T:Pango.FontDescription" /></param>
<returns>To be added: an object of type 'Pango.FontDescription'</returns> <returns>a <see cref="T:Pango.FontDescription" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Attr"> <Member MemberName="Attr">
@ -87,8 +87,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

14
doc/en/Pango/AttrInt.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes with a integer or enumeration value.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -41,7 +41,7 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param> <param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Pango.AttrInt" /></returns> <returns>an object of type <see cref="T:Pango.AttrInt" /></returns>
<remarks>This is an internal method, and should not be used by user code.</remarks> <remarks>This is an internal method, and should not be used by user code.</remarks>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Value"> <Member MemberName="Value">
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the value of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

51
doc/en/Pango/AttrIterator.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent an iterator through a <see cref="T:Pango.List" />.</summary>
<remarks>To be added</remarks> <remarks>A new iterator is created with <see cref="P:Pango.AttrList.Iterator" />. Once the iterator is created, it can be advanced through the style changes in the text using <see cref="M:Pango.AttrIterator.Next()" />. At each style change, the range of the current style segment and the attributes currently in effect can be queried.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,8 +31,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy a <see cref="T:Pango.AttrIterator" /> and free all associated memory.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Next"> <Member MemberName="Next">
@ -43,9 +43,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Advance the iterator until the next change of style.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="false" /> if the iterator is at the end of the list, otherwise <see langword="true" /></returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -56,9 +57,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Make a copy of the iterator.</summary>
<returns>To be added: an object of type 'Pango.AttrIterator'</returns> <returns>a <see cref="T:Pango.AttrIterator" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Get"> <Member MemberName="Get">
@ -71,10 +72,10 @@
<Parameter Name="type" Type="Pango.AttrType" /> <Parameter Name="type" Type="Pango.AttrType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Find the current attribute of a particular type at the iterator location.</summary>
<param name="type">To be added: an object of type 'Pango.AttrType'</param> <param name="type"> the type of attribute to find.</param>
<returns>To be added: an object of type 'Pango.Attribute'</returns> <returns> the current attribute of the given type, or <see langword="null" /> if no attribute of that type applies to the current location.</returns>
<remarks>To be added</remarks> <remarks>When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is used.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -104,10 +105,10 @@
<Parameter Name="end" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="end" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the range of the current segment.</summary>
<param name="start">a <see cref="T:System.Int32&amp;" /></param> <param name="start"> location to store the start of the range</param>
<param name="end">a <see cref="T:System.Int32&amp;" /></param> <param name="end"> location to store the end of the range</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Attrs"> <Member MemberName="Attrs">
@ -118,9 +119,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets a list all attributes a the current position of the iterator.</summary>
<returns>a <see cref="T:Pango.Attribute[]" /></returns> <returns>a <see cref="T:Pango.Attribute[]" /></returns>
<remarks>To be added</remarks> <remarks> a list of all attributes for the current range.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetFont"> <Member MemberName="GetFont">
@ -135,11 +136,11 @@
<Parameter Name="extra_attrs" Type="Pango.Attribute[]&amp;" RefType="out" /> <Parameter Name="extra_attrs" Type="Pango.Attribute[]&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the font and other attributes at the current iterator position.</summary>
<param name="desc">a <see cref="T:Pango.FontDescription" /></param> <param name="desc"> a <see cref="T:Pango.FontDescription" /> to fill in with the current values. The family name in this structure will be set using <see cref="M:Pango.FontDescription.SetFamilyStatic()" /> using values from an attribute in the <see cref="T:Pango.AttrList" /> associated with the iterator, so if you plan to keep it around, you must call: <see cref="T:Pango.FontDescription.SetFamily (desc, pango_font_description_get_family (desc))" />.</param>
<param name="language">a <see cref="T:Pango.Language" /></param> <param name="language"> if non-<see langword="null" />, location to store language tag for item, or <see langword="null" /> if non is found.</param>
<param name="extra_attrs">a <see cref="T:Pango.Attribute[]" /></param> <param name="extra_attrs"> if non-<see langword="null" />, location in which to store a list of non-font attributes at the the current position; only the highest priority value of each attribute will be added to this list.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

22
doc/en/Pango/AttrLanguage.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes that are languages.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -41,10 +41,10 @@
<Parameter Name="language" Type="Pango.Language" /> <Parameter Name="language" Type="Pango.Language" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a new <see cref="T:Pango.AttrLanguage" /> from the provided <see cref="T:Pango.Language" /></summary>
<param name="language">To be added: an object of type 'Pango.Language'</param> <param name="language">a <see cref="T:Pango.Language" /></param>
<returns>To be added: an object of type 'Pango.AttrLanguage'</returns> <returns>a new <see cref="T:Pango.AttrLanguage" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -72,9 +72,9 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the PangoLanguage which is the value of the attribute</summary>
<param name="value">To be added: an object of type 'Pango.Language'</param> <param name="value">a <see cref="T:Pango.Language" /></param>
<returns>To be added: an object of type 'Pango.Language'</returns> <returns>a <see cref="T:Pango.Language" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -87,8 +87,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

69
doc/en/Pango/AttrList.xml
View file

@ -10,8 +10,10 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Represents a list of attributes that apply to a section of text.</summary>
<remarks>To be added</remarks> <remarks>The attributes are, in general, allowed to overlap in an arbitrary fashion, however, if the attributes are manipulated only through <see cref="M:Pango.AttrList.Change()" />, the overlap between properties will meet stricter criteria.
<para>Since the <see cref="T:Pango.AttrList" /> is stored as a linear list, it is not suitable for storing attributes for large amounts of text. In general, you should not use a single <see cref="T:Pango.AttrList" /> for more than one paragraph of text.
</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,9 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Copy list and return an identical, new list.</summary>
<returns>To be added: an object of type 'Pango.AttrList'</returns> <returns>a new <see cref="T:Pango.AttrList" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Change"> <Member MemberName="Change">
@ -46,9 +48,13 @@
<Parameter Name="attr" Type="Pango.Attribute" /> <Parameter Name="attr" Type="Pango.Attribute" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Insert the given attribute into the list.</summary>
<param name="attr">To be added: an object of type 'Pango.Attribute'</param> <param name="attr">a <see cref="T:Pango.Attribute" /></param>
<remarks>To be added</remarks> <remarks>It will replace any attributes of the same type on that segment and be merged with any adjoining attributes that are identical.
<block subset="none" type="note">
<para>This function is slower than <see cref="M:Pango.AttrList.Insert()" /> for creating a attribute list in order (potentially much slower for large lists). However, <see cref="M:Pango.AttrList.Insert()" /> is not suitable for continually changing a set of attributes since it never removes or combines existing attributes.
</para>
</block></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsertBefore"> <Member MemberName="InsertBefore">
@ -61,9 +67,9 @@
<Parameter Name="attr" Type="Pango.Attribute" /> <Parameter Name="attr" Type="Pango.Attribute" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Insert the given attribute into the list.</summary>
<param name="attr">To be added: an object of type 'Pango.Attribute'</param> <param name="attr"> the attribute to insert.</param>
<remarks>To be added</remarks> <remarks>It will be inserted before all other attributes with a matching start_index.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unref"> <Member MemberName="Unref">
@ -74,8 +80,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Decrease the reference count of the given attribute list by one.</summary>
<remarks>To be added</remarks> <remarks>If the result is zero, free the attribute list and the attributes it contains.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Splice"> <Member MemberName="Splice">
@ -90,11 +96,12 @@
<Parameter Name="len" Type="System.Int32" /> <Parameter Name="len" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This function splices attribute list <paramref name="other" /> into list.</summary>
<param name="other">To be added: an object of type 'Pango.AttrList'</param> <param name="other">another <see cref="T:Pango.AttrList" /></param>
<param name="pos">To be added: an object of type 'int'</param> <param name="pos"> the position at which to insert <paramref name="other" /></param>
<param name="len">To be added: an object of type 'int'</param> <param name="len">the length of the spliced segment.</param>
<remarks>To be added</remarks> <remarks>This operation is equivalent to stretching every attribute applies at position <paramref name="pos" /> in list by an amount <paramref name="len" />, and then calling <see cref="M:Pango.AttrList.Change()" /> with a copy of each attributes in other in sequence (offset in position by <paramref name="pos" />).
This operation proves useful for, for instance, inserting a pre-edit string in the middle of an edit buffer.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Ref"> <Member MemberName="Ref">
@ -105,8 +112,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Increase the reference count of the given attribute list by one.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Insert"> <Member MemberName="Insert">
@ -119,9 +126,9 @@
<Parameter Name="attr" Type="Pango.Attribute" /> <Parameter Name="attr" Type="Pango.Attribute" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Insert the given attribute to the list</summary>
<param name="attr">To be added: an object of type 'Pango.Attribute'</param> <param name="attr"> the attribute to insert.</param>
<remarks>To be added</remarks> <remarks>It will be inserted after all other attributes with a matching start_index.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -146,9 +153,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor</summary>
<returns>To be added: an object of type 'Pango.AttrList'</returns> <returns>a new <see cref="T:Pango.AttrList" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Iterator"> <Member MemberName="Iterator">
@ -158,9 +165,9 @@
<ReturnType>Pango.AttrIterator</ReturnType> <ReturnType>Pango.AttrIterator</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a iterator initialized to the beginning of the list.</summary>
<returns>To be added: an object of type 'Pango.AttrIterator'</returns> <returns>a new <see cref="T:Pango.AttrIterator" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Filter"> <Member MemberName="Filter">
@ -173,10 +180,10 @@
<Parameter Name="func" Type="Pango.AttrFilterFunc" /> <Parameter Name="func" Type="Pango.AttrFilterFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Given a callback function, removes any elements of list for which <paramref name="func" /> returns <see langword="true" /> and inserts them into a new list.</summary>
<param name="func">a <see cref="T:Pango.AttrFilterFunc" /></param> <param name="func">a <see cref="T:Pango.AttrFilterFunc" /></param>
<returns>a <see cref="T:Pango.AttrList" /></returns> <returns>a <see cref="T:Pango.AttrList" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

26
doc/en/Pango/AttrShape.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes which impose shape restrictions.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -42,11 +42,11 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" /> <Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates a new <see cref="T:Pango.AttrShape" /> from the provided <see cref="T:Pango.Rectangle" />s.</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="ink_rect">the ink rectangle to restrict to</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="logical_rect">the logical rectangle to restrict to</param>
<returns>To be added: an object of type 'Pango.AttrShape'</returns> <returns>a new <see cref="T:Pango.AttrShape" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -74,8 +74,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InkRect"> <Member MemberName="InkRect">
@ -87,8 +87,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the ink rectangle to restrict to</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LogicalRect"> <Member MemberName="LogicalRect">
@ -100,8 +100,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the logical rectangle to restrict to</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

10
doc/en/Pango/AttrString.xml
View file

@ -10,7 +10,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent attributes with a string value.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the common portion of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Value"> <Member MemberName="Value">
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the string which is the value of the attribute</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

19
doc/en/Pango/Attribute.xml
View file

@ -57,10 +57,11 @@
<Parameter Name="attr2" Type="Pango.Attribute" /> <Parameter Name="attr2" Type="Pango.Attribute" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Compare two attributes for equality.</summary>
<param name="attr2">To be added: an object of type 'Pango.Attribute'</param> <param name="attr2">a <see cref="T:Pango.Attribute" /> to be tested for equality.</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if the two attributes have the same value.</returns>
<remarks>This compares only the actual value of the two attributes and not the ranges that the attributes apply to.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Destroy"> <Member MemberName="Destroy">
@ -71,8 +72,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy a <see cref="T:Pango.Attribute" /> and free all associated memory.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -83,9 +84,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Make a copy of an attribute.</summary>
<returns>To be added: an object of type 'Pango.Attribute'</returns> <returns>a new <see cref="T:Pango.Attribute" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="klass"> <Member MemberName="klass">

4
doc/en/Pango/Color.xml
View file

@ -72,8 +72,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Frees a color allocated by <see cref="M:Pango.Color.Copy()" />.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">

4
doc/en/Pango/EngineLang.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Rendering-system independent script engines</summary>
<remarks>To be added</remarks> <remarks>The <see cref="T:Pango.EngineLang" /> is implemented by engines that customize the rendering-system independent part of the Pango pipeline for a particular script or language. For instance, a custom <see cref="T:Pango.EngineLang" /> could be provided for Thai to implement the dictionary-based word boundary lookups needed for that language.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>

4
doc/en/Pango/EngineShape.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary> Rendering-system dependent script engines</summary>
<remarks>To be added</remarks> <remarks>The <see cref="T:Pango.EngineShape" /> class is implemented by engines that customize the rendering-system dependent part of the Pango pipeline for a particular script or language. A <see cref="T:Pango.EngineShape" /> implementation is then specific to both a particular rendering system or group of rendering systems and to a particular script. For instance, there is one <see cref="T:Pango.EngineShape" /> implementation to handling shaping Arabic for Fontconfig-based backends.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>

36
doc/en/Pango/FT2FontMap.xml
View file

@ -10,7 +10,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:Pango.FT2FontMap" /> is the <see cref="T:Pango.FontMap" /> implementation for FreeType fonts.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -34,9 +34,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns a <see cref="T:Pango.FT2FontMap" />.</summary>
<returns>a <see cref="T:Pango.FontMap" /></returns> <returns>a <see cref="T:Pango.FontMap" /></returns>
<remarks>To be added</remarks> <remarks>Use of the global PangoFT2 fontmap is deprecated.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SubstituteChanged"> <Member MemberName="SubstituteChanged">
@ -47,8 +47,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Call this any time the results of the default substitution function set with <see cref="M:Pango.FT2FontMap.SetDefaultSubstitute()" /> changes.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetResolution"> <Member MemberName="SetResolution">
@ -62,10 +62,10 @@
<Parameter Name="dpi_y" Type="System.Double" /> <Parameter Name="dpi_y" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the horizontal and vertical resolutions for the fontmap.</summary>
<param name="dpi_x">a <see cref="T:System.Double" /></param> <param name="dpi_x"> dots per inch in the X direction</param>
<param name="dpi_y">a <see cref="T:System.Double" /></param> <param name="dpi_y"> dots per inch in the Y direction</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateContext"> <Member MemberName="CreateContext">
@ -76,9 +76,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Create a <see cref="T:Pango.Context" /> for the given fontmap.</summary>
<returns>a <see cref="T:Pango.Context" /></returns> <returns>a new <see cref="T:Pango.Context" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -89,8 +89,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with the object.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -101,10 +101,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.FT2FontMap" /></returns> <returns>a <see cref="T:Pango.FT2FontMap" /></returns>
<remarks>To be added</remarks> <remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -113,9 +113,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor</summary>
<returns>a <see cref="T:Pango.FT2FontMap" /></returns> <returns>a <see cref="T:Pango.FT2FontMap" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

4
doc/en/Pango/FT2SubstituteFunc.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>For doing final config tweaking on prepared FcPatterns.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Pango/Global.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Global API elements for <see cref="N:Pango" /></summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>

37
doc/en/Pango/GlyphItem.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A pair of a <see cref="T:Pango.Item" /> and the glyphs resulting from shaping the text corresponding to an item.</summary>
<remarks>To be added</remarks> <remarks>As an example of the usage of <see cref="T:Pango.GlyphItem" />, the results of shaping text with <see cref="T:Pango.Layout" /> is a list of <see cref="T:Pango.LayoutLine" />, each of which contains a list of <see cref="T:Pango.GlyphItem" />.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -58,11 +58,15 @@
<Parameter Name="split_index" Type="System.Int32" /> <Parameter Name="split_index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Splits an Item</summary>
<param name="text">a <see cref="T:System.String" /></param> <param name="text"> text to which positions in orig apply.</param>
<param name="split_index">a <see cref="T:System.Int32" /></param> <param name="split_index"> byte index of position to split item, relative to the start of the item</param>
<returns>a <see cref="T:Pango.GlyphItem" /></returns> <returns>a <see cref="T:Pango.GlyphItem" /> representing the text before <paramref name="split_index" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
Modifies orig to cover only the text after <paramref name="split_index" />, and returns a new item that covers the text before <paramref name="split_index" /> that used to be in orig. You can think of <paramref name="split_index" /> as the length of the returned item. <paramref name="split_index" /> may not be 0, and it may not be greater than or equal to the length of orig (that is, there must be at least one byte assigned to each item, you cannot create a zero-length item).
</para>
This function is similar in function to <see cref="M:Pango.Item.Split()" /> (and uses it internally)</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="glyphs"> <Member MemberName="glyphs">
@ -72,9 +76,9 @@
<ReturnType>Pango.GlyphString</ReturnType> <ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>the glyphs obtained by shaping the text corresponding to item.</summary>
<returns>a <see cref="T:Pango.GlyphString" /></returns> <returns>a <see cref="T:Pango.GlyphString" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="item"> <Member MemberName="item">
@ -84,9 +88,9 @@
<ReturnType>Pango.Item</ReturnType> <ReturnType>Pango.Item</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>a <see cref="T:Pango.Item" /> that provides information about a segment of text.</summary>
<returns>a <see cref="T:Pango.Item" /></returns> <returns>a <see cref="T:Pango.Item" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ApplyAttrs"> <Member MemberName="ApplyAttrs">
@ -100,11 +104,18 @@
<Parameter Name="list" Type="Pango.AttrList" /> <Parameter Name="list" Type="Pango.AttrList" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Splits a shaped item (<see cref="T:Pango.GlyphItem" />) into multiple items based on an attribute list.</summary>
<param name="text">a <see cref="T:System.String" /></param> <param name="text">a <see cref="T:System.String" /></param>
<param name="list">a <see cref="T:Pango.AttrList" /></param> <param name="list">a <see cref="T:Pango.AttrList" /></param>
<returns>a <see cref="T:Pango.GlyphItem[]" /></returns> <returns>a <see cref="T:Pango.GlyphItem[]" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
The idea is that if you have attributes that do not affect shaping, such as color or underline, to avoid affecting shaping, you filter them out (<see cref="M:Pango.AttrList.Filter()" />), apply the shaping process and then re-apply them to the result using this function.
</para>
<para>
All attributes that start or end inside a cluster are applied to that cluster; for instance, if half of a cluster is underlined and the other-half strikethough, then the cluster will end up with both underline and strikethrough attributes. In these cases, it may happen that item-&gt;extra_attrs for some of the result items can have multiple attributes of the same type.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

46
doc/en/Pango/Item.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Stores information about a segment of text.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -39,9 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates a new Item</summary>
<returns>To be added: an object of type 'Pango.Item'</returns> <returns>a new <see cref="T:Pango.Item" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -68,8 +68,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Free a <see cref="T:Pango.Item" /> and all associated memory.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -80,9 +80,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Copy an existing <see cref="T:Pango.Item" /> structure.</summary>
<returns>To be added: an object of type 'Pango.Item'</returns> <returns>a new <see cref="T:Pango.Item" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Split"> <Member MemberName="Split">
@ -96,11 +96,11 @@
<Parameter Name="split_offset" Type="System.Int32" /> <Parameter Name="split_offset" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Modifies orig to cover only the text after <paramref name="split_index" />, and returns a new item that covers the text before <paramref name="split_index" /> that used to be in orig.</summary>
<param name="split_index">To be added: an object of type 'int'</param> <param name="split_index"> byte index of position to split item, relative to the start of the item</param>
<param name="split_offset">To be added: an object of type 'int'</param> <param name="split_offset"> number of chars between start of orig and <paramref name="split_index" /></param>
<returns>To be added: an object of type 'Pango.Item'</returns> <returns> new item representing text before <paramref name="split_index" /></returns>
<remarks>To be added</remarks> <remarks>You can think of <paramref name="split_index" /> as the length of the returned item. <paramref name="split_index" /> may not be 0, and it may not be greater than or equal to the length of orig (that is, there must be at least one byte assigned to each item, you cannot create a zero-length item). <paramref name="split_offset" /> is the length of the first item in chars, and must be provided because the text used to generate the item is not available, so <see cref="M:Pango.Item.Split()" /> cannot count the char length of the split items itself.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Offset"> <Member MemberName="Offset">
@ -112,8 +112,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the offset of the segment from the beginning of the string in bytes.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Length"> <Member MemberName="Length">
@ -125,8 +125,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the length of the segment in bytes.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NumChars"> <Member MemberName="NumChars">
@ -138,8 +138,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the length of the segment in characters.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Analysis"> <Member MemberName="Analysis">
@ -151,8 +151,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>the properties of the segment.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

27
doc/en/Pango/Language.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Used to represent a language.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -33,10 +33,10 @@
<Parameter Name="language" Type="System.String" /> <Parameter Name="language" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Take a RFC-3066 format language tag as a string and convert it to a <see cref="T:Pango.Language" /></summary>
<param name="language">To be added: an object of type 'string'</param> <param name="language"> a string representing a language tag</param>
<returns>To be added: an object of type 'Pango.Language'</returns> <returns>a <see cref="T:Pango.Language" /></returns>
<remarks>To be added</remarks> <remarks>This function first canonicalizes the string by converting it to lowercase, mapping '_' to '-', and stripping all characters other than letters and '-'.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Matches"> <Member MemberName="Matches">
@ -49,10 +49,11 @@
<Parameter Name="range_list" Type="System.String" /> <Parameter Name="range_list" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Checks if a language tag matches one of the elements in a list of language ranges.</summary>
<param name="range_list">To be added: an object of type 'string'</param> <param name="range_list"> a list of language ranges, separated by ';' characters. each element must either be '*', or a RFC 3066 language range canonicalized as by <see cref="M:Pango.LanguageFromString()" />.</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if a match was found.</returns>
<remarks>A language tag is considered to match a range in the list if the range is '*', the range is exactly the tag, or the range is a prefix of the tag, and the character after the tag is '-'.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -78,9 +79,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>A sample </summary>
<returns>To be added: an object of type 'string'</returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

4
doc/en/Pango/LogAttr.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Stores information about the attributes of a single character.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>

12
doc/en/Pango/Win32FontCache.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Caches HFONTs by their LOGFONT descriptions.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,8 +31,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Frees a <see cref="T:Pango.Win32FontCache" /> and all associated memory.</summary>
<remarks>To be added</remarks> <remarks>All fonts loaded through this font cache will be freed along with the cache.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -57,9 +57,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor</summary>
<returns>an object of type <see cref="T:Pango.Win32FontCache" /></returns> <returns>an object of type <see cref="T:Pango.Win32FontCache" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>