From df953a08f726ff6f39226ce0c736615852da6dd6 Mon Sep 17 00:00:00 2001 From: John Luke Date: Sat, 7 May 2005 21:38:08 +0000 Subject: [PATCH] doc some of the new pango bits svn path=/trunk/gtk-sharp/; revision=44209 --- doc/ChangeLog | 11 +++++ doc/en/Pango/AttrDataCopyFunc.xml | 2 +- doc/en/Pango/EllipsizeMode.xml | 12 ++--- doc/en/Pango/FcDecoder.xml | 12 ++--- doc/en/Pango/FcDecoderFindFunc.xml | 4 +- doc/en/Pango/FontsetForeachFunc.xml | 4 +- doc/en/Pango/Matrix.xml | 74 ++++++++++++++--------------- doc/en/Pango/RenderPart.xml | 12 ++--- doc/en/Pango/Renderer.xml | 4 +- 9 files changed, 73 insertions(+), 62 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 7e6a62004..a6710fbae 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,14 @@ +2005-05-07 John Luke + + * 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 * en/Gtk/AboutDialog.xml: doc diff --git a/doc/en/Pango/AttrDataCopyFunc.xml b/doc/en/Pango/AttrDataCopyFunc.xml index 235885b8b..68ae26b25 100644 --- a/doc/en/Pango/AttrDataCopyFunc.xml +++ b/doc/en/Pango/AttrDataCopyFunc.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + System.Delegate diff --git a/doc/en/Pango/EllipsizeMode.xml b/doc/en/Pango/EllipsizeMode.xml index d05cad878..e0a4bfdf4 100644 --- a/doc/en/Pango/EllipsizeMode.xml +++ b/doc/en/Pango/EllipsizeMode.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Describes what sort of (if any) ellipsization should be applied to a line of text. + 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. System.Enum @@ -37,7 +37,7 @@ - To be added + No ellipsization To be added @@ -50,7 +50,7 @@ - To be added + Omit characters at the start of the text To be added @@ -63,7 +63,7 @@ - To be added + Omit characters in the middle of the text To be added @@ -76,7 +76,7 @@ - To be added + Omit characters at the end of the text To be added diff --git a/doc/en/Pango/FcDecoder.xml b/doc/en/Pango/FcDecoder.xml index 992518ed1..c68101d89 100644 --- a/doc/en/Pango/FcDecoder.xml +++ b/doc/en/Pango/FcDecoder.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A virtual base class that implementations will inherit from. + 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 . 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. GLib.Object @@ -49,11 +49,11 @@ - To be added + This returns a single for a given unicode code point. a a a - To be added + 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.) @@ -90,9 +90,9 @@ - To be added + Default constructor a - To be added + diff --git a/doc/en/Pango/FcDecoderFindFunc.xml b/doc/en/Pango/FcDecoderFindFunc.xml index e631f0deb..06c8a88d3 100644 --- a/doc/en/Pango/FcDecoderFindFunc.xml +++ b/doc/en/Pango/FcDecoderFindFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + This will be called whenever new fonts are created. + If the function returns a , that decoder will be used to determine both coverage via a and a one-to-one mapping of characters to glyphs. This will allow applications to have application-specific encodings for various fonts. System.Delegate diff --git a/doc/en/Pango/FontsetForeachFunc.xml b/doc/en/Pango/FontsetForeachFunc.xml index 04038720b..c1e19a2f8 100644 --- a/doc/en/Pango/FontsetForeachFunc.xml +++ b/doc/en/Pango/FontsetForeachFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Used by when enumerating the fonts in a fontset. + System.Delegate diff --git a/doc/en/Pango/Matrix.xml b/doc/en/Pango/Matrix.xml index b5cca8e8e..ee8fb4f1d 100644 --- a/doc/en/Pango/Matrix.xml +++ b/doc/en/Pango/Matrix.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A structure specifying a transformation between user-space coordinates and device coordinates. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty Pango.Matrix. + @@ -40,8 +40,8 @@ - To be added - To be added + 1st component of the transformation matrix + @@ -53,8 +53,8 @@ - To be added - To be added + 2nd component of the transformation matrix + @@ -66,8 +66,8 @@ - To be added - To be added + 3rd component of the transformation matrix + @@ -79,8 +79,8 @@ - To be added - To be added + 4th component of the transformation matrix + @@ -92,7 +92,7 @@ - To be added + x translation To be added @@ -105,8 +105,8 @@ - To be added - To be added + y translation + @@ -119,10 +119,10 @@ - To be added + Creates a new Matrix. a a - To be added + @@ -136,10 +136,10 @@ - To be added - a - a - To be added + Changes the transformation represented by the matrix to be the transformation given by first translating by (tx, ty) then applying the original transformation. + amount to translate in the X direction + amount to translate in the Y direction + @@ -150,9 +150,9 @@ - To be added + Copies a Pango.Matrix a - To be added + @@ -163,8 +163,8 @@ - To be added - To be added + Free a created by , + @@ -177,9 +177,9 @@ - To be added + Changes the transformation represented by the matrix to be the transformation given by first applying transformation given by then applying the original transformation. a - To be added + @@ -193,10 +193,10 @@ - To be added - a - a - To be added + 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. + amount to scale by in X direction + amount to scale by in Y direction + @@ -209,9 +209,9 @@ - To be added - a - To be added + 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. + degrees to rotate counter-clockwise + @@ -222,9 +222,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . @@ -241,4 +241,4 @@ - + \ No newline at end of file diff --git a/doc/en/Pango/RenderPart.xml b/doc/en/Pango/RenderPart.xml index 1de32d026..e03f916a9 100644 --- a/doc/en/Pango/RenderPart.xml +++ b/doc/en/Pango/RenderPart.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The part of the renderer to modify. + System.Enum @@ -37,7 +37,7 @@ - To be added + The foreground text. To be added @@ -50,7 +50,7 @@ - To be added + The background text. To be added @@ -63,7 +63,7 @@ - To be added + The underline value. To be added @@ -76,7 +76,7 @@ - To be added + The strikethrough value. To be added diff --git a/doc/en/Pango/Renderer.xml b/doc/en/Pango/Renderer.xml index b27750a19..65f124405 100644 --- a/doc/en/Pango/Renderer.xml +++ b/doc/en/Pango/Renderer.xml @@ -295,9 +295,9 @@ - To be added + Default constructor a - To be added +