ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-26 01:55:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

2004-08-01 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Pango/*: Filled in all "To be added"; cleaned
	up existing docs and made them more consistent.

svn path=/trunk/gtk-sharp/; revision=31738
This commit is contained in:
Shane Landrum 2004-08-02 13:36:06 +00:00
parent 076642e2c7
commit c0cb153d7d
16 changed files with 524 additions and 522 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2004-08-01 Shane Landrum <epicene@pobox.com>
* en/Pango/*: Filled in all "To be added"; cleaned
up existing docs and made them more consistent.
2004-07-27 John Luke <john.luke@gmail.com> 2004-07-27 John Luke <john.luke@gmail.com>
some GLib and Atk docs some GLib and Atk docs

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

@ -27,8 +27,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>returns an empty <see cref="T:Pango.AttrClass" /></summary> <summary>Returns an empty <see cref="T:Pango.AttrClass" /></summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">

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

@ -28,7 +28,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Returns an empty <see cref="T:Pango.AttrFontDesc" /></summary> <summary>Returns an empty <see cref="T:Pango.AttrFontDesc" /></summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">

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

@ -75,7 +75,7 @@
<summary>the PangoLanguage which is the value of the attribute</summary> <summary>the PangoLanguage which is the value of the attribute</summary>
<param name="value">a <see cref="T:Pango.Language" /></param> <param name="value">a <see cref="T:Pango.Language" /></param>
<returns>a <see cref="T:Pango.Language" /></returns> <returns>a <see cref="T:Pango.Language" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Attr"> <Member MemberName="Attr">

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

@ -27,8 +27,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Returns an empty <see cref="T:Pango.Color" /></summary> <summary>Returns an empty <see cref="T:Pango.Color" /> object.</summary>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">

2
doc/en/Pango/Coverage.xml
View file

@ -168,7 +168,7 @@
<summary>Convert a <see cref="T:Pango.Coverage" /> structure into a flat binary format.</summary> <summary>Convert a <see cref="T:Pango.Coverage" /> structure into a flat binary format.</summary>
<param name="bytes"> location to store result</param> <param name="bytes"> location to store result</param>
<param name="n_bytes">a <see cref="T:System.Int32&amp;" /></param> <param name="n_bytes">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

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

@ -120,8 +120,8 @@
<Docs> <Docs>
<summary>Gets the logical and ink extents of a glyph within a font.</summary> <summary>Gets the logical and ink extents of a glyph within a font.</summary>
<param name="glyph"> the glyph index</param> <param name="glyph"> the glyph index</param>
<param name="ink_rect"> rectangle used to store the extents of the glyph as drawn or <see langword="null" /> to indicate that the result is not needed.</param> <param name="ink_rect">a <see cref="T:Pango.Rectangle" /> used to store the extents of the glyph as drawn or <see langword="null" /> to indicate that the result is not needed.</param>
<param name="logical_rect"> rectangle used to store the logical extents of the glyph or <see langword="null" /> to indicate that the result is not needed.</param> <param name="logical_rect">a <see cref="T:Pango.Rectangle" /> used to store the logical extents of the glyph or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The units of the rectangles are in 1 / <see cref="F:Pango.Scale.PangoScale" /> of a device unit.</remarks> <remarks>The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The units of the rectangles are in 1 / <see cref="F:Pango.Scale.PangoScale" /> of a device unit.</remarks>
</Docs> </Docs>
</Member> </Member>

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

@ -77,8 +77,8 @@ Any one of the options may be absent. If FAMILY-LIST is absent, then the family_
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Determines which <see cref="T:Pango.FontDescription" /> better matches the current instance.</summary> <summary>Determines which <see cref="T:Pango.FontDescription" /> better matches the current instance.</summary>
<param name="old_match">To be added: an object of type 'Pango.FontDescription'</param> <param name="old_match">a <see cref="T:Pango.FontDescription" /> object</param>
<param name="new_match">To be added: an object of type 'Pango.FontDescription'</param> <param name="new_match">a <see cref="T:Pango.FontDescription" /> object</param>
<returns> <returns>
<see langword="true" /> if new_match is a better match.</returns> <see langword="true" /> if new_match is a better match.</returns>
<remarks>Determines if the style attributes of new_match are a closer match for the current instance than old_match, or if old_match is <see langword="null" />, determines if new_match is a match at all. Approximate matching is done for weight and style; other attributes must match exactly.</remarks> <remarks>Determines if the style attributes of new_match are a closer match for the current instance than old_match, or if old_match is <see langword="null" />, determines if new_match is a match at all. Approximate matching is done for weight and style; other attributes must match exactly.</remarks>

75
doc/en/Pango/Global.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>Global API elements for <see cref="N:Pango" /></summary> <summary>Global API elements for <see cref="N:Pango" />. Most of these are utility functions.</summary>
<remarks /> <remarks />
</Docs> </Docs>
<Base> <Base>
@ -29,10 +29,10 @@
<Parameter Name="str" Type="System.String" /> <Parameter Name="str" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Splits a list of filename strings and normalizes their paths.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>In the underlying C implementation, the string returned is intended as an argument to g_strfreev.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TrimString"> <Member MemberName="TrimString">
@ -45,10 +45,10 @@
<Parameter Name="str" Type="System.String" /> <Parameter Name="str" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Trims leading and trailing whitespace from a string.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetLogAttrs"> <Member MemberName="GetLogAttrs">
@ -84,10 +84,10 @@
<Parameter Name="pos" Type="System.String" /> <Parameter Name="pos" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Skips 0 or more characters of whitespace</summary>
<param name="pos">a <see cref="T:System.String" /></param> <param name="pos">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, which is true if there are non-whitespace characters before the end of the string.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -113,12 +113,12 @@
<Parameter Name="warn" Type="System.Boolean" /> <Parameter Name="warn" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Parses a string into a <see cref="T:Pango.Weight&amp;" /> object.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /> to parse</param>
<param name="weight">a <see cref="T:Pango.Weight&amp;" /></param> <param name="weight">a <see cref="T:Pango.Weight&amp;" /> object to set up with the weight parsed out of the string</param>
<param name="warn">a <see cref="T:System.Boolean" /></param> <param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
<remarks>To be added</remarks> <remarks>The allowed values are "heavy", "ultrabold", "bold", "normal", "light", "ultralight" and integers. Case variations are ignored.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ParseStretch"> <Member MemberName="ParseStretch">
@ -133,12 +133,14 @@
<Parameter Name="warn" Type="System.Boolean" /> <Parameter Name="warn" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Parses a string into a <see cref="T:Pango.Stretch&amp;" /> object.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /> to parse</param>
<param name="stretch">a <see cref="T:Pango.Stretch&amp;" /></param> <param name="stretch">a <see cref="T:Pango.Stretch&amp;" /> to set up with the stretch value parsed out of the string</param>
<param name="warn">a <see cref="T:System.Boolean" /></param> <param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
<remarks>To be added</remarks> <remarks>The allowed values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal",
"semi_expanded", "expanded", "extra_expanded" and "ultra_expanded". Case variations are ignored and the '_'
characters may be omitted.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ParseVariant"> <Member MemberName="ParseVariant">
@ -153,12 +155,12 @@
<Parameter Name="warn" Type="System.Boolean" /> <Parameter Name="warn" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Parses a string into a <see cref="T:Pango.Variant&amp;" /> object.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /> to parse</param>
<param name="variant">a <see cref="T:Pango.Variant&amp;" /></param> <param name="variant">a <see cref="T:Pango.Variant&amp;" />to set up with the variant value parsed out of the string</param>
<param name="warn">a <see cref="T:System.Boolean" /></param> <param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
<remarks>To be added</remarks> <remarks>The allowed values are "normal" and "smallcaps" or "small_caps", case variations being ignored.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ParseStyle"> <Member MemberName="ParseStyle">
@ -173,12 +175,12 @@
<Parameter Name="warn" Type="System.Boolean" /> <Parameter Name="warn" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Parses a string into a <see cref="T:Pango.Style&amp;" /> object.</summary>
<param name="str">a <see cref="T:System.String" /></param> <param name="str">a <see cref="T:System.String" /> to parse</param>
<param name="style">a <see cref="T:Pango.Style&amp;" /></param> <param name="style">a <see cref="T:Pango.Style&amp;" /> to set up with the style parsed out of the string.</param>
<param name="warn">a <see cref="T:System.Boolean" /></param> <param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
<remarks>To be added</remarks> <remarks>The allowed values are "normal", "italic" and "oblique", case variations being ignored.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FindParagraphBoundary"> <Member MemberName="FindParagraphBoundary">
@ -215,11 +217,10 @@ If no delimiters are found, both <paramref name="paragraph_delimiter_index" /> a
<Parameter Name="out_param" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="out_param" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Scans a string looking for an integer. An integer consists of up to 31 decimal digits.</summary>
<param name="pos">a <see cref="T:System.String" /></param> <param name="pos">a <see cref="T:System.String" />, a string to scan.</param>
<param name="out_param">a <see cref="T:System.Int32&amp;" /></param> <param name="out_param">a <see cref="T:System.Int32&amp;" />, an integer to put the result into.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, false if a parse error occurred.</returns>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

99
doc/en/Pango/GlyphString.xml
View file

@ -39,9 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Generates a new <see cref="T:Pango.GlyphString" /> object.</summary>
<returns>To be added: an object of type 'Pango.GlyphString'</returns> <returns>a <see cref="T:Pango.GlyphString" /> object.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -68,9 +68,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Copies one <see cref="T:Pango.GlyphString" /> into a new object.</summary>
<returns>To be added: an object of type 'Pango.GlyphString'</returns> <returns>a <see cref="T:Pango.GlyphString" /></returns>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Extents"> <Member MemberName="Extents">
@ -85,11 +84,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>Computes the logical and ink extents of this glyph string.</summary>
<param name="font">To be added: an object of type 'Pango.Font'</param> <param name="font">a <see cref="T:Pango.Font" /> for rendering the string </param>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="ink_rect">a <see cref="T:Pango.Rectangle" /> used to store the extents of the glyph as drawn or <see langword="null" /> to indicate that the result is not needed.</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="logical_rect">a <see cref="T:Pango.Rectangle" /> used to store the logical extents of the glyph or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>To be added</remarks> <remarks>The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The units of the rectangles are in 1 / <see cref="F:Pango.Scale.PangoScale" /> of a device unit.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Free"> <Member MemberName="Free">
@ -100,8 +99,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Frees this object's memory.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ExtentsRange"> <Member MemberName="ExtentsRange">
@ -118,13 +117,13 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" /> <Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Computes the logical and ink extents of a sub-section of this glyph string.</summary>
<param name="start">To be added: an object of type 'int'</param> <param name="start">an integer for the start index</param>
<param name="end">To be added: an object of type 'int'</param> <param name="end">an integer for the end index</param>
<param name="font">To be added: an object of type 'Pango.Font'</param> <param name="font">a <see cref="T:Pango.Font" /> for rendering the string </param>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="ink_rect">a <see cref="T:Pango.Rectangle" /> used to store the extents of the glyph as drawn or <see langword="null" /> to indicate that the result is not needed.</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param> <param name="logical_rect">a <see cref="T:Pango.Rectangle" /> used to store the logical extents of the glyph or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>To be added</remarks> <remarks>The extents are relative to the start of the glyph string range, not to the start of the glyph string.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Size"> <Member MemberName="Size">
@ -136,10 +135,9 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Resizes this GlyphString to the given length.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">An integer length to resize to.</param>
<returns>To be added: an object of type 'int'</returns> <returns>The new length of the string.</returns>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="glyphs"> <Member MemberName="glyphs">
@ -168,13 +166,18 @@
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Convert from x offset to character position.</summary>
<param name="text">a <see cref="T:System.String" /></param> <param name="text">a <see cref="T:System.String" />, the text for the run</param>
<param name="analysis">a <see cref="T:Pango.Analysis" /></param> <param name="analysis">a <see cref="T:Pango.Analysis" />, the analysis for the run</param>
<param name="x_pos">a <see cref="T:System.Int32" /></param> <param name="x_pos">the X offset in Pango glyph units.</param>
<param name="index_">a <see cref="T:System.Int32&amp;" /></param> <param name="index_">a <see cref="T:System.Int32&amp;" />, for storing the calculated byte index</param>
<param name="trailing">a <see cref="T:System.Int32&amp;" /></param> <param name="trailing">a <see cref="T:System.Int32&amp;" /> for storing whether the user clicked on the leading
<remarks>To be added</remarks> or trailing edge of the character.</param>
<remarks>
Character positions are computed by dividing up each cluster into equal portions.
In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor
position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -212,8 +215,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Represents how much space is left for other characters in the GlyphString.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IndexToX"> <Member MemberName="IndexToX">
@ -229,13 +232,17 @@
<Parameter Name="trailing" Type="System.Boolean" /> <Parameter Name="trailing" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Convert from character position to X position.</summary>
<param name="text">a <see cref="T:System.String" /></param> <param name="text">a <see cref="T:System.String" />, the text for the run</param>
<param name="analysis">a <see cref="T:Pango.Analysis" /></param> <param name="analysis">a <see cref="T:Pango.Analysis" />, the analysis for the run</param>
<param name="index_">a <see cref="T:System.Int32" /></param> <param name="index_">a <see cref="T:System.Int32" />, the byte index within the text.</param>
<param name="trailing">a <see cref="T:System.Boolean" /></param> <param name="trailing">a <see cref="T:System.Int32" /> whether to compute from trailing edge (true) or leading
<returns>a <see cref="T:System.Int32" /></returns> edge (false) of the character</param>
<remarks>To be added</remarks> <param name="x_pos">a <see cref="T:System.Int32" /> to hold the returned X offset</param>
<remarks>
Converts from character position to x position. (X position is measured from the left edge of the run).
Character positions are computed by dividing up each cluster into equal portions.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetLogicalWidths"> <Member MemberName="GetLogicalWidths">
@ -249,11 +256,13 @@
<Parameter Name="embedding_level" Type="System.Int32" /> <Parameter Name="embedding_level" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Determine the screen width corresponding to each character in a string. When
<param name="text">a <see cref="T:System.String" /></param> multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters.
<param name="embedding_level">a <see cref="T:System.Int32" /></param> </summary>
<returns>a <see cref="T:System.Int32" /></returns> <param name="text">a <see cref="T:System.String" /> to process</param>
<remarks>To be added</remarks> <param name="embedding_level">a <see cref="T:System.Int32" />, the embedding level of the string</param>
<returns>a <see cref="T:System.Int32" />, a pointer to an array of logical widths for each character.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

37
doc/en/Pango/IntSet.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>Represents a set of integers.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -68,8 +68,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroys the IntSet object.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddRange"> <Member MemberName="AddRange">
@ -83,10 +83,10 @@
<Parameter Name="end" Type="System.Int32" /> <Parameter Name="end" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a continuous range of integers to the set.</summary>
<param name="start">To be added: an object of type 'int'</param> <param name="start">An integer to begin the range</param>
<param name="end">To be added: an object of type 'int'</param> <param name="end">An integer to end the range</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Add"> <Member MemberName="Add">
@ -99,9 +99,9 @@
<Parameter Name="glyph" Type="System.Int32" /> <Parameter Name="glyph" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a single integer to the range</summary>
<param name="glyph">To be added: an object of type 'int'</param> <param name="glyph">An integer representing a glyph</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Contains"> <Member MemberName="Contains">
@ -114,10 +114,10 @@
<Parameter Name="member" Type="System.Int32" /> <Parameter Name="member" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Test whether an integer is part of the set.</summary>
<param name="member">To be added: an object of type 'int'</param> <param name="member">An integer to test</param>
<returns>To be added: an object of type 'bool'</returns> <returns>True if the given integer is part of the set, false otherwise.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Start"> <Member MemberName="Start">
@ -129,8 +129,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The start of the set</summary>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Size"> <Member MemberName="Size">
@ -142,8 +141,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The size of the set.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

776
doc/en/Pango/Layout.xml
View file

@ -2,9 +2,8 @@
<TypeSignature Language="C#" Value="public class Layout : GLib.Object, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Layout : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName> <AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey> <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>
</AssemblyPublicKey> <AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture> <AssemblyCulture>neutral</AssemblyCulture>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
@ -79,112 +78,6 @@ class LayoutSample : DrawingArea
</Interfaces> </Interfaces>
<Attributes /> <Attributes />
<Members> <Members>
<Member MemberName="SetMarkup">
<MemberSignature Language="C#" Value="public void SetMarkup (string markup);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>Sets the layout text and attribute list from marked-up text (see markup format).</summary>
<param name="markup">marked-up text</param>
<remarks>Replaces the current text and attribute list.
</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public void SetText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Set the text of the layout.</summary>
<param name="text">an object of type <see cref="T:System.String" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetLine">
<MemberSignature Language="C#" Value="public Pango.LayoutLine GetLine (int line);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutLine</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="line" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Retrieves a particular line.</summary>
<param name="line">the index of a line.</param>
<returns>the requested <see cref="T:Pango.LayoutLine" />, or null if the index is out of range.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Determines the logical width and height of a <see cref="T:Pango.Layout" /> in Pango units (device units divided by <see cref="F:Pango.Scale.PangoScale" />).</summary>
<param name="width"> location to store the logical width, or <see langword="null" /></param>
<param name="height"> location to store the logical height, or <see langword="null" /></param>
<remarks>This is simply a convenience function around <see cref="M:Pango.Layout.GetExtents()" />.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Layout Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copies an existing layout into a new one.</summary>
<returns>an object of type <see cref="T:Pango.Layout" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ContextChanged">
<MemberSignature Language="C#" Value="public void ContextChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Forces recomputation of any state in the <see cref="T:Pango.Layout" /> that might depend on the layout's context.</summary>
<remarks>This function should be called if you make changes to the context subsequent to creating the layout.</remarks>
</Docs>
</Member>
<Member MemberName="GetPixelSize">
<MemberSignature Language="C#" Value="public void GetPixelSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Determine the logical width and height of a <see cref="T:Pango.Layout" /> in device units.</summary>
<param name="width">an object of type <see cref="T:System.Int32" /></param>
<param name="height">an object of type <see cref="T:System.Int32" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" /> <MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -197,240 +90,6 @@ class LayoutSample : DrawingArea
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of Layout, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (Pango.Context context);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<summary>Create a new PangoLayout object with attributes initialized to default values for a particular <see cref="T:Pango.Context" />.</summary>
<param name="context">a <see cref="T:Pango.Context" />.</param>
<returns>a new <see cref="T:Pango.Layout" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LineCount">
<MemberSignature Language="C#" Value="public int LineCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the count of lines for the layout.</summary>
<returns> the line count</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Return the lines of the layout as a list.</summary>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public Pango.Alignment Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Alignment</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The amount by which the first line should be shorter than the rest of the lines.</summary>
<param name="value">the amount by which to indent.</param>
<returns>an object of type <see cref="T:Pango.Alignment" /></returns>
<remarks>The value be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the value.</remarks>
</Docs>
</Member>
<Member MemberName="Tabs">
<MemberSignature Language="C#" Value="public Pango.TabArray Tabs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.TabArray</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The alignment for the layout.</summary>
<param name="value">The new alignment.</param>
<returns>The current alignment.</returns>
<remarks>Specifies how partial lines are positioned within the horizontal space available.</remarks>
</Docs>
</Member>
<Member MemberName="SingleParagraphMode">
<MemberSignature Language="C#" Value="public bool SingleParagraphMode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The tabs to use for the layout.</summary>
<param name="value">the tabs to use for the layout.</param>
<returns>the current <see cref="T:Pango.TabArray" /> used by this layout. If no <see cref="T:Pango.TabArray" /> has been set, then the default tabs are in use and null is returned.</returns>
<remarks>
<para>By default, tabs are every 8 spaces.</para>
<para>Setting new tabs overrides the default tabs. If Tabs is set to null, the default tabs are reinstated.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Context">
<MemberSignature Language="C#" Value="public Pango.Context Context { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Context</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether or not to treat newlines and similar characters as paragraph separators.</summary>
<returns>an object of type <see cref="T:Pango.Context" /></returns>
<remarks>
<para>If set to true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters.</para>
<para>Used when you want to allow editing of newlines on a single text line.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Iter">
<MemberSignature Language="C#" Value="public Pango.LayoutIter Iter { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutIter</ReturnType>
</ReturnValue>
<Docs>
<summary>the <see cref="T:Pango.Context" /> used for this layout.</summary>
<returns>an object of type <see cref="T:Pango.LayoutIter" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Attributes">
<MemberSignature Language="C#" Value="public Pango.AttrList Attributes { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.AttrList</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>An iterator to iterate over the visual extents of the layout.</summary>
<param name="value">an object of type <see cref="T:Pango.AttrList" /></param>
<returns>a new <see cref="T:Pango.LayoutIter" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Spacing">
<MemberSignature Language="C#" Value="public int Spacing { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>the amount of spacing between the lines of the layout.</summary>
<param name="value"> the amount of spacing (in <see cref="T:Pango.GlyphUnit" />)</param>
<returns>the amount of spacing (in <see cref="T:Pango.GlyphUnit" />) </returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Justify">
<MemberSignature Language="C#" Value="public bool Justify { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The amount of spacing between the lines of the layout.</summary>
<param name="value">the amount of spacing.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets whether or not each complete line should be stretched to fill the entire width of the layout.</summary>
<param name="value">whether the lines in the layout should be justified.</param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Sets the width to which the lines of the Layout should be wrapped.</summary>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Wrap">
<MemberSignature Language="C#" Value="public Pango.WrapMode Wrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.WrapMode</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the wrap mode</summary>
<param name="value"> the new wrap mode</param>
<returns> Active wrap mode.</returns>
<remarks>The wrap mode only has an effect if a width is set on the layout using <see cref="P:Pango.Layout.Width" />. To turn off wrapping, set the width to -1.</remarks>
</Docs>
</Member>
<Member MemberName="FontDescription">
<MemberSignature Language="C#" Value="public Pango.FontDescription FontDescription { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the <see cref="T:Pango.WrapMode" />.</summary>
<param name="value">an object of type <see cref="T:Pango.FontDescription" /></param>
<returns>an object of type <see cref="T:Pango.FontDescription" /></returns>
<remarks>The wrap style only has an effect if a width is set on the layout. To turn off wrapping, set the width to -1.</remarks>
</Docs>
</Member>
<Member MemberName="MoveCursorVisually"> <Member MemberName="MoveCursorVisually">
<MemberSignature Language="C#" Value="public void MoveCursorVisually (bool strong, int old_index, int old_trailing, int direction, out int new_index, out int new_trailing);" /> <MemberSignature Language="C#" Value="public void MoveCursorVisually (bool strong, int old_index, int old_trailing, int direction, out int new_index, out int new_trailing);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -463,69 +122,35 @@ class LayoutSample : DrawingArea
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="XyToIndex"> <Member MemberName="SetText">
<MemberSignature Language="C#" Value="public bool XyToIndex (int x, int y, out int index_, out int trailing);" /> <MemberSignature Language="C#" Value="public void SetText (string text);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="x" Type="System.Int32" /> <Parameter Name="text" Type="System.String" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="index_" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Computes a new cursor position from an old position and a count of positions to move visually.</summary> <summary>Set the text of the layout.</summary>
<param name="strong">whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.</param> <param name="text">an object of type <see cref="T:System.String" /></param>
<param name="old_index">the byte index of the grapheme for the old index.</param> <remarks />
<param name="old_trailing">if 0, the cursor was at the trailing edge of the grapheme indicated by old_index, if &gt; 0, the cursor was at the leading edge.</param>
<param name="direction">direction to move cursor. A negative value indicates motion to the left.</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
<para>If count is positive, then the new strong cursor position will be one position to the right of the old cursor position. If count is position then the new strong cursor position will be one position to the left of the old cursor position.</para>
<para>In the presence of bidirection text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.</para>
<para>Motion here is in cursor positions, not in characters, so a single call to MoveCursorVisually() may move the cursor over multiple characters when multiple characters combine to form a single grapheme.</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GetPixelSize">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" /> <MemberSignature Language="C#" Value="public void GetPixelSize (out int width, out int height);" />
<MemberType>Property</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>GLib.GType</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.Layout" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Layout (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters> <Parameters>
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Convert from X and Y position within a layout to the byte index to the character at that logical position.</summary> <summary>Determine the logical width and height of a <see cref="T:Pango.Layout" /> in device units.</summary>
<param name="x">the X offset from the left edge of the layout.</param> <param name="width">an object of type <see cref="T:System.Int32" /></param>
<returns>true if the coordinates were inside text.</returns> <param name="height">an object of type <see cref="T:System.Int32" /></param>
<remarks>If the position is not inside the layout, the closest position is chosen (the x/y position will be clamped inside the layout). If a closest position is chosen, then the function returns false; on an exact hit, it returns true.</remarks>
</Docs>
</Member>
<Member MemberName="Lines">
<MemberSignature Language="C#" Value="public Pango.LayoutLine [] Lines { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutLine[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The count of lines for the layout.</summary>
<returns>The count of lines for the layout.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -566,6 +191,22 @@ The X coordinate of the resulting <see cref="T:Pango.Rectangle" /> represents th
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetMarkup">
<MemberSignature Language="C#" Value="public void SetMarkup (string markup);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>Sets the layout text and attribute list from marked-up text (see markup format).</summary>
<param name="markup">marked-up text</param>
<remarks>Replaces the current text and attribute list.
</remarks>
</Docs>
</Member>
<Member MemberName="GetLogAttrs"> <Member MemberName="GetLogAttrs">
<MemberSignature Language="C#" Value="public int GetLogAttrs (Pango.LogAttr attrs);" /> <MemberSignature Language="C#" Value="public int GetLogAttrs (Pango.LogAttr attrs);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -603,6 +244,36 @@ The X coordinate of the resulting <see cref="T:Pango.Rectangle" /> represents th
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Layout Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copies an existing layout into a new one.</summary>
<returns>an object of type <see cref="T:Pango.Layout" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Determines the logical width and height of a <see cref="T:Pango.Layout" /> in Pango units (device units divided by <see cref="F:Pango.Scale.PangoScale" />).</summary>
<param name="width"> location to store the logical width, or <see langword="null" /></param>
<param name="height"> location to store the logical height, or <see langword="null" /></param>
<remarks>This is simply a convenience function around <see cref="M:Pango.Layout.GetExtents()" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetCursorPos"> <Member MemberName="GetCursorPos">
<MemberSignature Language="C#" Value="public void GetCursorPos (int index_, out Pango.Rectangle strong_pos, out Pango.Rectangle weak_pos);" /> <MemberSignature Language="C#" Value="public void GetCursorPos (int index_, out Pango.Rectangle strong_pos, out Pango.Rectangle weak_pos);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -622,5 +293,324 @@ The X coordinate of the resulting <see cref="T:Pango.Rectangle" /> represents th
<remarks>The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.</remarks> <remarks>The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="XyToIndex">
<MemberSignature Language="C#" Value="public bool XyToIndex (int x, int y, out int index_, out int trailing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="index_" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Convert from X and Y position within a layout to the byte index to the character at that logical position.</summary>
<param name="x">a <see cref="T:System.Int32" />, the X offset (in thousandths of a device unit) from the left edge of the layout.</param>
<param name="y">a <see cref="T:System.Int32" />, the Y offset (in thousandths of a device unit) from the top edge of the layout.</param>
<param name="index_">a <see cref="T:System.Int32" /> for storing the calculated byte index</param>
<param name="trailing">a <see cref="T:System.Int32" /> to store where in the grapheme the user clicked. It will either
be zero or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme.</param>
<returns>a <see cref="T:System.Boolean" />, true if the coordinates are inside the Layout.</returns>
</Docs>
</Member>
<Member MemberName="ContextChanged">
<MemberSignature Language="C#" Value="public void ContextChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Forces recomputation of any state in the <see cref="T:Pango.Layout" /> that might depend on the layout's context.</summary>
<remarks>This function should be called if you make changes to the context subsequent to creating the layout.</remarks>
</Docs>
</Member>
<Member MemberName="GetLine">
<MemberSignature Language="C#" Value="public Pango.LayoutLine GetLine (int line);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutLine</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="line" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Retrieves a particular line.</summary>
<param name="line">the index of a line.</param>
<returns>the requested <see cref="T:Pango.LayoutLine" />, or null if the index is out of range.</returns>
<remarks>This layout line can be referenced and retained, but will become invalid
if changes are made to the Layout.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Layout (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of Layout, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Create a new PangoLayout object with attributes initialized to default values for a particular <see cref="T:Pango.Context" />.</summary>
<param name="context">a <see cref="T:Pango.Context" />.</param>
<returns>a new <see cref="T:Pango.Layout" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (Pango.Context context);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<summary>Create a new PangoLayout object with attributes initialized to default values for a particular <see cref="T:Pango.Context" />.</summary>
<param name="context">a <see cref="T:Pango.Context" />.</param>
<returns>a new <see cref="T:Pango.Layout" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.Layout" />.</remarks>
</Docs>
</Member>
<Member MemberName="FontDescription">
<MemberSignature Language="C#" Value="public Pango.FontDescription FontDescription { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>Set the default font description for the layout. If no font
description is set on the layout, the font description from
the layout's context is used.</summary>
<returns>a <see cref="T:Pango.FontDescription" /></returns>
</Docs>
</Member>
<Member MemberName="Wrap">
<MemberSignature Language="C#" Value="public Pango.WrapMode Wrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.WrapMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets or sets the wrap mode</summary>
<param name="value"> the new wrap mode</param>
<returns> Active wrap mode.</returns>
<remarks>The wrap mode only has an effect if a width is set on the layout using <see cref="P:Pango.Layout.Width" />. To turn off wrapping, set the width to -1.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets the text of the layout.</summary>
<returns>a <see cref="T:System.String" /> in UTF-8 encoding.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets the width to which the lines of the Layout should be wrapped.</summary>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public Pango.Alignment Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Alignment</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set or return the alignment for lines within the layout that do not take up the full width.</summary>
<param name="alignment">a <see cref="T:Pango.Alignment" /> object.</param>
<returns>an object of type <see cref="T:Pango.Alignment" /></returns>
<returns>an object of type <see cref="T:Pango.Alignment" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Justify">
<MemberSignature Language="C#" Value="public bool Justify { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets whether or not each complete line should be stretched to fill the entire width of the layout.</summary>
<param name="value">whether the lines in the layout should be justified.</param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.</remarks>
</Docs>
</Member>
<Member MemberName="Spacing">
<MemberSignature Language="C#" Value="public int Spacing { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>the amount of spacing between the lines of the layout.</summary>
<param name="value"> the amount of spacing (in <see cref="T:Pango.GlyphUnit" />)</param>
<returns>the amount of spacing (in <see cref="T:Pango.GlyphUnit" />) </returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Attributes">
<MemberSignature Language="C#" Value="public Pango.AttrList Attributes { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.AttrList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets/gets the text attributes for a Layout object.</summary>
<param name="value">an object of type <see cref="T:Pango.AttrList" /></param>
<returns>a <see cref="T:Pango.AttrList" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Iter">
<MemberSignature Language="C#" Value="public Pango.LayoutIter Iter { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutIter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>An iterator to iterate over the visual extents of the layout.</summary>
<param name="value">an object of type <see cref="T:Pango.AttrList" /></param>
<returns>a new <see cref="T:Pango.LayoutIter" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Context">
<MemberSignature Language="C#" Value="public Pango.Context Context { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Context</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>the <see cref="T:Pango.Context" /> used for this layout.</summary>
<returns>an object of type <see cref="T:Pango.LayoutIter" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SingleParagraphMode">
<MemberSignature Language="C#" Value="public bool SingleParagraphMode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether or not to treat newlines and similar characters as paragraph separators.</summary>
<returns>an object of type <see cref="T:Pango.Context" /></returns>
<remarks>
<para>If set to true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters.</para>
<para>Used when you want to allow editing of newlines on a single text line.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Tabs">
<MemberSignature Language="C#" Value="public Pango.TabArray Tabs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.TabArray</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The tabs to use for the layout.</summary>
<param name="value">the tabs to use for the layout.</param>
<returns>the current <see cref="T:Pango.TabArray" /> used by this layout. If no <see cref="T:Pango.TabArray" /> has been set, then the default tabs are in use and null is returned.</returns>
<remarks>
<para>By default, tabs are every 8 spaces.</para>
<para>Setting new tabs overrides the default tabs. If Tabs is set to null, the default tabs are reinstated.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set or return the amount by which the first line should be shorter than the rest of the lines.</summary>
<param name="value">an object of type <see cref="T:System.Int32" />, the new indent</param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>The value can be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the value.</remarks>
</Docs>
</Member>
<Member MemberName="LineCount">
<MemberSignature Language="C#" Value="public int LineCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Retrieves the count of lines for the layout.</summary>
<returns>An integer, the line count</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Lines">
<MemberSignature Language="C#" Value="public Pango.LayoutLine [] Lines { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutLine[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The count of lines for the layout.</summary>
<returns>The count of lines for the layout.</returns>
</Docs>
</Member>
</Members> </Members>
</Type> </Type>

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

@ -115,7 +115,7 @@
<summary>Gets the extents of the current run in layout coordinates (origin is the top left of the entire layout).</summary> <summary>Gets the extents of the current run in layout coordinates (origin is the top left of the entire layout).</summary>
<param name="ink_rect"> rectangle to fill with ink extents</param> <param name="ink_rect"> rectangle to fill with ink extents</param>
<param name="logical_rect"> rectangle to fill with logical extents</param> <param name="logical_rect"> rectangle to fill with logical extents</param>
<remarks>To be added</remarks> <remarks>The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The units of the rectangles are in 1 / <see cref="F:Pango.Scale.PangoScale" /> of a device unit.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NextChar"> <Member MemberName="NextChar">
@ -221,7 +221,7 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Gets the current run.</summary> <summary>Gets the current run.</summary>
<returns>To be added: an object of type 'Pango.LayoutRun'</returns> <returns>an object of type 'Pango.LayoutRun'</returns>
<remarks>When iterating by run, at the end of each line, there is a position with a <see cref="null" /> run, so this function can return <see langword="null" />. The <see langword="null" /> run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.</remarks> <remarks>When iterating by run, at the end of each line, there is a position with a <see cref="null" /> run, so this function can return <see langword="null" />. The <see langword="null" /> run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.</remarks>
</Docs> </Docs>
</Member> </Member>

5
doc/en/Pango/TabArray.xml
View file

@ -170,9 +170,8 @@
<summary>Gets the alignment and position of the tab stop specified by <paramref name="tab_index" />.</summary> <summary>Gets the alignment and position of the tab stop specified by <paramref name="tab_index" />.</summary>
<param name="tab_index">the tab stop index</param> <param name="tab_index">the tab stop index</param>
<param name="alignment">a <see cref="T:Pango.TabAlign&amp;" /></param> <param name="alignment">a <see cref="T:Pango.TabAlign&amp;" /></param>
<param name="location">a <see cref="T:System.Int32&amp;" /></param> <param name="location">a <see cref="T:System.Int32&amp;" />, the position in Pango units.</param>
<remarks>To be added</remarks>
</Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" /> <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />

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

@ -12,9 +12,9 @@
<Docs> <Docs>
<summary> <summary>
This enumeration is used to specify whether text should be This enumeration is used to specify whether text should be
underlined, and if so, the type of underlining underlined, and if so, the type of underlining.
</summary> </summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>

6
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>Caches HFONTs by their LOGFONT descriptions.</summary> <summary>Caches HFONTs by their LOGFONT descriptions; represents the Windows cache for fonts, in which logical fonts are pointed to by font handles. Logical fonts are scaled to the appropriate resolution for a given output device.</summary>
<remarks /> <remarks>Windows only.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -59,7 +59,7 @@
<Docs> <Docs>
<summary>Default constructor</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 /> <remarks>User code should use this constructor.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>