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

doc some of the new pango bits

Browse Source 
svn path=/trunk/gtk-sharp/; revision=44209
This commit is contained in:
John Luke 2005-05-07 21:38:08 +00:00
parent 6a62db1f0d
commit df953a08f7
9 changed files with 73 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/ChangeLog
View File

@ -1,3 +1,14 @@
2005-05-07 John Luke <john.luke@gmail.com>
* en/Pango/FontsetForeachFunc.xml:
* en/Pango/Matrix.xml:
* en/Pango/FcDecoder.xml:
* en/Pango/FcDecoderFindFunc.xml:
* en/Pango/Renderer.xml:
* en/Pango/AttrDataCopyFunc.xml:
* en/Pango/EllipsizeMode.xml:
* en/Pango/RenderPart.xml: doc some of these
2005-05-04 John Luke <john.luke@gmail.com>
* en/Gtk/AboutDialog.xml: doc

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

@ -10,7 +10,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>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

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

@ -9,8 +9,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>Describes what sort of (if any) ellipsization should be applied to a line of text.</summary>
<remarks>In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> No ellipsization</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Omit characters at the start of the text</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Omit characters in the middle of the text</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -76,7 +76,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Omit characters at the end of the text</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

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

@ -9,8 +9,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 virtual base class that implementations will inherit from.</summary>
<remarks>It is the interface that is used to define a custom encoding for a font. These objects are created in your code from a function callback that was originally registered with <see cref="M:Pango.FcFontMap.AddDecoderFindFunc()" />. Pango requires information about the supported charset for a font as well as the individual character to glyph conversions. Pango gets that information via the GetCharset and GetGlyph callbacks into your object implementation.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -49,11 +49,11 @@
<Parameter Name="wc" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> This returns a single <see cref="T:Pango.Glyph" /> for a given unicode code point.</summary>
<param name="fcfont">a <see cref="T:Pango.FcFont" /></param>
<param name="wc">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<remarks>For complex scripts where there can be multiple glyphs for a single character, the decoder will return whatever glyph is most convenient for it. (Usually whatever glyph is directly in the fonts character map table.)</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -90,9 +90,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Pango.FcDecoder" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

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

@ -9,8 +9,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>This will be called whenever new fonts are created.</summary>
<remarks>If the function returns a <see cref="T:Pango.FcDecoder" />, that decoder will be used to determine both coverage via a <see cref="T:Pango.FcCharSet" /> and a one-to-one mapping of characters to glyphs. This will allow applications to have application-specific encodings for various fonts.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

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

@ -9,8 +9,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 by <see cref="M:Pango.Fontset.Foreach()" /> when enumerating the fonts in a fontset.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

74
doc/en/Pango/Matrix.xml
View File

@ -9,8 +9,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 structure specifying a transformation between user-space coordinates and device coordinates.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty Pango.Matrix.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Xx">
@ -40,8 +40,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> 1st component of the transformation matrix</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Xy">
@ -53,8 +53,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> 2nd component of the transformation matrix </summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Yx">
@ -66,8 +66,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> 3rd component of the transformation matrix</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Yy">
@ -79,8 +79,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> 4th component of the transformation matrix</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X0">
@ -92,7 +92,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> x translation</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -105,8 +105,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> y translation</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -119,10 +119,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new Matrix.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.Matrix" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Translate">
@ -136,10 +136,10 @@
<Parameter Name="ty" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tx">a <see cref="T:System.Double" /></param>
<param name="ty">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks>
<summary>Changes the transformation represented by the matrix to be the transformation given by first translating by (tx, ty) then applying the original transformation.</summary>
<param name="tx"> amount to translate in the X direction</param>
<param name="ty"> amount to translate in the Y direction</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Copy">
@ -150,9 +150,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Copies a Pango.Matrix</summary>
<returns>a <see cref="T:Pango.Matrix" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Free">
@ -163,8 +163,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Free a <see cref="T:Pango.Matrix" /> created by <see cref="M:Pango.Matrix.Copy()" />,</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Concat">
@ -177,9 +177,9 @@
<Parameter Name="new_matrix" Type="Pango.Matrix" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Changes the transformation represented by the matrix to be the transformation given by first applying transformation given by <paramref name="new_matrix" /> then applying the original transformation.</summary>
<param name="new_matrix">a <see cref="T:Pango.Matrix" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Scale">
@ -193,10 +193,10 @@
<Parameter Name="scale_y" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="scale_x">a <see cref="T:System.Double" /></param>
<param name="scale_y">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks>
<summary>Changes the transformation represented by the matrix to be the transformation given by first scaling by sx in the X direction and sy in the Y direction then applying the original transformation.</summary>
<param name="scale_x"> amount to scale by in X direction</param>
<param name="scale_y"> amount to scale by in Y direction</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Rotate">
@ -209,9 +209,9 @@
<Parameter Name="degrees" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="degrees">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks>
<summary>Changes the transformation represented by the matrix to be the transformation given by first rotating by degrees degrees counter-clockwise then applying the original transformation.</summary>
<param name="degrees"> degrees to rotate counter-clockwise </param>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -222,9 +222,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>GType Property. </summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.Matrix" />.</remarks>
</Docs>
</Member>
<Member MemberName="Identity">
@ -241,4 +241,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -9,8 +9,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 part of the renderer to modify.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The foreground text.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The background text.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The underline value.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -76,7 +76,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The strikethrough value.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

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

@ -295,9 +295,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Pango.Renderer" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">