The-Homebrew-Cloud/Ryujinx-GtkSharp
2
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-09-08 07:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

more pango stuff

Browse Source 
svn path=/trunk/gtk-sharp/; revision=31241
This commit is contained in:
John Luke 2004-07-17 00:03:17 +00:00
parent 8e5f5ec6a4
commit b69c76c9f2
14 changed files with 234 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ChangeLog
View File

@ -1,3 +1,7 @@
2004-07-16 John Luke <jluke@cfl.rr.com>
* en/Pango/*: doc'ed some more pango stuff
2004-07-11 John Luke <jluke@cfl.rr.com>
* en/Vte*: some Vte docs

2
doc/en/Pango/AttrType.xml
View File

@ -10,7 +10,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>This enumeration is used to distinguish between different types of attributes.</summary>
<remarks>
<para>
This enumeration is used to distinguish between different

16
doc/en/Pango/GlyphGeometry.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Contains width and positioning information for a single glyph.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>the logical width to use for the the character.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="XOffset">
@ -69,8 +69,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>horizontal offset from nominal character position.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="YOffset">
@ -82,8 +82,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>vertical offset from nominal character position. </summary>
<remarks />
</Docs>
</Member>
</Members>

16
doc/en/Pango/GlyphInfo.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Represents a single glyph together with positioning information and visual attributes.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>the glyph itself.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Geometry">
@ -69,8 +69,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>the positional information about the glyph.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Attr">
@ -82,8 +82,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>the visual attributes of the glyph.</summary>
<remarks />
</Docs>
</Member>
</Members>

12
doc/en/Pango/GlyphString.xml
View File

@ -10,7 +10,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Used to store strings of glyphs with geometry and visual attribute information.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -149,9 +149,9 @@
<ReturnType>Pango.GlyphInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.GlyphInfo'</returns>
<remarks>To be added</remarks>
<summary>an array of <see cref="T:Pango.GlyphInfo" /></summary>
<returns>an object of type <see cref="T:Pango.GlyphInfo" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="XToIndex">
@ -199,8 +199,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>the number of glyphs in the string.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Space">

4
doc/en/Pango/GlyphVisAttr.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Used to communicate information between the shaping phase and the rendering phase.</summary>
<remarks>Its contents are still evolving.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>

92
doc/en/Pango/Layout.xml
View File

@ -89,9 +89,10 @@ class LayoutSample : DrawingArea
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<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">
@ -136,10 +137,10 @@ class LayoutSample : DrawingArea
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="width">To be added: an object of type 'int&amp;'</param>
<param name="height">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
<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">
@ -150,9 +151,9 @@ class LayoutSample : DrawingArea
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Layout'</returns>
<remarks>To be added</remarks>
<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">
@ -163,8 +164,8 @@ class LayoutSample : DrawingArea
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -233,9 +234,9 @@ class LayoutSample : DrawingArea
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Retrieves the count of lines for the layout.</summary>
<returns> the line count</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Indent">
@ -352,10 +353,10 @@ class LayoutSample : DrawingArea
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<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">
@ -409,10 +410,10 @@ class LayoutSample : DrawingArea
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.WrapMode'</param>
<returns>To be added: an object of type 'Pango.WrapMode'</returns>
<remarks>To be added</remarks>
<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">
@ -445,14 +446,21 @@ class LayoutSample : DrawingArea
<Parameter Name="new_trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="strong">a <see cref="T:System.Boolean" /></param>
<param name="old_index">a <see cref="T:System.Int32" /></param>
<param name="old_trailing">a <see cref="T:System.Int32" /></param>
<param name="direction">a <see cref="T:System.Int32" /></param>
<param name="new_index">a <see cref="T:System.Int32&amp;" /></param>
<param name="new_trailing">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<summary>Computes a new cursor position from an old position and a count of positions to move visually.</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="old_index"> the byte index of the grapheme for the old index </param>
<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>
<param name="new_index"> location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of G_MAXINT indicates that the cursor has been moved off the end of the layout.</param>
<param name="new_trailing"> number of characters to move forward from the location returned for <paramref name="new_index" /> to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. <paramref name="new_index" /> is always on the line where the cursor should be displayed.</param>
<remarks>
<para>If <paramref name="count" /> is positive, then the new strong cursor position will be one position to the right of the old cursor position. If <paramref name="count" /> is negative then the new strong cursor position will be one position to the left of the old cursor position.
</para>
<para>In the presence of bi-directional 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 may move the cursor over multiple characters when multiple characters combine to form a single grapheme.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="XyToIndex">
@ -532,10 +540,10 @@ class LayoutSample : DrawingArea
<Parameter Name="logical_rect" Type="Pango.Rectangle&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">a <see cref="T:Pango.Rectangle" /></param>
<param name="logical_rect">a <see cref="T:Pango.Rectangle" /></param>
<remarks>To be added</remarks>
<summary>Computes the logical and ink extents</summary>
<param name="ink_rect"> rectangle used to store the extents of the layout 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 layout or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>Logical extents are usually what you want for positioning things. The extents are given in layout coordinates; layout coordinates begin at the top left corner of the layout.</remarks>
</Docs>
</Member>
<Member MemberName="IndexToPos">
@ -568,10 +576,10 @@ The X coordinate of the resulting <see cref="T:Pango.Rectangle" /> represents th
<Parameter Name="attrs" Type="Pango.LogAttr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Retrieves an array of logical attributes for each character in the layout.</summary>
<param name="attrs">a <see cref="T:Pango.LogAttr" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetPixelExtents">
@ -607,11 +615,11 @@ The X coordinate of the resulting <see cref="T:Pango.Rectangle" /> represents th
<Parameter Name="weak_pos" Type="Pango.Rectangle&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<param name="strong_pos">a <see cref="T:Pango.Rectangle" /></param>
<param name="weak_pos">a <see cref="T:Pango.Rectangle" /></param>
<remarks>To be added</remarks>
<summary>Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index.</summary>
<param name="index_"> the byte index of the cursor</param>
<param name="strong_pos"> location to store the strong cursor position (may be <see langword="null" />)</param>
<param name="weak_pos"> location to store the weak cursor position (may be <see langword="null" />)</param>
<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>
</Member>
</Members>

102
doc/en/Pango/LayoutIter.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A <see cref="T:Pango.LayoutIter" /> can be used to iterate over the visual extents of a <see cref="T:Pango.Layout" />.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -34,10 +34,10 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
<summary>Gets the extents of the current cluster, 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="logical_rect">rectangle to fill with logical extents</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetLineExtents">
@ -51,10 +51,11 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
<summary>Obtains the extents of the current line.</summary>
<param name="ink_rect"> rectangle to fill with ink extents</param>
<param name="logical_rect"> rectangle to fill with logical extents</param>
<remarks>
<paramref name="ink_rect" /> or <parmref name="logical_rect" /> can be <see langword="null" /> if you are not interested in them. Extents are in layout coordinates (origin is the top-left corner of the entire <see cref="T:Pango.Layout" />). Thus the extents returned by this function will be the same width/height but not at the same x/y as the extents returned from <see cref="M:Pango.LayoutLineGetExtents()" />.</remarks>
</Docs>
</Member>
<Member MemberName="NextRun">
@ -65,9 +66,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Moves iter forward to the next run in visual order.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If iter was already at the end of the layout, returns <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetLayoutExtents">
@ -81,10 +82,11 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
<summary>Obtains the extents of the <see cref="T:Pango.Layout" /> being iterated over.</summary>
<param name="ink_rect"> rectangle to fill with ink extents</param>
<param name="logical_rect"> rectangle to fill with logical extents</param>
<remarks>
<paramref name="ink_rect" /> or <paramref name="logical_rect" /> can be <see langword="null" /> if you are not interested in them.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
@ -95,8 +97,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees an iterator that is no longer in use.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GetRunExtents">
@ -110,9 +112,9 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<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="logical_rect"> rectangle to fill with logical extents</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -124,9 +126,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Moves iter forward to the next character in visual order.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If iter was already at the end of the layout, returns <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="NextLine">
@ -137,9 +139,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Moves iter forward to the start of the next line.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If iter is already on the last line, returns <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetCharExtents">
@ -152,9 +154,9 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
<summary>Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout).</summary>
<param name="logical_rect"> rectangle to fill with logical extents</param>
<remarks>Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters.</remarks>
</Docs>
</Member>
<Member MemberName="NextCluster">
@ -165,9 +167,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Moves iter forward to the next cluster in visual order.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If iter was already at the end of the layout, returns <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="AtLastLine">
@ -178,9 +180,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Determines whether iter is on the last line of the layout.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -206,9 +208,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the current byte index.</summary>
<returns> current byte index</returns>
<remarks>Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the <see langword="null" /> run (see <see cref="P:Pango.LayoutIter.Run" />).</remarks>
</Docs>
</Member>
<Member MemberName="Run">
@ -218,9 +220,9 @@
<ReturnType>Pango.LayoutRun</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Gets the current run.</summary>
<returns>To be added: an object of type 'Pango.LayoutRun'</returns>
<remarks>To be added</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>
</Member>
<Member MemberName="Baseline">
@ -230,9 +232,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout).</summary>
<returns> baseline of current line</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Line">
@ -242,9 +244,9 @@
<ReturnType>Pango.LayoutLine</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.LayoutLine'</returns>
<remarks>To be added</remarks>
<summary>Gets the current line.</summary>
<returns>the current <see cref="T:Pango.LayoutLine" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetLineYrange">
@ -258,10 +260,10 @@
<Parameter Name="y1_" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Divides the vertical space in the <see cref="T:Pango.Layout" /> being iterated over between the lines in the layout, and returns the space belonging to the current line.</summary>
<param name="y0_">a <see cref="T:System.Int32&amp;" /></param>
<param name="y1_">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<remarks>A line's range includes the line's logical extents, plus half of the spacing above and below the line if <see cref="P:Pango.Layout.Spacing" /> has been set. The y positions are in layout coordinates (origin at top left of the entire layout).</remarks>
</Docs>
</Member>
</Members>

77
doc/en/Pango/LayoutLine.xml
View File

@ -12,7 +12,7 @@
<Docs>
<summary>Represents one of the lines resulting from laying out a paragraph via <see cref="T:Pango.Layout" />.</summary>
<remarks>
<see cref="T:Pango.LayoutLine" />s are obtained by calling Pango.Layout.GetLine() and are only valid until the text, attributes, or settings of the parent <see cref="T:Pango.Layout" /> are modified.</remarks>
<see cref="T:Pango.LayoutLine" />s are obtained by calling <see cref="M:Pango.Layout.GetLine(System.Int32)" /> and are only valid until the text, attributes, or settings of the parent <see cref="T:Pango.Layout" /> are modified.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,8 +28,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Increases the reference count of a <see cref="T:Pango.LayoutLine" /> by one.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Unref">
@ -40,8 +40,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Decreases the reference count of a <see cref="T:Pango.LayoutLine" /> by one.</summary>
<remarks>If the result is zero, the line and all associated memory will be freed.</remarks>
</Docs>
</Member>
<Member MemberName="GetXRanges">
@ -57,12 +57,12 @@
<Parameter Name="n_ranges" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_index">a <see cref="T:System.Int32" /></param>
<param name="end_index">a <see cref="T:System.Int32" /></param>
<param name="ranges">a <see cref="T:System.Int32&amp;" /></param>
<param name="n_ranges">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<summary>Gets a list of visual ranges corresponding to a given logical range.</summary>
<param name="start_index"> Start byte index of the logical range. If this value is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise it will start at the leading edge of the first character.</param>
<param name="end_index"> Ending byte index of the logical range. If this value is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character.</param>
<param name="ranges"> location to store a pointer to an array of ranges. The array will be of length 2*n_ranges, with each range starting at (*ranges)[2*n] and of width (*ranges)[2*n + 1] - (*ranges)[2*n]. This array must be freed with g_free(). The coordinates are relative to the layout and are in <see cref="T:Pango.GlyphUnit" />.</param>
<param name="n_ranges"> The number of ranges stored in <paramref name="ranges" />.</param>
<remarks>This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line.</remarks>
</Docs>
</Member>
<Member MemberName="XToIndex">
@ -77,12 +77,13 @@
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x_pos">a <see cref="T:System.Int32" /></param>
<param name="index_">a <see cref="T:System.Int32&amp;" /></param>
<param name="trailing">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Converts from x offset to the byte index of the corresponding character within the text of the layout.</summary>
<param name="x_pos"> the x offset (in <see cref="T:Pango.GlyphUnit" />) from the left edge of the line.</param>
<param name="index_"> location to store calculated byte offset for the grapheme in which the user clicked.</param>
<param name="trailing"> location to store a integer indicating 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 cluster.</param>
<returns>
<see langword="false" /> if x_pos was outside the line, <see langword="true" /> if inside</returns>
<remarks>If <paramref name="x_pos" /> is outside the line, the start or end of the line will be stored at <paramref name="index_" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetExtents">
@ -96,10 +97,10 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">a <see cref="T:Pango.Rectangle&amp;" /></param>
<param name="logical_rect">a <see cref="T:Pango.Rectangle&amp;" /></param>
<remarks>To be added</remarks>
<summary>Computes the logical and ink extents of a layout line.</summary>
<param name="ink_rect"> rectangle used to store the extents of the glyph string 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 string or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>See the documentation for <see cref="M:Pango.Font.GetGlyphExtents()" /> for details about the interpretation of the rectangles.</remarks>
</Docs>
</Member>
<Member MemberName="GetPixelExtents">
@ -113,10 +114,10 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">a <see cref="T:Pango.Rectangle&amp;" /></param>
<param name="logical_rect">a <see cref="T:Pango.Rectangle&amp;" /></param>
<remarks>To be added</remarks>
<summary>Computes the logical and ink extents of a layout line.</summary>
<param name="ink_rect"> rectangle used to store the extents of the glyph string 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 string or <see langword="null" /> to indicate that the result is not needed.</param>
<remarks>See the documentation for <see cref="T:Pango.Font.GetGlyphExtents()" /> for details about the interpretation of the rectangles. The returned rectangles are in device units, as opposed to <see cref="T:Pango.LayoutLine.GetExtents()" />, which returns the extents in <see cref="T:Pango.GlyphUnit" />.</remarks>
</Docs>
</Member>
<Member MemberName="IndexToX">
@ -130,11 +131,11 @@
<Parameter Name="trailing" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<param name="trailing">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Converts an index within a line to a X position.</summary>
<param name="index_"> byte offset of a grapheme within the layout</param>
<param name="trailing"> Indicates the edge of the grapheme to retrieve the position of. If <see langword="true" />, the trailing edge of the grapheme, if <see langword="false" />, the leading of the grapheme.</param>
<returns>the x_offset (in <see cref="T:Pango.GlyphUnit" />)</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Layout">
@ -145,9 +146,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The parent <see cref="T:Pango.Layout" /> for this line.</summary>
<returns>a <see cref="T:Pango.Layout" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="StartIndex">
@ -158,9 +159,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the start of the line as byte index into <see cref="P:Pango.Layout.Text" />.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Length">
@ -171,9 +172,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the length of the line in bytes.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -184,10 +185,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Internal constructor.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.LayoutLine" /></returns>
<remarks>To be added</remarks>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
</Members>

6
doc/en/Pango/LayoutRun.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The <see cref="T:Pango.LayoutRun" /> structure represents a single run within a <see cref="T:Pango.LayoutLine" />.</summary>
<remarks>It is simply an alternate name for <see cref="T:Pango.GlyphItem" />, present for backwards compatibility. See the <see cref="T:Pango.GlyphItem" /> docs for Ietails on the fields.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -55,7 +55,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.GlyphString'</returns>
<returns>an object of type <see cref="T:Pango.GlyphString" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>

26
doc/en/Pango/Rectangle.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Represents a rectangle</summary>
<remarks>It is frequently used to represent the logical or ink extents of a single glyph or section of text.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Pango.Rectangle'</returns>
<remarks>To be added</remarks>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Pango.Rectangle" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="X">
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>X coordinate of the left side of the rectangle.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y">
@ -69,8 +69,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Y coordinate of the the top side of the rectangle.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
@ -82,8 +82,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>width of the rectangle.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Height">
@ -95,8 +95,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>height of the rectangle.</summary>
<remarks />
</Docs>
</Member>
</Members>

42
doc/en/Pango/Scale.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Scale factors.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Represents the scale between dimensions used for Pango distances and device units.</summary>
<remarks>The definition of device units is dependent on the output device; it will typically be pixels for a screen, and points for a printer. This is currently 1024, but this may be changed in the future. When setting font sizes, device units are always considered to be points (as in "12 point font"), rather than pixels.</remarks>
</Docs>
</Member>
<Member MemberName="XX_Small">
@ -39,8 +39,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X_Small">
@ -51,8 +51,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for two shrinking steps (1 / (1.2 * 1.2)).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Small">
@ -63,8 +63,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for one shrinking step (1 / 1.2).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Medium">
@ -75,8 +75,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for normal size (1.0).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Large">
@ -87,8 +87,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for one magnification step (1.2).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X_Large">
@ -99,8 +99,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for two magnification steps (1.2 * 1.2).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="XX_Large">
@ -111,8 +111,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The scale factor for three magnification steps (1.2 * 1.2 * 1.2).</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -121,9 +121,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Scale'</returns>
<remarks>To be added</remarks>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Pango.Scale" /></returns>
<remarks />
</Docs>
</Member>
</Members>

2
doc/en/Pango/Style.xml
View File

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>
An enumeration specific the various saltn styles possible for a
An enumeration specific the various slant styles possible for a
font
</summary>
<remarks />

52
doc/en/Pango/TabArray.xml
View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>an object containing an array of tab stops.</summary>
<remarks>Each tab stop has an alignment and a position.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,9 +31,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.TabArray'</returns>
<remarks>To be added</remarks>
<summary>Copies the existing <see cref="T:Pango.TabArray" /> to a new one.</summary>
<returns>an object of type <see cref="T:Pango.TabArray" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Resize">
@ -46,9 +46,9 @@
<Parameter Name="new_size" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_size">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Sets the size of the tab array to the value specified by <paramref name="new_size" />.</summary>
<param name="new_size">the new size of the array</param>
<remarks>You must subsequently initialize any tabs that were added to the array.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
@ -75,11 +75,11 @@
<Parameter Name="location" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tab_index">To be added: an object of type 'int'</param>
<param name="alignment">To be added: an object of type 'Pango.TabAlign'</param>
<param name="location">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Sets the specified <paramref name="alignment" /> and <paramref name="location" /> of the tab stop specified by <paramref name="tab_index" />.</summary>
<param name="tab_index">the index of a tab stop</param>
<param name="alignment">the tab alignment</param>
<param name="location">the tab location in pango units</param>
<remarks>The value of <paramref name="alignment" /> must always be <see cref="T:Pango.TabAlign.Left" /> in the current implementation.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -107,11 +107,11 @@
<Parameter Name="positions_in_pixels" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="initial_size">To be added: an object of type 'int'</param>
<param name="positions_in_pixels">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'Pango.TabArray'</returns>
<remarks>To be added</remarks>
<summary>an object containing an array of tab stops</summary>
<param name="initial_size">Initial number of tab stops to allocate, can be 0</param>
<param name="positions_in_pixels">if <see langword="true" /> the tab positions are in pixel units</param>
<returns>an object of type <see cref="T:Pango.TabArray" /></returns>
<remarks>Creates a new <see cref="T:Pango.TabArray" /> with the number of tab stops specified by <paramref name="initial_size" />. If <paramref name="positions_in_pixels" /> is <see langword="true" />, the tab stop positions are specified in pixel units otherwise in pango units. All tab stops are initially at position 0.</remarks>
</Docs>
</Member>
<Member MemberName="PositionsInPixels">
@ -121,9 +121,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>returns <see langword="true" /> if the tab positions are specified in pixels and <see langword="false" /> if they are in pango units.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Size">
@ -133,9 +133,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>returns the number of tab stops in the tab array.</summary>
<returns>the number of tab stops in the array.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetTabs">
@ -167,8 +167,8 @@
<Parameter Name="location" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tab_index">a <see cref="T:System.Int32" /></param>
<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="alignment">a <see cref="T:Pango.TabAlign&amp;" /></param>
<param name="location">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>